John Hsu avatar John Hsu committed 79ed5b4

update doxygen comments

Comments (0)

Files changed (9)

 # name of the file that contains the anonymous namespace. By default
 # anonymous namespace are hidden.
 
-EXTRACT_ANON_NSPACES   = NO
+EXTRACT_ANON_NSPACES   = YES
 
 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
 # undocumented members of documented classes, files or namespaces.
 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
 # in the documentation. The default is NO.
 
-SHOW_DIRECTORIES       = NO
+SHOW_DIRECTORIES       = YES
 
 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
 # This will remove the Files entry from the Quick Index and from the
 # If FILTER_PATTERNS is specified, this tag will be
 # ignored.
 
-INPUT_FILTER           =
+INPUT_FILTER           = "sed 's/boost::shared_ptr<\(.*\)>/\1*/'"
 
 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
 # basis.
 # function macros are typically used for boiler-plate code, and will confuse
 # the parser if not removed.
 
-SKIP_FUNCTION_MACROS   = YES
+SKIP_FUNCTION_MACROS   = NO
 
 #---------------------------------------------------------------------------
 # Configuration::additions related to external references
 
 namespace gazebo
 {
+  /// \brief A ROS Master-like manager that directs gztopic connections, enables
+  ///        each gazebo network client to locate one another for peer-to-peer
+  ///        communication.
   class Master
   {
     /// \brief Constructor

gazebo/physics/Actor.hh

 
     /// \addtogroup gazebo_physics
     /// \{
-    /// \brief An actor
+    /// \brief Actor class enables GPU based mesh model / skeleton
+    ///              scriptable animation.
     class Actor : public Model
     {
       /// \brief Constructor

gazebo/physics/Base.hh

 
 namespace gazebo
 {
+  ///\brief namespace for physics
   namespace physics
   {
     /// \addtogroup gazebo_physics Physics

gazebo/physics/PhysicsTypes.hh

 
 /// \file
 /// \ingroup gazebo_physics
-/// \brief Physics forward declarations and type defines
+///\brief default namespace for gazebo
 namespace gazebo
 {
+  /// \brief Physics forward declarations and type defines
   namespace physics
   {
     class Base;

gazebo/physics/RayShape.hh

   {
     /// \addtogroup gazebo_physics
     /// \{
-    /// \brief Ray collision
+    /// \brief Base class for Ray collision geometry
     class RayShape : public Shape
     {
       /// \brief Constructor for a global ray

gazebo/physics/SurfaceParams.hh

   {
     /// \addtogroup gazebo_physics
     /// \{
-    /// \brief Surface params
+    /// \brief SurfaceParams defines surface contact parameters.
     class SurfaceParams
     {
       /// \brief Constructor
 
       public: virtual void ProcessMsg(const msgs::Surface &_msg);
 
-      /// 0..1, 0 = no bounciness
+      /// \brief bounce restitution coefficient [0,1], with 0 being inelastic,
+      ///        and 1 being perfectly elastic.
+      /// \sa    http://www.ode.org/ode-latest-userguide.html#sec_7_3_7
       public: double bounce;
 
-      /// \brief bounce vel
+      /// \brief minimum contact velocity for bounce to take effect, otherwise
+      ///        the collision is treated as an inelastic collision.
+      /// \sa    http://www.ode.org/ode-latest-userguide.html#sec_7_3_7
       public: double bounceThreshold;
 
+      /// \brief spring constant equivalents of a contact as a function of 
+      ///        SurfaceParams::cfm and SurfaceParams::erp.
+      /// \sa    See for example
+      ///        http://www.ode.org/ode-latest-userguide.html#sec_3_8_2
+      ///        for more details.
       public: double kp;
+      /// \brief spring damping constant equivalents of a contact as a
+      ///        function of SurfaceParams::cfm and SurfaceParams::erp.
+      /// \sa    See for example
+      ///        http://www.ode.org/ode-latest-userguide.html#sec_3_8_2
+      ///        for more details.
       public: double kd;
 
+      /// \brief Constraint Force Mixing parameter.
+      ///        See for example
+      ///        http://www.ode.org/ode-latest-userguide.html#sec_3_8_0
+      ///        for more details.
       public: double cfm;
+
+      /// \brief Error Reduction Parameter.
+      /// \sa    See for example
+      ///        http://www.ode.org/ode-latest-userguide.html#sec_3_8_0
+      ///        for more details.
       public: double erp;
+
+      /// \brief Maximum interpenetration error correction velocity.  If
+      ///        set to 0, two objects interpenetrating each other
+      ///        will not be pushed apart.
+      /// \sa    See dWroldSetContactMaxCorrectingVel
+      ///        (http://www.ode.org/ode-latest-userguide.html#sec_5_2_0)
       public: double maxVel;
+
+      /// \brief Minimum depth before ERP takes effect.
+      /// \sa    See dWorldSetContactSurfaceLayer
+      ///        (http://www.ode.org/ode-latest-userguide.html#sec_5_2_0)
       public: double minDepth;
+
+      /// \brief Dry friction coefficient in the primary friction direction
+      ///        as defined by the friction pyramid.  This is fdir1 if defined,
+      ///        otherwise, a vector consstrained to be perpendicular to the
+      ///        contact normal in the global y-z plane is used.
+      /// \sa    http://www.ode.org/ode-latest-userguide.html#sec_7_3_7
       public: double mu1;
+
+      /// \brief Dry friction coefficient in the second friction direction
+      ///        as defined by the friction pyramid.  This is fdir1 if defined,
+      ///        otherwise, a vector consstrained to be perpendicular to the
+      ///        contact normal in the global y-z plane is used.
+      /// \sa    http://www.ode.org/ode-latest-userguide.html#sec_7_3_7
       public: double mu2;
+
+      /// \brief Artificial contact slip.
+      /// \sa    See dContactSlip1 in
+      ///        http://www.ode.org/ode-latest-userguide.html#sec_7_3_7
       public: double slip1;
+
+      /// \brief Artificial contact slip.
+      /// \sa    See dContactSlip2 in
+      ///        http://www.ode.org/ode-latest-userguide.html#sec_7_3_7
       public: double slip2;
+
+      /// \brief Primary friction direction for dry friction coefficient
+      ///        (SurfaceParams::mu1) of the friction pyramid.
+      ///        If undefined, a vector consstrained to be perpendicular
+      ///        to the contact normal in the global y-z plane is used.
+      /// \sa    http://www.ode.org/ode-latest-userguide.html#sec_7_3_7
       public: math::Vector3 fdir1;
     };
     /// \}

gazebo/sensors/Sensors.cc

 
   // Load the rendering system
   if (!gazebo::rendering::load())
-    gzthrow("Unable to load the rendering engine");
+    gzerr << "Unable to load the rendering engine";
+    //gzthrow("Unable to load the rendering engine");
 
   return true;
 }

sdf/worlds/spring_test.world

                   erp = hk / (hk + r);
                   cfm = 1.0f / (hk + r);
       }
+      in the end,
+      erp = dt * kp / ( dt * kp + kd )
+      cfm = 1 / ( dt * kp + kd )
     -->
     <model name="model_0" static="false">
 
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.