How is the documentation for the acsexmpl module generated?

The documentation for the acsexmpl module is built using Doxigen documentation groups.

• The main Table of Contents is in the file:
  acsexmpl/ws/include/acsexmplDocumentation.h
  This is a fake include file used only for documentation purposes.
• The documentation generated out of this fake include renamed main.html and installed as the root page for the modul's documentation.
• This file needs to be extended and updated to cover all existing examples.
  Whenever a new example is created, is needs to be added here.  Many of them are missing now or the description is out of date.
• The TOC links to a "group" with the documentation concerning each specific example.
• The documentation for each "group" is in the specific include files and uses the defgroup tag, as in the following example:

 

/** @file acsexmplAmsSeqImpl.h 
 */ 

/** @defgroup ACSEXMPLAMSSEQDOC Antenna Mount System Sequence 
 *  @{ 
 * @htmlonly 
 .......

-- GianlucaChiozzi - 08 Nov 2006