Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Parameter not included when using swift style commenting with obj-c #909

Open
awgeorge opened this issue Nov 15, 2017 · 1 comment
Open

Comments

@awgeorge
Copy link

While compiling obj-c using swift doc headers, while other keywords work, eg: - returns:, - see: etc. Parameters will only appear using the @param syntax.

Does not appear

- parameter str:   The string to repeat.

Appears as a bullet point, including param

- param str:   The string to repeat.

Appears as a parameter

@param  The string to repeat.

Does not appear

- parameter str:   The string to repeat.
- see: nothing

Appears as standard text above the see callout

- param str:   The string to repeat.
- see: nothing

Appears as a bullet point

- param str:   The string to repeat.
- returns: nothing

So the parameter keyword is being parsed, but not being outputted in the documentation,

@johnfairh
Copy link
Collaborator

Right, currently you have to use the @param syntax in Obj-C mode. Not done much testing on non-HeaderDoc -- latest Xcode 'generate-doc-comment' still generates HeaderDoc syntax.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants