SF.net SVN: openvrml:[4061] trunk

[<br...@us...>]

Revision: 4061
          http://openvrml.svn.sourceforge.net/openvrml/?rev=4061&view=rev
Author:   braden
Date:     2010-01-23 05:49:14 +0000 (Sat, 23 Jan 2010)

Log Message:
-----------
Doc-comment fixes and improvements.

Modified Paths:
--------------
    trunk/ChangeLog
    trunk/src/libopenvrml/openvrml/browser.cpp
    trunk/src/libopenvrml/openvrml/event.cpp
    trunk/src/libopenvrml/openvrml/field_value.cpp
    trunk/src/libopenvrml/openvrml/node.cpp
    trunk/src/libopenvrml/openvrml/node_impl_util.h
    trunk/src/libopenvrml/openvrml/scope.cpp
    trunk/src/libopenvrml/openvrml/script.cpp

Modified: trunk/ChangeLog
===================================================================
--- trunk/ChangeLog	2010-01-23 05:43:08 UTC (rev 4060)
+++ trunk/ChangeLog	2010-01-23 05:49:14 UTC (rev 4061)
@@ -1,5 +1,17 @@
 2010-01-23 Braden McDaniel  <br...@en...>
 
+	Doc-comment fixes and improvements.
+
+	* src/libopenvrml/openvrml/event.cpp
+	* src/libopenvrml/openvrml/node.cpp
+	* src/libopenvrml/openvrml/script.cpp
+	* src/libopenvrml/openvrml/node_impl_util.h
+	* src/libopenvrml/openvrml/scope.cpp
+	* src/libopenvrml/openvrml/field_value.cpp
+	* src/libopenvrml/openvrml/browser.cpp
+
+2010-01-23 Braden McDaniel  <br...@en...>
+
 	Escape control characters for doxygen.
 
 	* doc/gpl.doc

Modified: trunk/src/libopenvrml/openvrml/browser.cpp
===================================================================
--- trunk/src/libopenvrml/openvrml/browser.cpp	2010-01-23 05:43:08 UTC (rev 4060)
+++ trunk/src/libopenvrml/openvrml/browser.cpp	2010-01-23 05:49:14 UTC (rev 4061)
@@ -1502,8 +1502,8 @@
  *          likelihood any preexisting entry in the map with the same
  *          implementation identifier as @p id will have been removed.
  *
- * @param[in] id    a @c node_metatype identifier.
- * @param[in] nc    a @c boost::shared_ptr to a @c node_metatype
+ * @param[in] id        a @c node_metatype identifier.
+ * @param[in] metatype  a @c boost::shared_ptr to a @c node_metatype
  *
  * @exception std::invalid_argument if @p nc is null.
  * @exception std::bad_alloc        if memory allocation fails.

Modified: trunk/src/libopenvrml/openvrml/event.cpp
===================================================================
--- trunk/src/libopenvrml/openvrml/event.cpp	2010-01-23 05:43:08 UTC (rev 4060)
+++ trunk/src/libopenvrml/openvrml/event.cpp	2010-01-23 05:49:14 UTC (rev 4061)
@@ -549,6 +549,8 @@
  *
  * @brief Emit an event.
  *
+ * @tparam FieldValue   a @link FieldValueConcept Field Value@endlink.
+ *
  * @param[in] timestamp the current time.
  *
  * @exception std::bad_alloc    if memory allocation fails.
@@ -559,8 +561,6 @@
  *
  * @brief Emit an event.
  *
- * @tparam FieldValue   a @link FieldValueConcept Field Value@endlink.
- *
  * @param[in] timestamp the current time.
  *
  * @exception std::bad_alloc    if memory allocation fails.

Modified: trunk/src/libopenvrml/openvrml/field_value.cpp
===================================================================
--- trunk/src/libopenvrml/openvrml/field_value.cpp	2010-01-23 05:43:08 UTC (rev 4060)
+++ trunk/src/libopenvrml/openvrml/field_value.cpp	2010-01-23 05:49:14 UTC (rev 4061)
@@ -38,6 +38,8 @@
  */
 
 /**
+ * @relatesalso openvrml::field_value
+ *
  * @brief Stream output.
  *
  * @param[in,out] out   an output stream.

Modified: trunk/src/libopenvrml/openvrml/node.cpp
===================================================================
--- trunk/src/libopenvrml/openvrml/node.cpp	2010-01-23 05:43:08 UTC (rev 4060)
+++ trunk/src/libopenvrml/openvrml/node.cpp	2010-01-23 05:49:14 UTC (rev 4061)
@@ -687,7 +687,7 @@
 }
 
 /**
- * @relates openvrml::node_metatype_id
+ * @relatesalso openvrml::node_metatype_id
  *
  * @param[in] lhs
  * @param[in] rhs
@@ -702,7 +702,7 @@
 }
 
 /**
- * @relates openvrml::node_metatype_id
+ * @relatesalso openvrml::node_metatype_id
  *
  * @param[in] lhs
  * @param[in] rhs
@@ -1121,7 +1121,7 @@
  */
 
 /**
- * @relates openvrml::node_type
+ * @relatesalso openvrml::node_type
  *
  * @brief Compare for equality.
  *
@@ -1156,7 +1156,7 @@
 }
 
 /**
- * @relates openvrml::node_type
+ * @relatesalso openvrml::node_type
  *
  * @brief Compare for inequality.
  *
@@ -3018,7 +3018,7 @@
 }
 
 /**
- * @fn const boost::intrusive_ptr<openvrml::node> & openvrml::appearance_node::material() const
+ * @fn const boost::intrusive_ptr<openvrml::node> & openvrml::appearance_node::do_material() const
  *
  * @brief Get the material node associated with this appearance node.
  *
@@ -3037,7 +3037,7 @@
 }
 
 /**
- * @fn const boost::intrusive_ptr<openvrml::node> & openvrml::appearance_node::texture() const
+ * @fn const boost::intrusive_ptr<openvrml::node> & openvrml::appearance_node::do_texture() const
  *
  * @brief Get the texture node associated with this appearance node.
  *
@@ -3057,7 +3057,7 @@
 }
 
 /**
- * @fn const boost::intrusive_ptr<openvrml::node> & openvrml::appearance_node::texture_transform() const
+ * @fn const boost::intrusive_ptr<openvrml::node> & openvrml::appearance_node::do_texture_transform() const
  *
  * @brief Get the texture transform node associated with this appearance node.
  *
@@ -3517,7 +3517,7 @@
 /**
  * @brief Right texture.
  *
- * This function delegates to @c @do_right.
+ * This function delegates to @c #do_right.
  *
  * @return the right texture.
  */
@@ -3674,7 +3674,7 @@
 /**
  * @brief Get the @c color_rgba array encapsulated by this @c node.
  *
- * This function delegates to @c #do_color.
+ * This function delegates to @c #do_color_rgba.
  *
  * @return the @c color_rgba array for this @c node.
  */
@@ -4167,7 +4167,8 @@
  * @brief Called in response to user interaction to activate any child pointing
  *        device sensor nodes.
  *
- * Delegates to @c #do_activate.
+ * Calls @c pointing_device_sendor_node::activate for child
+ * @c pointing_device_sensor_node%s, recursively.
  *
  * @param[in] timestamp the current time.
  * @param[in] over      whether the pointer is over sensitive geometry.

Modified: trunk/src/libopenvrml/openvrml/node_impl_util.h
===================================================================
--- trunk/src/libopenvrml/openvrml/node_impl_util.h	2010-01-23 05:43:08 UTC (rev 4060)
+++ trunk/src/libopenvrml/openvrml/node_impl_util.h	2010-01-23 05:49:14 UTC (rev 4061)
@@ -945,11 +945,11 @@
         }
 
         template <typename Node>
-        template <typename EventListenerMember, typename DeducedNode>
+        template <typename EventEmitterMember, typename DeducedNode>
         void node_type_impl<Node>::
         add_eventout(const openvrml::field_value::type_id type,
                      const std::string & id,
-                     EventListenerMember DeducedNode::* event_emitter)
+                     EventEmitterMember DeducedNode::* event_emitter)
             OPENVRML_THROW2(std::invalid_argument, std::bad_alloc)
         {
             using openvrml::node_interface;

Modified: trunk/src/libopenvrml/openvrml/scope.cpp
===================================================================
--- trunk/src/libopenvrml/openvrml/scope.cpp	2010-01-23 05:43:08 UTC (rev 4060)
+++ trunk/src/libopenvrml/openvrml/scope.cpp	2010-01-23 05:49:14 UTC (rev 4061)
@@ -237,7 +237,7 @@
 }
 
 /**
- * @relates openvrml::scope
+ * @relatesalso openvrml::scope
  *
  * @param[in] s a @c scope.
  *

Modified: trunk/src/libopenvrml/openvrml/script.cpp
===================================================================
--- trunk/src/libopenvrml/openvrml/script.cpp	2010-01-23 05:43:08 UTC (rev 4060)
+++ trunk/src/libopenvrml/openvrml/script.cpp	2010-01-23 05:49:14 UTC (rev 4061)
@@ -581,6 +581,12 @@
 }
 
 /**
+ * @var boost::scoped_ptr<openvrml::script_factory_registry::impl> openvrml::script_factory_registry::impl_
+ *
+ * @brief A pointer to the implementation instance.
+ */
+
+/**
  * @internal
  *
  * @brief Construct.
@@ -901,11 +907,12 @@
 /**
  * @brief Add an interface.
  *
- * @param[in] interface
+ * @param[in] interface_
  *
  * @exception std::bad_alloc        if memory allocation fails.
  * @exception std::invalid_argument if the @c script_node_type already has an
- *                                  interface that conflicts with @p interface.
+ *                                  interface that conflicts with
+ *                                  @p interface_.
  */
 void
 openvrml::script_node::script_node_type::


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.