search

thelfer / MFrontGenericInterfaceSupport

This project aims at providing support for MFront generic behaviours. This project can be embedded in open-source and propriary sofware
37 stars 35 forks source link

API Documentation #19

Closed srmnitc closed 4 years ago

srmnitc commented 4 years ago

This is part of the review of JOSS paper https://github.com/openjournals/joss-reviews/issues/2003

The webpage mentions that API documentation can be generated using Doxygen. However, when trying to generate the documentation, the following error is generated- 

warning: tag INPUT: input source `@CMAKE_SOURCE_DIR@' does not exist
Exiting...

If any further configuration is required, it needs to be documented.

thelfer commented 4 years ago

The Doxygen documentation can be generated as part of the build process. You must pass the -Denable-doxygen-doc=ON flag to cmake to enable it (See INSTAL-cmake.md for details). The documentation is generated by:

$ make doc-html