Some suggestions involving doxygen
- We should make it a requirement that at least all interface code be
well-documented before acceptance in GlastRelease, (the goal would be all
public methods) and that the release.notes file be updated with each tag. Our
current policy is described in the formal
document, which should be updated, if we adopt my suggestions.
- All packages in the GlastRelease list should have the doxygen output
readily available, for each of the three version categories (Release, HEAD,
latest). A convenient place to click would be the
status page.
- New packages should be reviewed before acceptance into GlastRelease
- Proposal for style:
- all files should have an "@file" header, with a @brief line, followed by
comments on the contents of the file. A simple example:
FluxSvc/src/EventSource.cxx. This is different from the current
recomendation, which does not use doxygen to collect the comments.
- The release.notes should be this way as well. An example:
AnalysisNtuple/doc/release.notes. Note the use of the doxygen @verbatim
.. @endverbatim instead of
having to append \n to each line.
06/01/2010
--Toby