[openvrml-commit] openvrml/src/libopenvrml/openvrml script.cpp, 1.75, 1.76

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-cvs3.sourceforge.net:/tmp/cvs-serv21126/src/libopenvrml/openvrml

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

Index: script.cpp
===================================================================
RCS file: /cvsroot/openvrml/openvrml/src/libopenvrml/openvrml/script.cpp,v
retrieving revision 1.75
retrieving revision 1.76
diff -C2 -d -r1.75 -r1.76
*** script.cpp	30 Jul 2006 05:52:27 -0000	1.75
--- script.cpp	2 Aug 2006 21:06:22 -0000	1.76
***************
*** 1,3 ****
! // -*- Mode: C++; indent-tabs-mode: nil; c-basic-offset: 4; -*-
  //
  // OpenVRML
--- 1,3 ----
! // -*- Mode: C++; indent-tabs-mode: nil; c-basic-offset: 4; fill-column: 78 -*-
  //
  // OpenVRML
***************
*** 80,84 ****
   * @brief Initialize the Script node.
   *
!  * Delegates to <code>script::do_initialize</code>.
   *
   * @param[in] timestamp the current time.
--- 80,84 ----
   * @brief Initialize the Script node.
   *
!  * Delegates to @c script::do_initialize.
   *
   * @param[in] timestamp the current time.
***************
*** 101,105 ****
   * @brief Process an event.
   *
!  * Delegates to <code>script::do_process_event</code>.
   *
   * @param[in] id        eventIn identifier.
--- 101,105 ----
   * @brief Process an event.
   *
!  * Delegates to @c script::do_process_event.
   *
   * @param[in] id        eventIn identifier.
***************
*** 120,124 ****
   * @brief Process an event.
   *
!  * @param[in] id        eventIn identifier.
   * @param[in] value     event value.
   * @param[in] timestamp the current time.
--- 120,124 ----
   * @brief Process an event.
   *
!  * @param[in] id        @c eventIn identifier.
   * @param[in] value     event value.
   * @param[in] timestamp the current time.
***************
*** 128,132 ****
   * @brief Execute script code after processing events.
   *
!  * Delegates to <code>script::do_events_processed</code>.
   *
   * @param[in] timestamp the current time.
--- 128,132 ----
   * @brief Execute script code after processing events.
   *
!  * Delegates to @c script::do_events_processed.
   *
   * @param[in] timestamp the current time.
***************
*** 216,221 ****
   *        execution.
   *
!  * @param[in] listener  the <code>event_listener</code> to which the event should
!  *                  be sent.
   * @param[in] value     the value to send.
   *
--- 216,221 ----
   *        execution.
   *
!  * @param[in] listener  the @c event_listener to which the event should be
!  *                      sent.
   * @param[in] value     the value to send.
   *
***************
*** 294,300 ****
   * @class openvrml::script_node_metatype
   *
!  * @brief Class object for <code>script_node</code>s.
   *
!  * There is one script_node_metatype per browser instance.
   *
   * @see browser::scriptNodeClass
--- 294,300 ----
   * @class openvrml::script_node_metatype
   *
!  * @brief Class object for @c script_node%s.
   *
!  * There is one @c script_node_metatype per browser instance.
   *
   * @see browser::scriptNodeClass
***************
*** 322,326 ****
   * This method is not implemented because the Script node implementation,
   * unlike other node implementations, cannot provide the implementation of
!  * an @c EXTERNPROTO. It is an error to call this method.
   */
  const boost::shared_ptr<openvrml::node_type>
--- 322,326 ----
   * This method is not implemented because the Script node implementation,
   * unlike other node implementations, cannot provide the implementation of
!  * an @c EXTERNPROTO.  It is an error to call this method.
   */
  const boost::shared_ptr<openvrml::node_type>
***************
*** 349,353 ****
   * @typedef openvrml::script_node::field_value_map_t
   *
!  * @brief A std::map that keys field values on their field name.
   */
  
--- 349,353 ----
   * @typedef openvrml::script_node::field_value_map_t
   *
!  * @brief A @c std::map that keys field values on their field name.
   */
  
***************
*** 355,359 ****
   * @class openvrml::script_node::eventout
   *
!  * @brief An event_emitter along with the emitted value.
   */
  
--- 355,359 ----
   * @class openvrml::script_node::eventout
   *
!  * @brief An @c event_emitter along with the emitted value.
   */
  
***************
*** 361,365 ****
   * @var openvrml::script_node & openvrml::script_node::eventout::node_
   *
!  * @brief The containing script_node.
   */
  
--- 361,365 ----
   * @var openvrml::script_node & openvrml::script_node::eventout::node_
   *
!  * @brief The containing @c script_node.
   */
  
***************
*** 386,390 ****
   *
   * @param[in] type  field value type identifier.
!  * @param[in] node  script_node.
   *
   * @exception std::bad_alloc    if memory allocation fails.
--- 386,390 ----
   *
   * @param[in] type  field value type identifier.
!  * @param[in] node  @c script_node.
   *
   * @exception std::bad_alloc    if memory allocation fails.
***************
*** 400,406 ****
  
  /**
!  * @brief The value that will be sent from the eventOut.
   *
!  * @return the value that will be sent from the eventOut.
   */
  const openvrml::field_value & openvrml::script_node::eventout::value() const
--- 400,406 ----
  
  /**
!  * @brief The value that will be sent from the @c eventOut.
   *
!  * @return the value that will be sent from the @c eventOut.
   */
  const openvrml::field_value & openvrml::script_node::eventout::value() const
***************
*** 411,418 ****
  
  /**
!  * @brief Set the value that will be sent from the eventOut.
   *
!  * After calling this function, modified will return @c true until emit_event
!  * is called.
   *
   * @param[in] val   field value.
--- 411,418 ----
  
  /**
!  * @brief Set the value that will be sent from the @c eventOut.
   *
!  * After calling this function, modified will return @c true until
!  * @c emit_event is called.
   *
   * @param[in] val   field value.
***************
*** 445,449 ****
   * @brief Whether the value has been modified.
   *
!  * @return @c true if the value has been changed since emit_event was last
   *         called; @c false otherwise.
   */
--- 445,449 ----
   * @brief Whether the value has been modified.
   *
!  * @return @c true if the value has been changed since @c emit_event was last
   *         called; @c false otherwise.
   */
***************
*** 454,460 ****
  
  /**
!  * @brief The event_emitter associated with the eventout.
   *
!  * @return the event_emitter associated with the eventout.
   */
  openvrml::event_emitter & openvrml::script_node::eventout::emitter()
--- 454,460 ----
  
  /**
!  * @brief The @c event_emitter associated with the @c eventout.
   *
!  * @return the @c event_emitter associated with the @c eventout.
   */
  openvrml::event_emitter & openvrml::script_node::eventout::emitter()
***************
*** 465,472 ****
  
  /**
!  * @brief Cause the contained event_emitter to emit an event.
   *
   * Events should be emitted from Script nodes by calling this function instead
!  * of passing the event_emitter directly to node::emit_event.
   *
   * @param[in] timestamp the current time.
--- 465,472 ----
  
  /**
!  * @brief Cause the contained @c event_emitter to emit an event.
   *
   * Events should be emitted from Script nodes by calling this function instead
!  * of passing the @c event_emitter directly to @c node::emit_event.
   *
   * @param[in] timestamp the current time.
***************
*** 484,488 ****
   * @typedef openvrml::script_node::eventout_ptr
   *
!  * @brief Reference-counted smart pointer to an eventout.
   */
  
--- 484,488 ----
   * @typedef openvrml::script_node::eventout_ptr
   *
!  * @brief Reference-counted smart pointer to an @c eventout.
   */
  
***************
*** 490,494 ****
   * @typedef openvrml::script_node::eventout_map_t
   *
!  * @brief Map of eventout instances.
   */
  
--- 490,494 ----
   * @typedef openvrml::script_node::eventout_map_t
   *
!  * @brief Map of @c eventout instances.
   */
  
***************
*** 498,502 ****
   * @class openvrml::script_node::script_node_type
   *
!  * @brief Type objects for @link script_node script_nodes@endlink.
   *
   * @see script_node::type
--- 498,502 ----
   * @class openvrml::script_node::script_node_type
   *
!  * @brief Type objects for @c script_node%s.
   *
   * @see script_node::type
***************
*** 512,516 ****
  
      //
!     // The order of the node_interfaces in this array is significant. This
      // range is used with std::set_difference, so the elements *must* be in
      // lexicographically increasing order according to their "id" member.
--- 512,516 ----
  
      //
!     // The order of the node_interfaces in this array is significant.  This
      // range is used with std::set_difference, so the elements *must* be in
      // lexicographically increasing order according to their "id" member.
***************
*** 536,540 ****
   * @brief Construct.
   *
!  * @param[in] class_    the node_metatype for @link script_node script_nodes@endlink.
   */
  openvrml::script_node::script_node_type::
--- 536,540 ----
   * @brief Construct.
   *
!  * @param[in] class_    the @c node_metatype for @c script_node%s.
   */
  openvrml::script_node::script_node_type::
***************
*** 561,565 ****
   *
   * @exception std::bad_alloc        if memory allocation fails.
!  * @exception std::invalid_argument if the script_node_type already has an
   *                                  interface that conflicts with @p interface.
   */
--- 561,565 ----
   *
   * @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.
   */
***************
*** 577,583 ****
  
  /**
!  * @brief Get the interfaces for the node.
   *
!  * @return the interfaces for the node.
   */
  const openvrml::node_interface_set &
--- 577,583 ----
  
  /**
!  * @brief Get the interfaces for the @c node.
   *
!  * @return the interfaces for the @c node.
   */
  const openvrml::node_interface_set &
***************
*** 589,602 ****
  
  /**
!  * @brief Clone the Script node that has this node_type.
   *
!  * Since the node_type for a script_node is only available once a script_node
!  * is instantiated, you have to have a script_node instance in order to be able
!  * to use this method. The "primordial" script_node instance must be created
!  * with a call to the script_node constructor.
   *
   * @param[in] scope             the scope to which the node should belong.
!  * @param[in] initial_values    a map of initial values for the node's fields and
!  *                          exposedFields.
   *
   * @exception unsupported_interface if @p initial_values specifies a field
--- 589,603 ----
  
  /**
!  * @brief Clone the Script node that has this @c node_type.
   *
!  * Since the @c node_type for a @c script_node is only available once a
!  * @c script_node is instantiated, you have to have a @c script_node instance
!  * in order to be able to use this method.  The &ldquo;primordial&rdquo;
!  * @c script_node instance must be created with a call to the
!  * @c script_node constructor.
   *
   * @param[in] scope             the scope to which the node should belong.
!  * @param[in] initial_values    a map of initial values for the node's
!  *                              @c field%s and @c exposedField%s.
   *
   * @exception unsupported_interface if @p initial_values specifies a field
***************
*** 680,684 ****
   * @var const std::string openvrml::script_node::script_event_listener::id
   *
!  * @brief eventIn identifier.
   */
  
--- 681,685 ----
   * @var const std::string openvrml::script_node::script_event_listener::id
   *
!  * @brief @c eventIn identifier.
   */
  
***************
*** 686,691 ****
   * @brief Construct.
   *
!  * @param[in] id    eventIn identifier.
!  * @param[in] node  script_node.
   */
  template <typename FieldValue>
--- 687,692 ----
   * @brief Construct.
   *
!  * @param[in] id    @c eventIn identifier.
!  * @param[in] node  @c script_node.
   */
  template <typename FieldValue>
***************
*** 707,713 ****
  
  /**
!  * @brief The associated eventIn identifier.
   *
!  * @return the associated eventIn identifier.
   */
  template <typename FieldValue>
--- 708,714 ----
  
  /**
!  * @brief The associated @c eventIn identifier.
   *
!  * @return the associated @c eventIn identifier.
   */
  template <typename FieldValue>
***************
*** 771,775 ****
   * @typedef openvrml::script_node::sfcolorrgba_listener
   *
!  * @brief sfcolorrgba event listener.
   */
  
--- 772,776 ----
   * @typedef openvrml::script_node::sfcolorrgba_listener
   *
!  * @brief @c sfcolorrgba event listener.
   */
  
***************
*** 867,871 ****
   * @typedef openvrml::script_node::mfbool_listener
   *
!  * @brief mfbool event listener.
   */
  
--- 868,872 ----
   * @typedef openvrml::script_node::mfbool_listener
   *
!  * @brief @c mfbool event listener.
   */
  
***************
*** 891,895 ****
   * @typedef openvrml::script_node::mfcolorrgba_listener
   *
!  * @brief mfcolorrgba event listener.
   */
  
--- 892,896 ----
   * @typedef openvrml::script_node::mfcolorrgba_listener
   *
!  * @brief @c mfcolorrgba event listener.
   */
  
***************
*** 907,911 ****
   * @typedef openvrml::script_node::mfimage_listener
   *
!  * @brief mfimage event listener.
   */
  
--- 908,912 ----
   * @typedef openvrml::script_node::mfimage_listener
   *
!  * @brief @c mfimage event listener.
   */
  
***************
*** 1112,1118 ****
  
  /**
!  * @brief The eventOut identifier.
   *
!  * @return the eventOut identifier.
   */
  template <typename FieldValue>
--- 1113,1119 ----
  
  /**
!  * @brief The @c eventOut identifier.
   *
!  * @return the @c eventOut identifier.
   */
  template <typename FieldValue>
***************
*** 1128,1132 ****
      return pos->first;
  }
!     
  /**
   * @internal
--- 1129,1133 ----
      return pos->first;
  }
! 
  /**
   * @internal
***************
*** 1168,1172 ****
   * @brief Create a Script node event emitter.
   *
!  * @param[in] node  the containing <code>script_node</code>.
   * @param[in] value the node field value associated with the emitter.
   *
--- 1169,1173 ----
   * @brief Create a Script node event emitter.
   *
!  * @param[in] node  the containing @c script_node.
   * @param[in] value the node field value associated with the emitter.
   *
***************
*** 1194,1198 ****
   * @class openvrml::script_node::set_url_listener_t
   *
!  * @brief set_url event listener.
   */
  
--- 1195,1199 ----
   * @class openvrml::script_node::set_url_listener_t
   *
!  * @brief @c set_url event listener.
   */
  
***************
*** 1200,1204 ****
   * @brief Construct.
   *
!  * @param[in] node  a reference to the containing script_node.
   */
  openvrml::script_node::set_url_listener_t::
--- 1201,1205 ----
   * @brief Construct.
   *
!  * @param[in] node  a reference to the containing @c script_node.
   */
  openvrml::script_node::set_url_listener_t::
***************
*** 1215,1221 ****
  
  /**
!  * @brief Get the eventIn identifier.
   *
!  * @return the eventIn identifier.
   */
  const std::string
--- 1216,1222 ----
  
  /**
!  * @brief Get the @c eventIn identifier.
   *
!  * @return the @c eventIn identifier.
   */
  const std::string
***************
*** 1257,1261 ****
   * @class openvrml::script_node::url_changed_emitter
   *
!  * @brief url_changed event emitter.
   */
  
--- 1258,1262 ----
   * @class openvrml::script_node::url_changed_emitter
   *
!  * @brief @c url_changed event emitter.
   */
  
***************
*** 3448,3452 ****
              const openvrml::mfbool & mfbool =
                  *polymorphic_downcast<const openvrml::mfbool *>(&fieldValue);
!             if (!MFBool::toJsval(mfbool.value(), this->cx, globalObj, &rval)) 
              {
                  rval = JSVAL_NULL;
--- 3449,3453 ----
              const openvrml::mfbool & mfbool =
                  *polymorphic_downcast<const openvrml::mfbool *>(&fieldValue);
!             if (!MFBool::toJsval(mfbool.value(), this->cx, globalObj, &rval))
              {
                  rval = JSVAL_NULL;
***************
*** 5427,5431 ****
              auto_ptr<openvrml::field_value> fieldValue;
              fieldValue = createFieldValueFromJsval(cx, *vp, expectType);
!             
              assert(JS_GetContextPrivate(cx));
              js_::script & script =
--- 5428,5432 ----
              auto_ptr<openvrml::field_value> fieldValue;
              fieldValue = createFieldValueFromJsval(cx, *vp, expectType);
! 
              assert(JS_GetContextPrivate(cx));
              js_::script & script =