[openvrml-commit] openvrml/src/libopenvrml/openvrml browser.cpp,1.99,1.100

SourceForge Headquarters 225 Broadway Suite 1600 San Diego, CA 92101 +1 (858) 422-6466

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

Modified Files:
	browser.cpp 
Log Message:
Doc-comment fixes.

Index: browser.cpp
===================================================================
RCS file: /cvsroot/openvrml/openvrml/src/libopenvrml/openvrml/browser.cpp,v
retrieving revision 1.99
retrieving revision 1.100
diff -C2 -d -r1.99 -r1.100
*** browser.cpp	27 Nov 2005 03:29:37 -0000	1.99
--- browser.cpp	27 Nov 2005 04:06:41 -0000	1.100
***************
*** 341,349 ****
       *
       * Like a typical node implementation, <code>proto_node</code>s have a
!      * many-to-one relationship with the
!      * <code>proto_node::proto_node_type</code> instance that creates them. And
!      * <code>proto_node::proto_node_type</code> has, in turn, a many-to-one
!      * relationship with the <code>proto_node_class</code> instance that
!      * creates them. Unlike a typical node implementation, there will very
       * likely be more than one <code>proto_node_class</code> instance known to
       * the <code>browser</code> instance; there will be one for each
--- 341,348 ----
       *
       * Like a typical node implementation, <code>proto_node</code>s have a
!      * many-to-one relationship with the <code>proto_node_type</code> instance
!      * that creates them. And <code>proto_node_type</code> has, in turn, a
!      * many-to-one relationship with the <code>proto_node_class</code> instance
!      * that creates them. Unlike a typical node implementation, there will very
       * likely be more than one <code>proto_node_class</code> instance known to
       * the <code>browser</code> instance; there will be one for each
***************
*** 351,365 ****
       *
       * As the <code>proto_node_class</code> encodes the data in a
!      * <code>PROTO</code>, the <code>proto_node::proto_node_type</code> can
!      * be seen as modeling <code>EXTERNPROTO</code>. Each
!      * <code>EXTERNPROTO</code> will spawn a new
!      * <code>proto_node::proto_node_type</code> from the
       * <code>proto_node_class</code> that corresponds to the <code>PROTO</code>
       * to which the <code>EXTERNPROTO</code> refers. Recall that an
!      * <code>EXTERNPROTO</code> provides a subset of the interfaces defined
!      * for a <code>PROTO</code>; thus, for a <code>PROTO</code> with
!      * <var>n</var> interfaces, there are <var>n</var>! possible unique
!      * <code>EXTERNPROTO</code>s (and thus unique
!      * <code>proto_node::proto_node_type</code> instances).
       *
       * Structurally, the implementation of <code>proto_node</code> is very
--- 350,363 ----
       *
       * As the <code>proto_node_class</code> encodes the data in a
!      * <code>PROTO</code>, the <code>proto_node_type</code> can be seen as
!      * modeling <code>EXTERNPROTO</code>. Each <code>EXTERNPROTO</code> will
!      * spawn a new <code>proto_node_type</code> from the
       * <code>proto_node_class</code> that corresponds to the <code>PROTO</code>
       * to which the <code>EXTERNPROTO</code> refers. Recall that an
!      * <code>EXTERNPROTO</code> provides a subset of the interfaces defined for
!      * a <code>PROTO</code>; thus, for a <code>PROTO</code> with <var>n</var>
!      * interfaces, there are <var>n</var>! possible unique
!      * <code>EXTERNPROTO</code>s (and thus unique <code>proto_node_type</code>
!      * instances).
       *
       * Structurally, the implementation of <code>proto_node</code> is very
***************
*** 997,1001 ****
       * @internal
       *
!      * @class proto_node::proto_eventin
       *
       * @brief PROTO eventIn handler class template.
--- 995,999 ----
       * @internal
       *
!      * @class abstract_proto_node::proto_eventin
       *
       * @brief PROTO eventIn handler class template.
***************
*** 1003,1007 ****
  
      /**
!      * @typedef proto_node::proto_eventin::listeners
       *
       * @brief Set of event listeners.
--- 1001,1005 ----
  
      /**
!      * @typedef abstract_proto_node::proto_eventin::listeners
       *
       * @brief Set of event listeners.
***************
*** 1009,1013 ****
  
      /**
!      * @var proto_node::proto_eventin::listeners proto_node::proto_eventin::listeners_
       *
       * @brief Set of event listeners to which events are delegated for
--- 1007,1011 ----
  
      /**
!      * @var abstract_proto_node::proto_eventin::listeners proto_node::proto_eventin::listeners_
       *
       * @brief Set of event listeners to which events are delegated for
***************
*** 1016,1020 ****
  
      /**
!      * @typedef proto_node::proto_eventin::field_value_type
       *
       * @brief Field value type.
--- 1014,1018 ----
  
      /**
!      * @typedef abstract_proto_node::proto_eventin::field_value_type
       *
       * @brief Field value type.
***************
*** 1022,1026 ****
  
      /**
!      * @typedef proto_node::proto_eventin::event_listener_type
       *
       * @brief Type of event listeners to which the instance delegates.
--- 1020,1024 ----
  
      /**
!      * @typedef abstract_proto_node::proto_eventin::event_listener_type
       *
       * @brief Type of event listeners to which the instance delegates.
***************
*** 1030,1034 ****
       * @brief Construct.
       *
!      * @param node  proto_node.
       */
      template <typename FieldValue>
--- 1028,1032 ----
       * @brief Construct.
       *
!      * @param node  abstract_proto_node.
       */
      template <typename FieldValue>
***************
*** 1069,1072 ****
--- 1067,1075 ----
      }
  
+     /**
+      * @brief The name of the associated eventIn.
+      *
+      * @return the name of the associated eventIn.
+      */
      template <typename FieldValue>
      const std::string
***************
*** 1108,1112 ****
       * @param node  proto_node.
       *
!      * @return a boost::shared_ptr to a proto_eventout<FieldValue> instance.
       *
       * @exception std::bad_alloc    if memory allocation fails.
--- 1111,1115 ----
       * @param node  proto_node.
       *
!      * @return a boost::shared_ptr to a proto_eventin<FieldValue> instance.
       *
       * @exception std::bad_alloc    if memory allocation fails.
***************
*** 1203,1216 ****
  
      /**
!      * @brief Create an IS mapping between an event_listener in the PROTO
!      *        implementation and an event_listener in the PROTO interface.
       *
       * @param field_type        field value type of the concrete listeners.
!      * @param impl_eventin      event_listener of a node in the PROTO
       *                          implementation.
!      * @param interface_eventin event_listener from the PROTO interface.
       *
!      * @return @c true if the IS mapping is established successfully; @c false
!      *         otherwise (i.e., if the mapping already exists).
       *
       * @exception std::bad_alloc    if memory allocation fails.
--- 1206,1220 ----
  
      /**
!      * @brief Create an @c IS mapping between an @c event_listener in the
!      *        @c PROTO implementation and an @c event_listener in the @c PROTO
!      *        interface.
       *
       * @param field_type        field value type of the concrete listeners.
!      * @param impl_eventin      @c event_listener of a node in the @c PROTO
       *                          implementation.
!      * @param interface_eventin @c event_listener from the @c PROTO interface.
       *
!      * @return @c true if the @c IS mapping is established successfully;
!      *         @c false otherwise (i.e., if the mapping already exists).
       *
       * @exception std::bad_alloc    if memory allocation fails.
***************
*** 1374,1378 ****
       * @internal
       *
!      * @class proto_node::proto_eventout::listener_t
       *
       * @brief Listens for events emitted from nodes in the PROTO implementation
--- 1378,1382 ----
       * @internal
       *
!      * @class abstract_proto_node::proto_eventout::listener_t
       *
       * @brief Listens for events emitted from nodes in the PROTO implementation
***************
*** 1381,1385 ****
  
      /**
!      * @var proto_node::proto_eventout & proto_node::proto_eventout::listener_t::emitter
       *
       * @brief Reference to the outer proto_eventout class.
--- 1385,1389 ----
  
      /**
!      * @var abstract_proto_node::proto_eventout & abstract_proto_node::proto_eventout::listener_t::emitter
       *
       * @brief Reference to the outer proto_eventout class.
***************
*** 1392,1402 ****
  
      /**
!      * @var proto_node & proto_node::proto_eventout::listener_t::node
       *
!      * @brief Reference to the proto_node instance.
       */
  
      /**
!      * @var FieldValue proto_node::proto_eventout::listener_t::value
       *
       * @brief The value of the most recently emitted event.
--- 1396,1406 ----
  
      /**
!      * @var abstract_proto_node & abstract_proto_node::proto_eventout::listener_t::node
       *
!      * @brief Reference to the @c abstract_proto_node instance.
       */
  
      /**
!      * @var FieldValue abstract_proto_node::proto_eventout::listener_t::value
       *
       * @brief The value of the most recently emitted event.
***************
*** 1406,1411 ****
       * @brief Construct.
       *
!      * @param emitter       proto_eventout.
!      * @param node          proto_node.
       * @param initial_value initial value (used for exposedFields).
       */
--- 1410,1415 ----
       * @brief Construct.
       *
!      * @param emitter       @c proto_eventout.
!      * @param node          @c abstract_proto_node.
       * @param initial_value initial value (used for exposedFields).
       */
***************
*** 1463,1474 ****
  
      /**
!      * @var proto_node::proto_eventout::listener_t proto_node::proto_eventout::listener
       *
!      * @brief Listens for events emitted from nodes in the PROTO implementation
!      *        in order to propagate them out of the PROTO instance.
       */
  
      /**
!      * @typedef proto_node::proto_eventout<FieldValue>::field_value_type
       *
       * @brief Field value type.
--- 1467,1479 ----
  
      /**
!      * @var abstract_proto_node::proto_eventout::listener_t proto_node::proto_eventout::listener
       *
!      * @brief Listens for events emitted from nodes in the @c PROTO
!      *        implementation in order to propagate them out of the @c PROTO
!      *        instance.
       */
  
      /**
!      * @typedef abstract_proto_node::proto_eventout<FieldValue>::field_value_type
       *
       * @brief Field value type.
***************
*** 1476,1480 ****
  
      /**
!      * @typedef proto_node::proto_eventout<FieldValue>::event_emitter_type
       *
       * @brief Event emitter type.
--- 1481,1485 ----
  
      /**
!      * @typedef abstract_proto_node::proto_eventout<FieldValue>::event_emitter_type
       *
       * @brief Event emitter type.
***************
*** 1482,1486 ****
  
      /**
!      * @typedef proto_node::proto_eventout<FieldValue>::event_listener_type
       *
       * @brief Event listener type.
--- 1487,1491 ----
  
      /**
!      * @typedef abstract_proto_node::proto_eventout<FieldValue>::event_listener_type
       *
       * @brief Event listener type.
***************
*** 1490,1496 ****
       * @brief Construct.
       *
!      * @param node          proto_node.
       * @param initial_value initial value.  This is used by
!      *                      proto_exposedfield<FieldValue>
       */
      template <typename FieldValue>
--- 1495,1501 ----
       * @brief Construct.
       *
!      * @param node          @c abstract_proto_node.
       * @param initial_value initial value.  This is used by
!      *                      @c proto_exposedfield<FieldValue>
       */
      template <typename FieldValue>
***************
*** 1511,1520 ****
  
      /**
!      * @brief Create an IS mapping.
       *
!      * @param emitter   the event_emitter from a node in the PROTO
       *                  implementation.
       *
!      * @return @c true if the IS mapping is created successfully; @c false
       *         otherwise (i.e., if it already exists).
       *
--- 1516,1525 ----
  
      /**
!      * @brief Create an @c IS mapping.
       *
!      * @param emitter   the @c event_emitter from a node in the @c PROTO
       *                  implementation.
       *
!      * @return @c true if the @c IS mapping is created successfully; @c false
       *         otherwise (i.e., if it already exists).
       *
***************
*** 1529,1532 ****
--- 1534,1542 ----
      }
  
+     /**
+      * @brief The name of the associated eventOut.
+      *
+      * @return the name of the associated eventOut.
+      */
      template <typename FieldValue>
      const std::string
***************
*** 1543,1552 ****
  
      /**
!      * @brief Factory function for proto_eventout<FieldValue> instances.
       *
!      * @param type  field_value::type_id.
!      * @param node  proto_node.
       *
!      * @return a boost::shared_ptr to a proto_eventout<FieldValue> instance.
       *
       * @exception std::bad_alloc    if memory allocation fails.
--- 1553,1563 ----
  
      /**
!      * @brief Factory function for @c proto_eventout<FieldValue> instances.
       *
!      * @param type  @c field_value::type_id.
!      * @param node  @c abstract_proto_node.
       *
!      * @return a @c boost::shared_ptr to a @c proto_eventout<FieldValue>
!      *         instance.
       *
       * @exception std::bad_alloc    if memory allocation fails.
***************
*** 1646,1659 ****
  
      /**
!      * @brief Create an IS mapping between an event_emitter in the PROTO
!      *        implementation and an event_emitter in the PROTO interface.
       *
       * @param field_type            field value type of the concrete emitters.
!      * @param impl_eventout         event_emitter of a node in the PROTO
       *                              implementation.
!      * @param interface_eventout    event_emitter from the PROTO interface.
       *
!      * @return @c true if the IS mapping is established successfully; @c false
!      *         otherwise (i.e., if the mapping already exists).
       *
       * @exception std::bad_alloc    if memory allocation fails.
--- 1657,1672 ----
  
      /**
!      * @brief Create an @c IS mapping between an @c event_emitter in the
!      *        @c PROTO implementation and an @c event_emitter in the @c PROTO
!      *        interface.
       *
       * @param field_type            field value type of the concrete emitters.
!      * @param impl_eventout         @c event_emitter of a node in the @c PROTO
       *                              implementation.
!      * @param interface_eventout    @c event_emitter from the @c PROTO
!      *                              interface.
       *
!      * @return @c true if the @c IS mapping is established successfully;
!      *         @c false otherwise (i.e., if the mapping already exists).
       *
       * @exception std::bad_alloc    if memory allocation fails.