update doxygen.

urdf/include/urdf/model.h

@@ -52,9 +52,13 @@ class Model
 public:
   Model();
 
+  /// \brief Load Model from TiXMLElement
   bool initXml(TiXmlElement *xml);
+  /// \brief Load Model from TiXMLDocument
   bool initXml(TiXmlDocument *xml);
+  /// \brief Load Model given a filename
   bool initFile(const std::string& filename);
+  /// \brief Load Model from a XML-string
   bool initString(const std::string& xmlstring);
 
   boost::shared_ptr<const Link> getRoot(void) const{return this->root_link_;};
@@ -64,18 +68,20 @@ public:
 
   void getLinks(std::vector<boost::shared_ptr<Link> >& links) const;
 
-  /// Some accessor functions
+  /// \brief get parent Link of a Link given name
   boost::shared_ptr<const Link> getParentLink(const std::string& name) const;
+  /// \brief get parent Joint of a Link given name
   boost::shared_ptr<const Joint> getParentJoint(const std::string& name) const;
+  /// \brief get child Link of a Link given name
   boost::shared_ptr<const Link> getChildLink(const std::string& name) const;
+  /// \brief get child Joint of a Link given name
   boost::shared_ptr<const Joint> getChildJoint(const std::string& name) const;
 
-  /// Every Robot Description File can be described as a
+  /// \brief complete list of Links
-  ///   list of Links and Joints
-  /// The connection between links(nodes) and joints(edges)
-  ///   should define a tree (i.e. 1 parent link, 0+ children links)
   std::map<std::string, boost::shared_ptr<Link> > links_;
+  /// \brief complete list of Joints
   std::map<std::string, boost::shared_ptr<Joint> > joints_;
+  /// \brief complete list of Materials
   std::map<std::string, boost::shared_ptr<Material> > materials_;
 
 private:

urdf/mainpage.dox

@@ -2,58 +2,11 @@
 \mainpage
 \htmlinclude manifest.html
 
-\b robot_model is ... 
+URDF is a class containing robot model data structure.
-
+Every Robot Description File can be described as a list of Links and Joints.
-<!-- 
+The connection between links(nodes) and joints(edges) should define a tree (i.e. 1 parent link, 0+ children links).
-In addition to providing an overview of your package,
+Below is an example Robot Description Describing a Parent Link 'P', a Child Link 'C', and a Joint 'J'
-this is the section where the specification and design/architecture 
+\li NEW URDF XML that corresponds to the current URDF data structure:
-should be detailed. While the original specification may be done on the
-wiki, it should be transferred here once your package starts to take shape.
-You can then link to this documentation page from the Wiki. 
--->
-
-\li RobotModel is a class containing robot model data structure.
-
-\li Below is an example Robot Description Describing a Parent Link "P", a Child Link "C", and a Joint "J"
-
-\li OLD URDF:
- @verbatim
-  <link name="C">
-    <inertial>
-      <mass value="10"/>
-      <origin xyz="0 0 0" rpy="0 0 0"/>
-      <inertia ixx="1" ixy="0" ixz="0" iyy="1" iyz="0" izz="1"/>
-    </inertial>
-    <visual>
-      <origin xyz="0 0 0" rpy="0 0 0"/>
-      <geometry>
-        <box size="1 1 1"/>
-      </geometry>
-    </visual>
-    <collision>
-      <origin xyz="0 0 0" rpy="0 0 0"/>
-      <geometry>
-        <box size="1.01 1.01 1.01"/>
-      </geometry>
-    </collision>
-
-    <parent name="P"/>  <!-- name of the parent link. in new RobotModel, this is in <link><joint>, not here -->
-
-    <!-- <origin> is the transform from parent Link to this Joint in parent Link frame -->
-    <origin xyz="0 0 0" rpy="0 0 0"/> <!-- in new RobotModel, this is in <joint><parent>, not here -->
-
-    <joint name="J" type="revolute">
-      <!-- joint properties -->
-      <axis xyz="0 1 0"/>
-      <joint_properties damping="1" friction="0"/>
-      <limit min="0" max="1" effort="1000" velocity="1"/>
-
-      <!-- OPTIONAL: transform from this Joint in child Link frame to child Link (equivalent to <child> in new RobotModel) -->
-      <anchor xyz="0 0 0"/>
-    </joint>
-  </link>
- @endverbatim
-\li NEW URDF XML that corresponds to the current RobotModel data structure:
  @verbatim
   <joint name="J" type="revolute">
     <dynamics damping="1" friction="0"/>
@@ -105,20 +58,19 @@ You can then link to this documentation page from the Wiki.
 
 \section codeapi Code API
 
+The URDF parser API contains the following methods:
+  \li Parse from XML: urdf::Model::initXml
+  \li Parse from File: urdf::Model::initFile
+  \li Parse from String: urdf::Model::initString
+  \li Get Root Link: urdf::Model::getRoot
+  \li Get Link by name urdf::Model::getLink
+  \li Get all Link's urdf::Model::getLinks
+  \li Get Joint by name urdf::Model::getJoint
+  \li etc.
+
 <!--
-Provide links to specific auto-generated API documentation within your
-package that is of particular interest to a reader. Doxygen will
-document pretty much every part of your code, so do your best here to
-point the reader to the actual API.
-
-If your codebase is fairly large or has different sets of APIs, you
-should use the doxygen 'group' tag to keep these APIs together. For
-example, the roscpp documentation has 'libros' group.
--->
-
 \section rosapi ROS API
 
-<!--
 Names are very important in ROS because they can be remapped on the
 command-line, so it is VERY IMPORTANT THAT YOU LIST NAMES AS THEY
 APPEAR IN THE CODE. You should list names of every topic, service and