libextobjc
libextobjc copied to clipboard
jspahrsummers
Documentation Feedback
It looks like the code is extremely well documented (in headerdoc/doxygen format no less) in the headers themselves. Would love to see docs available as HTML without having to dig into each header.
Ideally I'd love to see the README you have now sprinkled with examples. I think that would let me know at a glance what you're trying to achieve and what my use case would be for each technique/trick you're providing.
Good idea. This is primarily a hobby project for me, so it sometimes doesn't get as much love as other OSS that I work on.
If you have a build server handy, you can push the API docs up to gh-pages after each commit. And then just link to them from the main readme . . . . Or I can put it on my build server if you like?
Here's an example of the script ( --publish.site )
https://github.com/jasperblues/Typhoon/blob/master/build.xml
@jasperblues I've found that most documentation generators don't handle macro-heavy code very well. Besides that, I think looking at the header files of libextobjc will often be more illustrative than just the documentation.
@dnalot libextobjc actually uses Doxygen/Appledoc format. I've been meaning to update it, but it's just not a high priority.
Yeah, I'd definitely agree with that. I almost always link people to tests rather than the headers when I'm trying to show off a libextobjc feature.