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

Doc fixes #5502

Open
wants to merge 8 commits into
base: release-2.1
from

Conversation

Projects
None yet
4 participants
@Oldiesmann
Copy link
Contributor

Oldiesmann commented Mar 11, 2019

Various fixes to the docblock comments to make apiGen work properly. See http://www.oldiesmann.us/smfdocs/ for an example of the output and individual commits for more info.

This is still a WIP and more commits might be coming as I have more time to play with ApiGen

Oldiesmann added some commits Mar 9, 2019

No punctuation allowed after type...
Signed-off-by: Michael Eshom <oldiesmann@oldiesmann.us>
@uses expects a class name
Signed-off-by: Michael Eshom <oldiesmann@oldiesmann.us>
Strip more unnecessary punctuation
Signed-off-by: Michael Eshom <oldiesmann@oldiesmann.us>
And more unnecessary punctuation
Signed-off-by: Michael Eshom <oldiesmann@oldiesmann.us>
No commas here either...
Signed-off-by: Michael Eshom <oldiesmann@oldiesmann.us>
apiGen doesn't like "string[optional]"
Signed-off-by: Michael Eshom <oldiesmann@oldiesmann.us>
"int[optional]" won't work either
Signed-off-by: Michael Eshom <oldiesmann@oldiesmann.us>
@see should refer to a function rather than a file
Signed-off-by: Michael Eshom <oldiesmann@oldiesmann.us>
@jdarwood007

This comment has been minimized.

Copy link
Member

jdarwood007 commented Mar 12, 2019

@Oldiesmann

This comment has been minimized.

Copy link
Contributor Author

Oldiesmann commented Mar 12, 2019

@jdarwood007 It is valid - just not the way we're using it.

@Sesquipedalian Sesquipedalian added this to the Final milestone Mar 13, 2019

@jdarwood007

This comment has been minimized.

Copy link
Member

jdarwood007 commented Mar 13, 2019

Can we fix it properly by referencing things the right way then?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.