Organization of this Document

This document is divided into several chapters describing various aspects of the tool suite.

• “HeaderDoc Tags” explains how to add HeaderDoc markup to header (and source code) files.

• “Using HeaderDoc” explains the syntax for the HeaderDoc command-line tool itself.

• “Using gatherHeaderDoc” explains how to use gatherHeaderDoc to produce landing pages and cross-linked trees of related documentation.

• “Using the MPGL Suite” explains how to use the Manual Page Generation Language (MPGL) tool suite.

• “Configuring HeaderDoc” explains the HeaderDoc configuration file.

• “Symbol Markers for HTML-Based Documentation” describes the symbol markers used by HeaderDoc and various other utilities to provide linking functionality.

• “HeaderDoc Class Hierarchy” describes the class hierarchy of the HeaderDoc tool itself.

• “Troubleshooting” gives helpful hints on debugging HeaderDoc content.