[openvrml-commit] openvrml/src/libopenvrml/openvrml node.cpp,1.66,1.67

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-serv21842/src/libopenvrml/openvrml

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

Index: node.cpp
===================================================================
RCS file: /cvsroot/openvrml/openvrml/src/libopenvrml/openvrml/node.cpp,v
retrieving revision 1.66
retrieving revision 1.67
diff -C2 -d -r1.66 -r1.67
*** node.cpp	15 Nov 2005 00:30:21 -0000	1.66
--- node.cpp	21 Nov 2005 06:07:09 -0000	1.67
***************
*** 316,326 ****
   * @ingroup nodes
   *
!  * @brief Determine if a node_interface matches an eventIn identifier.
   *
   * @par Model of
   * <a href="http://www.sgi.com/tech/stl/AdaptableBinaryPredicate.html">
!  * AdaptableBinaryPredicate</a>,
   * <a href="http://www.sgi.com/tech/stl/DefaultConstructible.html">
!  * DefaultConstructible</a>
   */
  
--- 316,327 ----
   * @ingroup nodes
   *
!  * @brief Determine if a <code>node_interface</code> matches an eventIn
!  *        identifier.
   *
   * @par Model of
   * <a href="http://www.sgi.com/tech/stl/AdaptableBinaryPredicate.html">
!  * Adaptable Binary Predicate</a>,
   * <a href="http://www.sgi.com/tech/stl/DefaultConstructible.html">
!  * Default Constructible</a>
   */
  
***************
*** 328,344 ****
   * @fn openvrml::node_interface_matches_eventin::result_type openvrml::node_interface_matches_eventin::operator()(const first_argument_type & interface, const second_argument_type & eventin_id) const
   *
!  * @brief Determine if a node_interface matches an eventIn identifier.
   *
   * A node_interface matches an eventIn identifier if:
!  * - the node_interface's @a type is node_interface::eventin_id and
!  *   - the node_interface's @a id is lexicographically equal to the eventIn
!  *     identifier
!  *   - or the node_interface's @a id is lexicographically equal to the eventIn
!  *     identifier with the string &ldquo;set_&rdquo; prepended.
!  * - or, the node_interface's @a type is node_interface::exposedfield_id and
!  *   - the node_interface's @a id is lexicographically equal to the eventIn
!  *     identifier
!  *   - or the node_interface's @a id with the string &ldquo;set_&rdquo;
!  *     prepended is lexicographically equal to the eventIn identifier.
   *
   * @param interface     node_interface.
--- 329,349 ----
   * @fn openvrml::node_interface_matches_eventin::result_type openvrml::node_interface_matches_eventin::operator()(const first_argument_type & interface, const second_argument_type & eventin_id) const
   *
!  * @brief Determine if a <code>node_interface</code> matches an eventIn
!  *        identifier.
   *
   * A node_interface matches an eventIn identifier if:
!  * - the <code>node_interface</code>'s @a type is node_interface::eventin_id
!  *   and
!  *   - the <code>node_interface</code>'s @a id is lexicographically equal to
!  *     the eventIn identifier
!  *   - or the <code>node_interface</code>'s @a id is lexicographically equal to
!  *     the eventIn identifier with the string &ldquo;set_&rdquo; prepended.
!  * - or, the <code>node_interface</code>'s @a type is
!  *     <code>node_interface::exposedfield_id</code> and
!  *   - the <code>node_interface</code>'s @a id is lexicographically equal to
!  *     the eventIn identifier
!  *   - or the <code>node_interface</code>'s @a id with the string
!  *     &ldquo;set_&rdquo; prepended is lexicographically equal to the eventIn
!  *     identifier.
   *
   * @param interface     node_interface.
***************
*** 354,364 ****
   * @ingroup nodes
   *
!  * @brief Determine if a node_interface matches an eventOut identifier.
   *
   * @par Model of
   * <a href="http://www.sgi.com/tech/stl/AdaptableBinaryPredicate.html">
!  * AdaptableBinaryPredicate</a>,
   * <a href="http://www.sgi.com/tech/stl/DefaultConstructible.html">
!  * DefaultConstructible</a>
   */
  
--- 359,370 ----
   * @ingroup nodes
   *
!  * @brief Determine if a <code>node_interface</code> matches an eventOut
!  *        identifier.
   *
   * @par Model of
   * <a href="http://www.sgi.com/tech/stl/AdaptableBinaryPredicate.html">
!  * Adaptable Binary Predicate</a>,
   * <a href="http://www.sgi.com/tech/stl/DefaultConstructible.html">
!  * Default Constructible</a>
   */
  
***************
*** 366,382 ****
   * @fn openvrml::node_interface_matches_eventout::result_type openvrml::node_interface_matches_eventout::operator()(const first_argument_type & interface, const second_argument_type & eventout_id) const
   *
!  * @brief Determine if a node_interface matches an eventOut identifier.
   *
!  * A node_interface matches an eventOut identifier if:
!  * - the node_interface's @a type is node_interface::eventout_id and
!  *   - the node_interface's @a id is lexicographically equal to the eventOut
!  *     identifier
!  *   - or the node_interface's @a id is lexicographically equal to the eventOut
!  *     identifier with the string &ldquo;_changed&rdquo; appended.
!  * - or, the node_interface's @a type is node_interface::exposedfield_id and
!  *   - the node_interface's @a id is lexicographically equal to the eventOut
!  *     identifier
!  *   - or the node_interface's @a id with the string &ldquo;_changed&rdquo;
!  *     appended is lexicographically equal to the eventOut identifier.
   *
   * @param interface     node_interface.
--- 372,392 ----
   * @fn openvrml::node_interface_matches_eventout::result_type openvrml::node_interface_matches_eventout::operator()(const first_argument_type & interface, const second_argument_type & eventout_id) const
   *
!  * @brief Determine if a <code>node_interface</code> matches an eventOut
!  *        identifier.
   *
!  * A <code>node_interface</code> matches an eventOut identifier if:
!  * - the <code>node_interface</code>'s @a type is
!  *   <code>node_interface::eventout_id</code> and
!  *   - the <code>node_interface</code>'s @a id is lexicographically equal to
!  *     the eventOut identifier
!  *   - or the <code>node_interface</code>'s @a id is lexicographically equal to
!  *     the eventOut identifier with the string &ldquo;_changed&rdquo; appended.
!  * - or, the <code>node_interface</code>'s @a type is
!  *     <code>node_interface::exposedfield_id</code> and
!  *   - the <code>node_interface</code>'s @a id is lexicographically equal to
!  *     the eventOut identifier
!  *   - or the <code>node_interface</code>'s @a id with the string
!  *     &ldquo;_changed&rdquo; appended is lexicographically equal to the
!  *     eventOut identifier.
   *
   * @param interface     node_interface.
***************
*** 397,403 ****
   * @par Model of
   * <a href="http://www.sgi.com/tech/stl/AdaptableBinaryPredicate.html">
!  * AdaptableBinaryPredicate</a>,
   * <a href="http://www.sgi.com/tech/stl/DefaultConstructible.html">
!  * DefaultConstructible</a>
   */
  
--- 407,413 ----
   * @par Model of
   * <a href="http://www.sgi.com/tech/stl/AdaptableBinaryPredicate.html">
!  * Adaptable Binary Predicate</a>,
   * <a href="http://www.sgi.com/tech/stl/DefaultConstructible.html">
!  * Default Constructible</a>
   */
  
***************
*** 405,409 ****
   * @fn openvrml::node_interface_matches_exposedfield::result_type openvrml::node_interface_matches_exposedfield::operator()(const first_argument_type & interface, const second_argument_type & exposedfield_id) const
   *
!  * @brief Determine if a node_interface matches an exposedField identifier.
   *
   * A <code>node_interface</code> matches an exposedField identifier if the
--- 415,420 ----
   * @fn openvrml::node_interface_matches_exposedfield::result_type openvrml::node_interface_matches_exposedfield::operator()(const first_argument_type & interface, const second_argument_type & exposedfield_id) const
   *
!  * @brief Determine if a <code>node_interface</code> matches an exposedField
!  *        identifier.
   *
   * A <code>node_interface</code> matches an exposedField identifier if the
***************
*** 431,437 ****
   * @par Model of
   * <a href="http://www.sgi.com/tech/stl/AdaptableBinaryPredicate.html">
!  * AdaptableBinaryPredicate</a>,
   * <a href="http://www.sgi.com/tech/stl/DefaultConstructible.html">
!  * DefaultConstructible</a>
   */
  
--- 442,448 ----
   * @par Model of
   * <a href="http://www.sgi.com/tech/stl/AdaptableBinaryPredicate.html">
!  * Adaptable Binary Predicate</a>,
   * <a href="http://www.sgi.com/tech/stl/DefaultConstructible.html">
!  * Default Constructible</a>
   */
  
***************
*** 439,447 ****
   * @fn openvrml::node_interface_matches_field::result_type openvrml::node_interface_matches_field::operator()(const first_argument_type & interface, const second_argument_type & field_id) const
   *
!  * @brief Determine if a node_interface matches an field identifier.
   *
!  * A node_interface matches a field identifier if the node_interface's @a type
!  * is node_interface::field_id or node_interface::exposedfield_id and the
!  * node_interface's @a id is lexicographically equal to the field identifier.
   *
   * @param interface node_interface.
--- 450,462 ----
   * @fn openvrml::node_interface_matches_field::result_type openvrml::node_interface_matches_field::operator()(const first_argument_type & interface, const second_argument_type & field_id) const
   *
!  * @brief Determine if a <code>node_interface</code> matches an field
!  *        identifier.
   *
!  * A <code>node_interface</code> matches a field identifier if the
!  * <code>node_interface</code>'s @a type is
!  * <code>node_interface::field_id</code> or
!  * <code>node_interface::exposedfield_id</code> and the
!  * <code>node_interface</code>'s @a id is lexicographically equal to the field
!  * identifier.
   *
   * @param interface node_interface.
***************
*** 462,471 ****
   * <code>node_interface_compare</code> provides a
   * <a href="http://www.sgi.com/tech/stl/StrictWeakOrdering.html">
!  * StrictWeakOrdering</a> for <code>node_interface</code>s and ensures that
   * exposedField definitions appropriately encroach on the namespace of eventIn
   * and eventOut definitions. That is, per 4.7 of the VRML97 spec: &rdquo;An
!  * exposedField named zzz can be referred to as &lsquo;set_zzz&rsquo; and
!  * treated as an eventIn, and can be referred to as &lsquo;zzz_changed&rsquo;
!  * and treated as an eventOut.&rdquo;
   *
   * <code>node_interface_compare</code> is the comparator used by
--- 477,486 ----
   * <code>node_interface_compare</code> provides a
   * <a href="http://www.sgi.com/tech/stl/StrictWeakOrdering.html">
!  * Strict Weak Ordering</a> for <code>node_interface</code>s and ensures that
   * exposedField definitions appropriately encroach on the namespace of eventIn
   * and eventOut definitions. That is, per 4.7 of the VRML97 spec: &rdquo;An
!  * exposedField named &lsquo;zzz@rsquo; can be referred to as
!  * &lsquo;set_zzz&rsquo; and treated as an eventIn, and can be referred to as
!  * &lsquo;zzz_changed&rsquo; and treated as an eventOut.&rdquo;
   *
   * <code>node_interface_compare</code> is the comparator used by
***************
*** 474,482 ****
   * @par Model of
   * <a href="http://www.sgi.com/tech/stl/AdaptableBinaryPredicate.html">
!  * AdaptableBinaryPredicate</a>,
   * <a href="http://www.sgi.com/tech/stl/StrictWeakOrdering.html">
!  * StrictWeakOrdering</a>,
   * <a href="http://www.sgi.com/tech/stl/DefaultConstructible.html">
!  * DefaultConstructible</a>
   *
   * @see node_interface_set
--- 489,497 ----
   * @par Model of
   * <a href="http://www.sgi.com/tech/stl/AdaptableBinaryPredicate.html">
!  * Adaptable Binary Predicate</a>,
   * <a href="http://www.sgi.com/tech/stl/StrictWeakOrdering.html">
!  * Strict Weak Ordering</a>,
   * <a href="http://www.sgi.com/tech/stl/DefaultConstructible.html">
!  * Default Constructible</a>
   *
   * @see node_interface_set