• Patrick
  • Vincent
  • Ethan

Instructions for doing a doc review

See DocReviewProcess for more instructions

  1. Does the documentation define the Users of the Stack, i.e. for the expected usages of the Stack, which APIs will users engage with?
  2. Are all of these APIs documented?
  3. Do relevant usages have associated tutorials?
  4. Have all Packages in the Stack been API reviewed?

  5. Does the Stack conform to the StackDocumentation guidelines?

  6. Are there Packages in the Stack that don't belong

Concerns / issues




  • API are documented through doxygen so clear overall (skimmed through it).
  • looked at all tutorials: homogeneous in style and detailed
  • enough ROS examples in pcl_ros (e.g. how to publish point clouds)


Wiki: point_cloud_perception/Reviews/5-13-2011_Doc_Review (last edited 2011-05-19 17:57:00 by VincentRabaud)