lgmath icon indicating copy to clipboard operation
lgmath copied to clipboard

Document function parameters and return values

Open cglwn opened this issue 8 years ago • 0 comments

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

cglwn avatar Jan 26 '17 10:01 cglwn