Subject: Re: commit - doxygen comments, new layout - please look
From: Dom Lachowicz (cinamod@hotmail.com)
Date: Fri Jan 26 2001 - 13:46:54 CST
Hi guys,
I just have a pretty simple (maybe stupid?) question: is it preferable to
have these comments in the header (.h) files? All existing documentors
(gtk-doc, for one) generate documentation based on comments in the source
files.
I just think that docs in the header files serve to clutter them up - you
want a quick reference of the API if you're looking in there, not a lot of
confusing comments. If you want to know docs on what exactly a function
does, you look at the documentation before a function and then at the code
below it which (hopefully) should do what the comment says...
Just my $0.02
Dom
>From: Jesper Skov To: abiword-dev@abisource.com Subject: commit - doxygen
>comments, new layout - please look Date: Fri, 26 Jan 2001 17:52:41 +0100
>
>Hi
>
>I've moved the comments from the .cpp file to the .h file. I put them all
>starting on column 1, but I'm not sure if I'm entirely happy with that. It
>makes for easier commenting, but seems messy somehow.
>
>Comments?
>
>I'd like to add another rule, inspired by what Mike said: always use the
>/*! ... */ form of the comment markers, and leave the markers on empty
>lines thus:
>
>/*! ... */
>
>
>Jesper
>
>
>Moved doxygen comments to header file. CVS:
>---------------------------------------------------------------------- CVS:
>Enter Log. Lines beginning with `CVS:' are removed automatically CVS: CVS:
>Committing in . CVS: CVS: Modified Files: CVS: fp_Column.cpp fp_Column.h
>CVS: ----------------------------------------------------------------------
>
_________________________________________________________________
Get your FREE download of MSN Explorer at http://explorer.msn.com
This archive was generated by hypermail 2b25 : Fri Jan 26 2001 - 13:46:57 CST