Add documentation to Duration and TimePoint header files #41
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
|
@arrieta I also started writing the technical report. I added a section for explaining osculating orbits, and a section to explain why only elliptical orbits can be described with keplerian parameters. However, wouldn't circles work just fine too? Hyperbolas and parabolas would too, but they are technically not orbits, but trajectories, right? |
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.
All methods have been extensively documented. I am not sure if this is the right amount, but I added @brief to all methods, and @return and @param to those that returned something and to those that had parameters, respectively.