Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Build documentation using appledoc #199

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

Closed
wants to merge 2 commits into from
Closed

Conversation

tiennou
Copy link
Contributor

@tiennou tiennou commented Jul 3, 2013

This fixes #28 by adding a script file that generates an Xcode docset for all files under Classes.

I decided arbitrary values for the appledoc configuration (eg. --docset-feed-url/package-url).

This also updates GTReference.h to use the appledoc comment syntax.

Note: appledoc still doesn't support some obvious things, like enum, blocks and typedefs.

@jspahrsummers
Copy link
Contributor

As briefly mentioned in #198, we actually use TomDoc for our documentation, because we find it much more readable than Appledoc and similar formats.

There's some more discussion about our rationale, and how documentation could be generated, over at ReactiveCocoa/ReactiveCocoa#231.

@tiennou
Copy link
Contributor Author

tiennou commented Jul 3, 2013

Ok good to know, I'll close that then. Sorry for the noise.

But, how is documentation generated then ;-) ?

@jspahrsummers
Copy link
Contributor

There's currently no way to do so. I think @dannygreg's reply in that other thread addresses it well:

Everything you need is in the header files, there is not (and won't be) anything special about any generated documentation.

That is exactly why we prefer TomDoc, it puts emphasis on making the documentation readable for humans, rather than machines.

@tiennou
Copy link
Contributor Author

tiennou commented Jul 3, 2013

Oh, ok. Too bad, Cmd-clicking in Xcode and getting direct DocSet access felt pretty nice to me ;-). I'll go learn the syntax.

@tiennou tiennou closed this Jul 3, 2013
@tiennou tiennou deleted the appledoc branch March 28, 2014 16:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add documentation to project (Code).
2 participants