Changes between Version 7 and Version 8 of pm-doxygen


Ignore:
Timestamp:
Feb 20, 2011 7:15:08 AM (9 years ago)
Author:
stefan
Comment:

nicer title, less subtitles

Legend:

Unmodified
Added
Removed
Modified
  • pm-doxygen

    v7 v8  
    1 = Doxygen =
     1= Using Doxygen in COIN-OR =
    22
    33COIN-OR has chosen to use the [http://www.stack.nl/~dimitri/doxygen/ doxygen] program for in-code documentation. Briefly, documentation is generated by scanning source files (by default, only {{{.h}}} and {{{.hpp}}} files) which have been annotated with comments and doxygen markup. As an example, here's the [http://www.coin-or.org/Doxygen/Osi/index.html doxygen documentation generated for Osi]. Complete [http://www.stack.nl/~dimitri/doxygen/manual.html on-line doxygen documentation] is available there.
    44
    55Doxygen documentation can be built and installed just as the code is built and installed. Doxygen documentation for a given project or package can be linked with doxygen documentation for other projects or packages, within the limits of doxygen's ability.
    6 
    7 == Doxygen in COIN-OR ==
    86
    97'''NOTE''': This page describes the new architecture for generating doxygen documentation. It is only available when you use the !BuildTools >= 0.6. If your project is already set up under the old architecture, you will be replacing the existing {{{doxygen.conf}}} configuration file. If you've customized it, save it off to the side so you can restore the customizations after conversion.