Added documentation for Oasis #174
Open
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
matthew-mccall
requested changes
Apr 4, 2025
Collaborator
matthew-mccall
left a comment
matthew-mccall
left a comment
There was a problem hiding this comment.
Thank you for jumping on this, please note that we use doxygen for documentation generation, so it would work best if the comments were formatted as described in https://www.doxygen.nl/manual/docblocks.html. We use the javadoc style. It is also worth noting that overriding functions "inherit" documentation from their parents.
…asis Basically I felt as though there should be at least some sort of documentation for how to use the project after you built it. If this sort of thing is not appropriate or should be more specific (ex. this is how you use the I/O for oasis, etc.) feedback for how to iterate would be appreciated.
Comment on lines
+128
to
+130
| /** | ||
| *variable integration | ||
| */ |
Collaborator
There was a problem hiding this comment.
Inside a function you can use regular comments, these aren't relevant to generating online documentation. The comment block syntax is only necessary for documenting function declarations
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Added some documentation for exponent.cpp, expression.cpp, and variable.cpp