Better API documentation

lakshayg / mpel

Motion Planning and Experimentation Library

http://lakshayg.github.io/mpel

MIT License

10 stars 3 forks source link

Better API documentation #4

Open lakshayg opened 8 years ago

lakshayg commented 8 years ago

The current API documentation is difficult to manage as it has to be done manually. Use Sphinx/Doxygen or some other automatic documentation generator.

lakshayg commented 8 years ago

Use Doxygen unless you have a very good reason to go with alternatives. Several sorces on the web recommend Doxygen over Sphinx for C++ documentation