ros_comm/Reviews/2011-01 Diamondback Doc Review_Doc_Review
Reviewer:
Instructions for doing a doc review
See DocReviewProcess for more instructions
- Does the documentation define the Users of the Stack, i.e. for the expected usages of the Stack, which APIs will users engage with?
- Are all of these APIs documented?
- Do relevant usages have associated tutorials?
Have all Packages in the Stack been API reviewed?
Does the Stack conform to the StackDocumentation guidelines?
- Are there Packages in the Stack that don't belong
Concerns / issues
kwc:
New roscpp-related packages have sparse or no documentation, e.g. rostime
New REP 100 packages have not been formally reviewed: rosunit, cpp_common, rostime, roscpp_traits, roscpp_serialization, rosgraph_msgs
I've removed most uses of MenuNavi now that ROS stack is less monolithic.
Conclusion
Concerns were addressed during diamondback meeting
Doc reviewed