Skip to content

Allow user to generate open-amp API Doxygen documentation in a simple way #515

Open
@arnopo

Description

@arnopo

The current status is that we have 2 Doxygen configuration file:

We need to provide a simple way for contributors to generate the Doxygen API documentation, without duplicating the Doxygen configuration files.

The proposition is:

  • remove the Doxyfile in the root of the project ( merge some option in the doc/Doxygen.in)
  • add Doxygen installation instructions ( README.md and or a requirements.txt file)
  • add DOC_ONLY cmake option to be able to build Doxygen documentation in a simple way
cmake -Bbuild -DDOC_ONLY=on
make -C build doc 

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions