doxygen

Include file with doxygen special commands


Does doxygen have a special command to include a file into a source file and doxygen treats the included file as if it were directly in the source file?

Both variants shall generate the same output. It's not just about replacing @details, but a large amount of text.

Variant A

// --- SourceFile.c ---
/*! \brief description 
 *  \details description
 */

Variant B

// --- SourceFile.c ---
/*! \brief description 
 *  \command file.txt -> this shall insert file.txt here
 */

// --- file.txt ---
// \details description

Solution

  • In newer versions of doxygen the \include special command has an additional option. With the option {doc} the contents of file.txt is treated as if it were directly in the source file.

    // --- SourceFile.c ---
    /*! \brief description 
     *  \include{doc} file.txt
     */
    
    // --- file.txt ---
    // \details description