File OuterFile.h

Document a file that does not have any parents.

Definition (OuterFile.h)

Detailed Description

This file exists to make sure that classes not owned by a specific parent directory still appear in the File Hierarchy. This file level documentation uses simple constructs and text, and therefore does not need to utilize the \rst environment.

  1. There is no need to use a raw \rst environment.

    • Listings and the like can be parsed by Exhale.

    • Basic formatting from Doxygen such as \c or a can be used.

  2. This is about the maximum amount of “normal” formatting Exhale can handle.

To see a file that requires documentation be in an \rst environment, see File common.h and it’s associated code online. Note that the link just generated was by using \ref arbitrary/common.h .