Discussion repeats initial comment #423

Closed
drichardson opened this Issue Jan 21, 2014 · 2 comments

Comments

Projects
None yet
2 participants

I've noticed that in generated documents, the initial comment for an instance method is identical to the "Discussion" section for that instance method. You can see examples of this in AFNetworking's documentation, which apparently was built with appledoc 2.1.

http://cocoadocs.org/docsets/AFNetworking/2.0.0/Classes/AFHTTPRequestOperation.html

I'm using appledoc 2.2 and see the same thing. I took a look at the templates, and apparently #hasShortDescription and #hasLongDescription are both true and #shortDescription is equal to #longDescription, which makes it impossible to switch on these without having repeats.

The Description in Apple documentation does not repeat the initial method comment. See NSArray as an example:
https://developer.apple.com/library/mac/documentation/Cocoa/Reference/Foundation/Classes/NSArray_Class/NSArray.html

Owner

tomaz commented Jan 21, 2014

Did you try with --no-repeat-first-par?

Thank you sir! That was exactly it. Seems like this should be the default.

tomaz closed this May 16, 2014

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