[doc] Add a stub for doxygen documentation #85
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This adds a doxygen configuration file and some rudimentary structure. The documentation can be build by calling ``` doxygen Doxyfile ``` in the `ADOL-C/doc/doxygen/` subdirectory. This will create a sudirectory `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.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #85 +/- ##
=======================================
Coverage 65.95% 65.95%
=======================================
Files 51 51
Lines 26473 26473
Branches 1843 1843
=======================================
Hits 17461 17461
Misses 9012 9012
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
|
For now the doxygen documentation has to be build manually. If desired, one can add the |
|
While both touch the CMake build-system this is essentially independent of #87, since the latter does not touch |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds a doxygen configuration file and some
rudimentary structure. The documentation can
be build by calling
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 withindex.htmlas 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)