search

coin-or / ADOL-C

A Package for Automatic Differentiation of Algorithms Written in C/C++
Other
146 stars 31 forks source link

[doc] Add a stub for doxygen documentation #85

Closed cgraeser closed 3 days ago

cgraeser commented 4 days ago

This adds a doxygen configuration file and some rudimentary structure. The documentation can be build by calling

make doxygen

in the build directory after the project has been configured with CMake and if doxygen was found. This will create a subdirectory ADOL-C/doc/doxygen/html/ containing the class documentation with index.html as entry page. Currently there is no class documentation at all. If doxygen tags are added to classes and functions, they will show up here after regeneration of the documentation.

~Once a CMake build system has been established, one can also build the doxygen documentation using CMake.~ (done)

codecov[bot] commented 4 days ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 65.95%. Comparing base (6c58e40) to head (a02023b). Report is 4 commits behind head on master.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #85 +/- ## ======================================= Coverage 65.95% 65.95% ======================================= Files 51 51 Lines 26473 26473 Branches 1843 1843 ======================================= Hits 17461 17461 Misses 9012 9012 ``` | [Flag](https://app.codecov.io/gh/coin-or/ADOL-C/pull/85/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=coin-or) | Coverage Δ | | |---|---|---| | [unittests](https://app.codecov.io/gh/coin-or/ADOL-C/pull/85/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=coin-or) | `65.95% <ø> (ø)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=coin-or#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

cgraeser commented 4 days ago

For now the doxygen documentation has to be build manually. If desired, one can add the ALL flag to the target, such that it is always build (if doxygen was found).

cgraeser commented 4 days ago

While both touch the CMake build-system this is essentially independent of #87, since the latter does not touch doc/.