Show method declaration even without doc comment #210

Merged
merged 1 commit into from Apr 13, 2012

Conversation

Projects
None yet
2 participants
Contributor

SevInf commented Apr 12, 2012

Hi.
We are using appledoc in CocoaPods package manager. Next version will automatically generate appledoc documentation for every library installed with it.
We've found a small issue. If there is no doc comments, then doc will not contain any type info for properties and methods (discussion, screenshot).
This commit fixes this issue by displaying method declaration even without the comments (screenshot).

Owner

tomaz commented Apr 13, 2012

Great, thanks, merging right now!

tomaz merged commit 450eb47 into tomaz:master Apr 13, 2012

Contributor

SevInf commented Apr 13, 2012

@tomaz, one more idea. What if we make arguments and return types in method declaration link to appropriate documentation pages (in above screenshot OtherExample in @property OtherExample* example line will become a link to a OtherExample class reference)? Apple docs at http://developer.apple.com don't do it, but in my opinion it will make navigation easier.

Owner

tomaz commented Apr 13, 2012

If you're willing to step in, that would be great - I've added a feature for future info for myself a long time ago - see #17.

I'm currently working on major refactoring of the whole project, so my focus is there (available on experimental branch). Will consider all feature requests once I get to it (although not all will make the cut :)

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