Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document function parameters and return values #22

Open
19 tasks
cglwn opened this issue Jan 26, 2017 · 0 comments
Open
19 tasks

Document function parameters and return values #22

cglwn opened this issue Jan 26, 2017 · 0 comments

Comments

@cglwn
Copy link

cglwn commented Jan 26, 2017

Add Doxygen documentation for the parameters and return values of every function. Clang has a great -Wdocumentation warning, I'll see if GCC has something similar.

Completed Files

  • ./include/lgmath/CommonTools.hpp
  • ./include/lgmath/se3/Types.hpp
  • ./include/lgmath/se3/Transformation.hpp
  • ./include/lgmath/se3/Operations.hpp
  • ./include/lgmath/se3/TransformationWithCovariance.hpp
  • ./include/lgmath/so3/Types.hpp
  • ./include/lgmath/so3/Operations.hpp
  • ./include/lgmath/so3/Rotation.hpp
  • ./include/lgmath/CommonMath.hpp
  • ./include/lgmath/r3/Types.hpp
  • ./include/lgmath/r3/Operations.hpp
  • ./include/lgmath.hpp
  • ./src/CommonMath.cpp
  • ./src/se3/Operations.cpp
  • ./src/se3/Transformation.cpp
  • ./src/se3/TransformationWithCovariance.cpp
  • ./src/so3/Rotation.cpp
  • ./src/so3/Operations.cpp
  • ./src/r3/Operations.cpp
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant