Doxygen

Doxygen is the de facto standard tool for generating documentation from annotated C/C++ sources.

YAML Configuration

doxygen:

  • config-file:

    • Path to the Doxygen configuration file (Doxyfile).
    • If this field is omitted:
      • Docstand automatically searches for Doxyfile and uses it to build documentation.
      • In the case when Doxyfile is not present, Doxygen runs with default configurations.
  • machine:

    • cpu:

      Amount of CPU. The default machine has 0.75 CPU with 2880 MiB RAM.

Examples

  • With doxygen set to default

    docstand:
      doxygen: default
    
  • With custom machine:

    docstand:
      doxygen:
        machine:
          cpu: 1.5 # 1.5 CPU, 5760 MiB RAM
    
  • With config-file option

    docstand:
      doxygen:
        config-file: src/Doxyfile
    

results matching ""

    No results matching ""