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

Improve all API documentation #303

Open
2 of 45 tasks
chapulina opened this issue Dec 10, 2021 · 0 comments
Open
2 of 45 tasks

Improve all API documentation #303

chapulina opened this issue Dec 10, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers

Comments

@chapulina
Copy link
Contributor

Desired behavior

  • Check spelling
  • Mention units where needed
  • Add examples to the API doc
  • Make sure descriptions are meaningful, and not just
/// \brief Sets A.
void SetA(int _a)

Alternatives considered

N/A

Implementation suggestion

  1. Angle
  2. AxisAlignedBox
  3. Box
  4. Color
  5. Cylinder
  6. DiffDriveOdometry
  7. Filter
  8. Frustum
  9. GaussMarkovProcess
  10. graph/Edge
  11. graph/GraphAlgorithms
  12. graph/Graph
  13. graph/Vertex
  14. Helpers
  15. Inertial
  16. Kmeans
  17. Line2
  18. Line3
  19. MassMatrix3
  20. Material
  21. MaterialType
  22. Matrix3
  23. Matrix4
  24. MovingWindowFilter
  25. OrientedBox
  26. PID
  27. Plane
  28. Pose3
  29. Quaternion. See pull request #327.
  30. Rand
  31. RollingMean
  32. RotationSpline
  33. SemanticVersion
  34. SignalStats
  35. Sphere
  36. SphericalCoordiantes
  37. Spline
  38. Stopwatch
  39. Temperature
  40. Triangle3
  41. Triangle
  42. Vector2
  43. Vector3
  44. Vector3Stats
  45. Vector4

Additional context

This was broken off #101.

@chapulina chapulina added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers labels Dec 10, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant