search

machines-in-motion / real_time_tools

BSD 3-Clause "New" or "Revised" License
9 stars 6 forks source link

update the documentation over all the package. #12

Closed MaximilienNaveau closed 4 years ago

MaximilienNaveau commented 4 years ago

What changed?

I update the documentation throughout the package and notably the demos. In order to compile the documentation one can do either: catkin_make -BUILD_DOCUMENTATION=ON firefox devel/share/real_time_tools/doc/html/index.html

or roscd real_time_tools mkdir _build cd _build cmake .. -BUILD_DOCUMENTATION=ON make firefox devel/share/real_time_tools/doc/html/index.html

Do not merge before:

https://github.com/machines-in-motion/mpi_cmake_modules/pull/4

vincentberenz commented 4 years ago

@MaximilienNaveau

Cool :) The demos looks much cleaner

Just saw a few typos here and there, will be easier I do another pass after the merge, and directly correct.

Also I propose we do not force doxygen comments when obvious (e.g. a brief that says the constructor constructs the instance)

MaximilienNaveau commented 4 years ago

I kinda agree for the useless comments. But I suggest to update them by actually explaining what the constructor does by default.

My problem with not providing comments at all is that doxygen return warnings and then it is difficult to identify which method deserve additional documentation or not...