Roman Kantor wrote: > Albrecht Schlosser wrote: >> Duncan Gibson wrote: >> >>> 1. the CMP/Coding Standards rules say that the doxygen comments should >>> all go into the header files. >> >> From: <http://www.fltk.org/cmp.php#SOFTWARE_DEVELOPMENT_PRACTICES> >> >> "Doxygen comments are placed in the header file for the class comments >> and any inline methods, while non-inline methods should have their >> comments placed in the corresponding source file." > > I actually prefer the doxygen doc within the headers too as it is easier > for a programmer to look for the API doc to the header where particular > function (class, ...) is dectlader. Not sure why we need to distinguish > between inline and non-inline functions for placement of doxygen > comments...
The original idea was that the Doxygen comments would stay with the code, which (hopefully) would keep them more up-to-date than if they were only in the headers... -- ______________________________________________________________________ Michael Sweet, Easy Software Products mike at easysw dot com _______________________________________________ fltk-dev mailing list [email protected] http://lists.easysw.com/mailman/listinfo/fltk-dev
