| Horde3D http://horde3d.org/forums/ |
|
| Internal class documentation http://horde3d.org/forums/viewtopic.php?f=3&t=480 |
Page 1 of 1 |
| Author: | phoenix64 [ 27.08.2008, 14:25 ] |
| Post subject: | Internal class documentation |
I am currently trying to write a horde3d extension and really miss documentation for all the internal classes, I think it would be better if they were documented in the .h, maybe with doxygen documentation so that one can make a HTML document out of it. I'd be able to write at least a part of these, the question is, would it be possible for them to get integrated into SVN, and what style should one use? My suggestion: Code: /**
* Brief class description * * Longer class description */ class Whatever { /** * Brief class description * \param a some value * \param b some value */ void doSomething(int a, int b); }; |
|
| Author: | swiftcoder [ 27.08.2008, 15:25 ] |
| Post subject: | Re: Internal class documentation |
That isn't actually a working Doxygen style - the brief description has to be on the first line (the line with the double *). |
|
| Author: | phoenix64 [ 27.08.2008, 15:39 ] |
| Post subject: | Re: Internal class documentation |
hm, ok, I thought that would work with QT_AUTOBRIEF. I usually use a slightly different format for my own docs, but thought this would be better. Edit: As in the manual, this definately works with JAVADOC_AUTOBRIEF. |
|
| Author: | DDd [ 27.08.2008, 17:36 ] |
| Post subject: | Re: Internal class documentation |
I use VA AssistX to generate method documentation, since it is fully configurable, i have no preference regarding documentation style as long as it is consistent and easy to extract. |
|
| Author: | marciano [ 27.08.2008, 19:00 ] |
| Post subject: | Re: Internal class documentation |
I'm not a fan of internal class documentation since it clutters up the code so much (especially Doxygen). Personally I prefer having well chosen expressive function and member names and many comments in the code to quickly help understanding what is going on. |
|
| Author: | cantele [ 01.09.2008, 13:03 ] |
| Post subject: | Re: Internal class documentation |
It is possible to write doxygen docs in a separate file, and tell it which file that documentation belongs to. This would still enable generating docs, and separate them from the code. |
|
| Author: | DarkAngel [ 02.09.2008, 01:04 ] |
| Post subject: | Re: Internal class documentation |
cantele wrote: It is possible to write doxygen docs in a separate file, and tell it which file that documentation belongs to. This would still enable generating docs, and separate them from the code. Yes I think you can do this using the @class and @fn commands, I haven't tried it though.
|
|
| Page 1 of 1 | All times are UTC + 1 hour |
| Powered by phpBB® Forum Software © phpBB Group https://www.phpbb.com/ |
|