RE: [Doxygen-users] Moving comments from .cpp/.c -> .h

[Nikitin M. (I. MP PD S. 21 AAL) <Mik...@si...>]

This doesn't answer your main question either, but you also asked about
opinions, so here you go.
In our project we decided to mainly rely on comments made in the C files, as
they have a higher chance to be updated when one changes the function. Along
this side, as comments _inside_ functios are also allowed, they are used to
document what the function does (like "Step 1. Get the display size"). In
the H files there are only @brief comments used simply to make the files
easier to read. We suppose that whomever needs a proper description of our
API, will get the generated CHM file.


Mike


-----Original Message-----
From: Ed_Owen@PlayStation.Sony.com [mailto:Ed_Owen@PlayStation.Sony.com]
Sent: Tuesday, October 19, 2004 9:01 PM
To: dox...@li...
Cc: Andrew_Walker@PlayStation.Sony.com
Subject: [Doxygen-users] Moving comments from .cpp/.c -> .h






An issue only tangentially related to Doxygen, but one I bet many of you
may have faced:

My documentation group is trying to standardize on putting Doxygen tagged
comments in .h files (at the declaration location) as opposed to .c or .cpp
files (at implementation location), where possible.

We have some projects where commenting has already been done in the
implementation, and so we're wondering if there are tools out there already
to move comments from .cpp to .h files.

Any help (or practical experience with putting comments in one place vs.
the other) much appreciated,
Ed


Ed Owen
Project Manager
Information Design and Development (IDD)
Sony Computer Entertainment America
e-mail: ed...@pl...