kicad-developers team mailing list archive

[Dick Hollenbeck <dick@xxxxxxxxxxx>]

> This comment should go in the header file, not in the C++ file, for the benefit of
> "one place of comment maintenance" and for access by doxygen.  Doxygen
> is configured to pick from the header file the function comments, as a higher priority
> than from the C++ file.
> 
> 
> /**
>  * Function CloseWindow
>  * will close the window.
>  */
> 
> Doxygen puts the above text in a single sentence which reads well.
> 
> "Function CloseWindow will close the window."


For derived classes, where a virtual function is overloaded, the function comments are
inherited by doxygen unless present and modified.  This can save typing, and suggests
that sometimes


"reading the doxygen output can be more informative than reading the source code."
Seems reasonable to assume that, else why doxygen?