Experience with Doxygen and its use in Atlas


DB Group
(D.Malon, RD Schaffer)

From the database documentationstanddown TWiki:

Packages included in the documentation standdown include:

  • Database/AthenaPOOL and its many contained packages, except as noted below (and any packages in Database upon which it depends?)--BNL, ANL (lead: Peter);
  • Database/AthenaPOOL/RDBAccessSvc--Pittsburgh (lead: Vakho);
  • Database/AthenaPOOL/AthenaPoolUtilities--ANL, BNL (lead: Kristo);
  • Database/RegistrationServices--Orsay? (lead: RD);
  • Database/IOVDbXXX packages--Orsay (lead: RD)
  • CondXXX packages--Abstracture+Orsay? (lead: Sven);
  • Database/ConnectionManagement--ANL, CERN (Sasha, Yulia);
  • AtlasTest/DatabaseTest--many (lead: Jack);
  • External/ColManXXX--Orsay (lead: Julius): reasonably complete and conformant documentation, reachable from Atlas "Doxygen" page;
  • Octopus--Orsay (lead: Julius): end-user standalone documentation.

Please see https://twiki.cern.ch/twiki/bin/view/Atlas/DocumentationStanddown for many more details.

We had no particular problems with doxygen documentation, though once we knew how to build doxygen documentation with CMT, our principal documentation source became http://www.stack.nl/~dimitri/doxygen/. It would have been useful to see some ATLAS guidelines regarding doxygen documentation (should we use @file, @class, @param, @return, and so on). Perhaps we overlooked these. (I seem to recall that it was not immediately clear to everyone involved how/where to find the latest doxygen documentation, nor was there general awareness of the existence of rel/current_doxygen (versus rel/current), and so on.)

The SIT group was very responsive in evolving the CMT doxygen setup to support our documentation effort (adding search directories and filetype extensions and so on).

It would be nice to see at least some minimal support for Python (sufficient, say, to get @file comments in .py files to appear in the doxygen-generated file list). I know there are preprocessors for this sort of thing, though I defer to experts to propose the best way to accomplish this.

-- DavidMalon - 03 Feb 2005


Inner Detector Group
(Ed Moyse, ..)
  • Packages documented:

Atlas Core Software
(P. Calafiura, ..)
  • Packages documented:

Page created by: TraudlKozanecki - 27 Jan 2005
Last significant update: DavidMalon - 1 Feb 2005

Edit | Attach | Watch | Print version | History: r3 < r2 < r1 | Backlinks | Raw View | WYSIWYG | More topic actions
Topic revision: r3 - 2005-02-16 - TraudlKozanecki
 
    • Cern Search Icon Cern Search
    • TWiki Search Icon TWiki Search
    • Google Search Icon Google Search

    Main All webs login

This site is powered by the TWiki collaboration platform Powered by PerlCopyright & 2008-2019 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback