Changes between Version 5 and Version 6 of pm-doxygen


Ignore:
Timestamp:
Sep 28, 2010 12:04:49 AM (9 years ago)
Author:
lou
Comment:

Formatting typo

Legend:

Unmodified
Added
Removed
Modified
  • pm-doxygen

    v5 v6  
    77== Doxygen in COIN ==
    88
    9 '''NOTE''': This page describes the new architecture for generating doxygen documentation. At present (100927) it is only available when you use the BuildTools trunk. If your project is already set up under the old architecture, you will be replacing the existing {{{doxygen.conf}}} configuration file. If you've customised it, save it off to the side so you can restore the customisations after conversion.
     9'''NOTE''': This page describes the new architecture for generating doxygen documentation. At present (100927) it is only available when you use the !BuildTools trunk. If your project is already set up under the old architecture, you will be replacing the existing {{{doxygen.conf}}} configuration file. If you've customised it, save it off to the side so you can restore the customisations after conversion.
    1010
    1111To use doxygen within the COIN build system, you should first document your code using doxygen markup. Doxygen markup is designed to be minimally intrusive and works well with common styles of in-code documentation. Even with zero markup, doxygen will still generate minimal documentation showing classes and structures, their members, and their interrelationships (''e.g.'', [http://www.coin-or.org/Doxygen/DyLP DyLP]). Consult the source code for any of the COIN projects that have documentation [http://www.coin-or.org/Doxygen here].