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

Add doxygen for all files #2155

Closed
SteveMacenski opened this issue Jan 22, 2021 · 6 comments
Closed

Add doxygen for all files #2155

SteveMacenski opened this issue Jan 22, 2021 · 6 comments
Labels
help wanted Extra attention is needed

Comments

@SteveMacenski
Copy link
Member

We have pretty good coverage on this already, but there are a couple of packages missing doxygen in the headers

@SteveMacenski
Copy link
Member Author

A good first time issue user might want to just add these for a couple of header files missing them! You don't have to do everything at once, even a little bit at a time is super helpful

@SteveMacenski
Copy link
Member Author

SteveMacenski commented Feb 4, 2021

From a survey, these are the packages needed doxygen

  • AMCL, sensors/laser/laser.hpp, amcl_node.hpp, angleutils.hpp, map/map_cspace.cpp remaining
  • behavior tree
  • costmap 2d: in order left is array_parser.hpp -> costmap_topic_collision_checker.hpp, costmap filters direcory
  • navfn
  • recoveries
  • utils

@SteveMacenski SteveMacenski added the help wanted Extra attention is needed label Feb 4, 2021
@mlsdpk
Copy link
Contributor

mlsdpk commented Feb 11, 2021

@SteveMacenski this is my first time contributing to the project, I would like to take navfn first if possible.

@SteveMacenski
Copy link
Member Author

That would be greatly helpful, thanks @mlsdpk!

@SteveMacenski
Copy link
Member Author

I did utils and recoveries

@SteveMacenski
Copy link
Member Author

Phew.... 2,000 lines later, finally complete!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants