Horde3D

Next-Generation Graphics Engine
It is currently 25.11.2024, 23:38

All times are UTC + 1 hour




Post new topic Reply to topic  [ 7 posts ] 
Author Message
PostPosted: 27.08.2008, 14:25 
Offline

Joined: 15.06.2008, 11:21
Posts: 166
Location: Germany
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);
};


Top
 Profile  
Reply with quote  
PostPosted: 27.08.2008, 15:25 
Offline

Joined: 22.11.2007, 17:05
Posts: 707
Location: Boston, MA
That isn't actually a working Doxygen style - the brief description has to be on the first line (the line with the double *).

_________________
Tristam MacDonald - [swiftcoding]


Top
 Profile  
Reply with quote  
PostPosted: 27.08.2008, 15:39 
Offline

Joined: 15.06.2008, 11:21
Posts: 166
Location: Germany
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.


Top
 Profile  
Reply with quote  
PostPosted: 27.08.2008, 17:36 
Offline

Joined: 26.03.2008, 02:58
Posts: 160
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.


Top
 Profile  
Reply with quote  
PostPosted: 27.08.2008, 19:00 
Offline
Engine Developer

Joined: 10.09.2006, 15:52
Posts: 1217
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.


Top
 Profile  
Reply with quote  
PostPosted: 01.09.2008, 13:03 
Offline

Joined: 03.07.2008, 01:23
Posts: 50
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.


Top
 Profile  
Reply with quote  
PostPosted: 02.09.2008, 01:04 
Offline

Joined: 08.11.2006, 03:10
Posts: 384
Location: Australia
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.


Top
 Profile  
Reply with quote  
Display posts from previous:  Sort by  
Post new topic Reply to topic  [ 7 posts ] 

All times are UTC + 1 hour


Who is online

Users browsing this forum: No registered users and 5 guests


You cannot post new topics in this forum
You cannot reply to topics in this forum
You cannot edit your posts in this forum
You cannot delete your posts in this forum
You cannot post attachments in this forum

Search for:
Jump to:  
Powered by phpBB® Forum Software © phpBB Group