Add doxygen documentation #56
Merged
Conversation
This file contains hidden or 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
tdrwenski
force-pushed
the
documentation
branch
4 times, most recently
from
57a88d3 to
0e003bb
Compare
* Updated doxygen comments for all header files * Renamed PythonInterface to HamiltonianFileReader (class name and hpp,cpp files) * Renamed MapParam to Config (class name and hpp, cpp files) * Added 'protected' key word for class members that did not have a specifier, so they show up in the doxygen-generated html.
The latex user guide Was in doc/, now it is in docs/user_guide/
This renames computedRHSdp to compute_dRHS_dparams, and adds documentation. Subroutines for the sparse-matrix and the matrix-free version of this routine are created and documented.
steffi7574
approved these changes
Jun 13, 2025
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.
TODO: remove that it deploys on this branch (for testing), should only deploy on main