16 Oct
2008
16 Oct
'08
1:05 a.m.
J.B.C.Engelen wrote:
Note 4: Doxygen accepts two command styles: \pre and @pre. They can be mingled without a problem I think, but shall we try to use the slash? \file, \brief, etc.
I like @ more, because it's visually more distinct - it's just easier to spot doxycomments when they use @ rather than . However, which one we use is really irrelevant - writing more documentation is more important than debating about details.
There is one more to think about - where do we put the documentation? Do we put it in the header files like every library I have seen to date, or in the .cpp files where the functions are defined?
--
View this message in context: http://www.nabble.com/documentation-effort-tp19770564p20005298.html
Sent from the Inkscape - Dev mailing list archive at Nabble.com.