[openvrml-commit] openvrml/src/libopenvrml/openvrml browser.cpp, 1.188, 1.189 node.cpp, 1.87, 1.88 script.cpp, 1.76, 1.77

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

Update of /cvsroot/openvrml/openvrml/src/libopenvrml/openvrml
In directory sc8-pr-cvs3.sourceforge.net:/tmp/cvs-serv16529/src/libopenvrml/openvrml

Modified Files:
	browser.cpp node.cpp script.cpp 
Log Message:
Doc-comment improvements.

Index: browser.cpp
===================================================================
RCS file: /cvsroot/openvrml/openvrml/src/libopenvrml/openvrml/browser.cpp,v
retrieving revision 1.188
retrieving revision 1.189
diff -C2 -d -r1.188 -r1.189
*** browser.cpp	6 Aug 2006 03:37:19 -0000	1.188
--- browser.cpp	6 Aug 2006 06:45:24 -0000	1.189
***************
*** 5606,5610 ****
   * @return @c true if @p lhs and @p rhs are equal, @c false otherwise.
   */
! bool openvrml::operator==(const node_metatype_id & lhs, const node_metatype_id & rhs)
      OPENVRML_NOTHROW
  {
--- 5606,5611 ----
   * @return @c true if @p lhs and @p rhs are equal, @c false otherwise.
   */
! bool openvrml::operator==(const node_metatype_id & lhs,
!                           const node_metatype_id & rhs)
      OPENVRML_NOTHROW
  {
***************
*** 5620,5624 ****
   * @return @c true if @p lhs and @p rhs are not equal, @c false otherwise.
   */
! bool openvrml::operator!=(const node_metatype_id & lhs, const node_metatype_id & rhs)
      OPENVRML_NOTHROW
  {
--- 5621,5626 ----
   * @return @c true if @p lhs and @p rhs are not equal, @c false otherwise.
   */
! bool openvrml::operator!=(const node_metatype_id & lhs,
!                           const node_metatype_id & rhs)
      OPENVRML_NOTHROW
  {
***************
*** 5725,5729 ****
                            node_metatype_equals_(entry->second));
          assert(entry->second.use_count() == count
!                && "shared_ptr<node_metatype> use_count does not match the number of entries in the browser's node_metatype_map");
      }
  # endif
--- 5727,5732 ----
                            node_metatype_equals_(entry->second));
          assert(entry->second.use_count() == count
!                && "shared_ptr<node_metatype> use_count does not match the "
!                "number of entries in the browser's node_metatype_map");
      }
  # endif
***************
*** 5786,5790 ****
  void
  openvrml::browser::node_metatype_map::init(viewpoint_node * initial_viewpoint,
!                                         const double timestamp)
  {
      boost::mutex::scoped_lock lock(this->mutex_);
--- 5789,5793 ----
  void
  openvrml::browser::node_metatype_map::init(viewpoint_node * initial_viewpoint,
!                                            const double timestamp)
  {
      boost::mutex::scoped_lock lock(this->mutex_);

Index: node.cpp
===================================================================
RCS file: /cvsroot/openvrml/openvrml/src/libopenvrml/openvrml/node.cpp,v
retrieving revision 1.87
retrieving revision 1.88
diff -C2 -d -r1.87 -r1.88
*** node.cpp	6 Aug 2006 03:37:19 -0000	1.87
--- node.cpp	6 Aug 2006 06:45:24 -0000	1.88
***************
*** 1676,1680 ****
   * @brief Destructor.
   *
!  * Remove node name (if any) from the scope.
   */
  openvrml::node::~node() OPENVRML_NOTHROW
--- 1676,1680 ----
   * @brief Destructor.
   *
!  * Remove node name (if any) from the @c scope.
   */
[...1153 lines suppressed...]
  void openvrml::node_traverser::on_entering(node &)
***************
*** 4766,4773 ****
  
  /**
!  * @brief Called for each <code>node</code> in the traversal <em>after</em>
!  *      traversing the its descendants.
   *
!  * @param[in,out] n  the <code>node</code> currently being traversed.
   */
  void openvrml::node_traverser::on_leaving(node &)
--- 4757,4764 ----
  
  /**
!  * @brief Called for each @c node in the traversal @e after
!  *        traversing the its descendants.
   *
!  * @param[in,out] n  the @c node currently being traversed.
   */
  void openvrml::node_traverser::on_leaving(node &)

Index: script.cpp
===================================================================
RCS file: /cvsroot/openvrml/openvrml/src/libopenvrml/openvrml/script.cpp,v
retrieving revision 1.76
retrieving revision 1.77
diff -C2 -d -r1.76 -r1.77
*** script.cpp	2 Aug 2006 21:06:22 -0000	1.76
--- script.cpp	6 Aug 2006 06:45:24 -0000	1.77
***************
*** 1376,1382 ****
  
  /**
!  * @brief The eventOut identifier.
   *
!  * @return the eventOut identifier.
   */
  const std::string
--- 1376,1382 ----
  
  /**
!  * @brief The @c eventOut identifier.
   *
!  * @return the @c eventOut identifier.
   */
  const std::string
***************
*** 1392,1407 ****
   * @var openvrml::script_node::script_node_type openvrml::script_node::type
   *
!  * @brief Type object for the script_node instance.
   *
!  * Script node @link openvrml::node_type node_types@endlink are significantly
!  * different from other @link openvrml::node_type node_types@endlink. While
!  * most @link openvrml::node_type node_types@endlink are shared by the node
!  * instances they spawn, the script_node_type is unique to a script_node
!  * instance, and it shares the script_node's lifetime. This reflects the fact
!  * that Script nodes in VRML get their functionality by the addition of fields,
!  * eventIns, and eventOuts on a per-instance basis.
   *
!  * For script_node instances, node::node_type is an alias for the
!  * script_node_type object.
   */
  
--- 1392,1407 ----
   * @var openvrml::script_node::script_node_type openvrml::script_node::type
   *
!  * @brief Type object for the @c script_node instance.
   *
!  * Script @c node @c node_type%s are significantly different from other
!  * @c node_type%s.  While most @c node_types are shared by the @c node
!  * instances they spawn, the @c script_node_type is unique to a @c script_node
!  * instance, and it shares the <code>script_node</code>'s lifetime.  This
!  * reflects the fact that Script @c node%s in VRML get their functionality by
!  * the addition of @c field%s, @c eventIn%s, and @c eventOut%s on a
!  * per-instance basis.
   *
!  * For @c script_node instances, @c node::node_type is an alias for the
!  * @c script_node_type object.
   */
  
***************
*** 1507,1533 ****
   *
   * Unlike other concrete node types, which are always instantiated via
!  * <code>node_type::create_node</code>, the <code>script_node</code>
!  * constructor is called directly when creating a new <code>script_node</code>
!  * from scratch.  However, a <code>script_node</code> can be duplicated (or
!  * "cloned") by calling <code>node_type::create_node</code> on
!  * <code>script_node::type</code> of a <code>script_node</code> instance.  This
!  * provides a consistent interface for cloning any node, regardless of its
!  * type.  OpenVRML uses this internally when instantiating <code>PROTO</code>s.
   *
!  * @param[in] class_            the <code>script_node_metatype</code>.  Typically
!  *                          there is one <code>script_node_metatype</code> per
!  *                          browser instance.
!  * @param[in] scope             the <code>scope</code> to which the node should
!  *                          belong.
!  * @param[in] interfaces        a <code>node_interface_set</code> containing
!  *                          specifications of user-defined fields, eventIns,
!  *                          and eventOuts particular to the
!  *                          <code>script_node</code> instance.
!  * @param[in] initial_values    a map of initial values for fields of the
!  *                          <code>script_node</code>.
   *
   * @exception unsupported_interface if @p initial_values specifies a field that
!  *                                  is not supported by the
!  *                                  <code>script_node</code>.
   * @exception std::bad_cast         if @p initial_values includes a field value
   *                                  that is the wrong type for the specified
--- 1507,1532 ----
   *
   * Unlike other concrete node types, which are always instantiated via
!  * @c node_type::create_node, the @c script_node constructor is called
!  * directly when creating a new @c script_node from scratch.  However, a
!  * @c script_node can be duplicated (or &ldquo;cloned&rdquo;) by calling
!  * @c node_type::create_node on @c script_node::type of a @c script_node
!  * instance.  This provides a consistent interface for cloning any node,
!  * regardless of its type.  OpenVRML uses this internally when instantiating
!  * @c PROTO%s.
   *
!  * @param[in] class_            the @c script_node_metatype.  Typically
!  *                              there is one @c script_node_metatype per
!  *                              browser instance.
!  * @param[in] scope             the @c scope to which the node should
!  *                              belong.
!  * @param[in] interfaces        a @c node_interface_set containing
!  *                              specifications of user-defined @c field%s,
!  *                              @c eventIn%s, and @c eventOut%s particular to
!  *                              the @c script_node instance.
!  * @param[in] initial_values    a map of initial values for @c field%s of the
!  *                              @c script_node.
   *
   * @exception unsupported_interface if @p initial_values specifies a field that
!  *                                  is not supported by the @c script_node.
   * @exception std::bad_cast         if @p initial_values includes a field value
   *                                  that is the wrong type for the specified
***************
*** 1535,1543 ****
   * @exception std::bad_alloc        if memory allocation fails.
   * @exception std::invalid_argument if:
!  *                                  - @p interfaces includes an exposedField
   *                                    specification.
   *                                  - @p interfaces includes an interface
   *                                    specification that duplicates an existing
!  *                                    Script node interface.
   *                                  - @p initial_values is missing an initial
   *                                    value for a user-defined field in
--- 1534,1542 ----
   * @exception std::bad_alloc        if memory allocation fails.
   * @exception std::invalid_argument if:
!  *                                  - @p interfaces includes an @c exposedField
   *                                    specification.
   *                                  - @p interfaces includes an interface
   *                                    specification that duplicates an existing
!  *                                    Script @c node interface.
   *                                  - @p initial_values is missing an initial
   *                                    value for a user-defined field in
***************
*** 1751,1757 ****
   *        Script nodes can be self referential.
   *
!  * "Undo" the refcounting appropriately: decrement the refcount on any
!  * self-references we acquire ownership of, and increment the refcount on any
!  * self-references for which ownership is relinquished.
   *
   * @param[in]  inval    input sfnode.
--- 1750,1756 ----
   *        Script nodes can be self referential.
   *
!  * &ldquo;Undo&rdquo; the refcounting appropriately: decrement the refcount on
!  * any self-references we acquire ownership of and increment the refcount on
!  * any self-references for which ownership is relinquished.
   *
   * @param[in]  inval    input sfnode.
***************
*** 1799,1805 ****
   *        Script nodes can be self referential.
   *
!  * "Undo" the refcounting appropriately: decrement the refcount on any
!  * self-references we acquire ownership of, and increment the refcount on any
!  * self-references for which ownership is relinquished.
   *
   * @param[in]  inval    input mfnode.
--- 1798,1804 ----
   *        Script nodes can be self referential.
   *
!  * &ldquo;Undo&rdquo; the refcounting appropriately: decrement the refcount on
!  * any self-references we acquire ownership of and increment the refcount on
!  * any self-references for which ownership is relinquished.
   *
   * @param[in]  inval    input mfnode.