Discussion repeats description #29

Closed
quentinfasquel opened this Issue Jan 3, 2011 · 4 comments

Projects

None yet

2 participants

@quentinfasquel

The title sounds enough.

@tomaz
Owner
tomaz commented Jan 3, 2011

First paragraph is automatically used for brief description and is then repeated in full method description. I was thinking about having it optionally disabled by command line switch, but was then dealing with higher priority stuff, so this went down the list. It should be simple to implement it.

@tomaz
Owner
tomaz commented Jan 3, 2011

Implemented optional disabling of first paragraph repeat for members. Closed by efce669.

By default appledoc repeats first paragraph in members documentation. This can be optionally disabled with command line switch now.

@quentinfasquel

Thanks for your quick answer ! I did try that fix, but it seems that the second paragraph (i mean the discussion part) never appear anymore.

@tomaz
Owner
tomaz commented Jan 4, 2011

This feature required update to object-template.html, so make sure you overwrite your template files and you should be fine.

In fact, this is exactly what I experienced during development. It took me a while to finally figure out I had Xcode setup with --templates pointing to some path with old templates. When changed everything was fine. I've also confirmed it right now and documentation gets created correctly either repeating first paragraph or not.

I should have mentioned this in commit message though, sorry for confusion and thanks for bringing it up...

@tonklon tonklon pushed a commit to tonklon/appledoc that referenced this issue Mar 8, 2012
@tomaz Implemented optional disabling of first paragraph repeat for members.…
… Closes #29.

By default appledoc repeats first paragraph in members documentation. This can be optionally disabled with command line switch now.
efce669
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment