NablaZeroLabs / mxd

Space Mission Design Support Tools
MIT License
4 stars 4 forks source link

Add documentation to Duration and TimePoint header files #41

Open DavidR86 opened 5 years ago

DavidR86 commented 5 years ago

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.

DavidR86 commented 5 years ago

@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?