On 07.09.2008, at 20:01, Roman Kantor wrote:

> Not sure why we need to distinguish
> between inline and non-inline functions for placement of doxygen  
> comments...


Doxygen comments always refer to the following function or class.  
Since inline functions only appear in the header file, you either have  
to doxygenate them there, or you put the doxygen comment into any  
source file, starting with  /** \fn myFunc(int, int)  . It will then  
create a reference even if the function is declared and implemented  
somewhere else.

I very much dislike strewing doxygen comment into source *and* header  
files. To me, it just makes it hareder to find the actual  
documentation. Since the header contain all externally visible  
structures, I prefer the headers. It does require a bit more  
discipline if the functionality of an existing function changes.

Matthias

----
http://robowerk.com/


_______________________________________________
fltk-dev mailing list
[email protected]
http://lists.easysw.com/mailman/listinfo/fltk-dev

Reply via email to