API review

Proposer: Wim Meeussen

Present at review:

  • List reviewers

Question / concerns / comments

Enter your thoughts on the API and any questions / concerns you have here. Please sign your name. Anything you want to address in the API review should be marked down here before the start of the meeting.

Vijay

  • The name 'dom_parser.hpp' doesn't provide much useful context. What is dom? Could this file just be kdl_parser.h? If not, at least give a hint somewhere on the wiki page as to what DOM stands for.

  • kdl_parser::treeFromRobotModel builds a tree from a urdf::Model. Thus, maybe this function should be called kdl_parser::treeFromUrdfModel?

  • Add lines to the xml example, showing type information for xml_doc.
  • Assuming that doxygen is populated, I would link to the various function descriptions from the wiki.

John

  • adding to Vijay's comment, 'dom_parser' might be ok if you are planning to support multiple robot description formats in the future.
  • robot_description_new-->robot_description

  • adding const to all converter function input parameters

Meeting agenda

To be filled out by proposer based on comments gathered during API review period

Conclusion

Package status change mark change manifest)

  • /!\ Action items that need to be taken.

  • {X} Major issues that need to be resolved


Wiki: kdl_parser/Reviews/2009-09-25_API_Review (last edited 2009-09-24 19:05:33 by hsu)