Menu
▾
▴
[openvrml-commit] openvrml/src/libopenvrml/openvrml browser.cpp, 1.179, 1.180 node_impl_util.cpp, 1.14, 1.15
|
From: Braden M. <br...@us...> - 2006-07-25 05:05:50
|
Update of /cvsroot/openvrml/openvrml/src/libopenvrml/openvrml In directory sc8-pr-cvs3.sourceforge.net:/tmp/cvs-serv23504/src/libopenvrml/openvrml Modified Files: browser.cpp node_impl_util.cpp Log Message: Doc-comment improvements. Index: browser.cpp =================================================================== RCS file: /cvsroot/openvrml/openvrml/src/libopenvrml/openvrml/browser.cpp,v retrieving revision 1.179 retrieving revision 1.180 diff -C2 -d -r1.179 -r1.180 *** browser.cpp 25 Jul 2006 03:52:06 -0000 1.179 --- browser.cpp 25 Jul 2006 05:05:47 -0000 1.180 *************** *** 103,111 **** * @brief @c node_metatype for @c PROTO%s. * ! * The <code>proto_node_metatype</code> is %OpenVRML's in-memory ! * representation of a @c PROTO (as opposed to a ! * @c PROTO instance). Through the <code>proto_node_type</code> ! * intermediary, it facilitates spawning any number of ! * <code>proto_node</code> instances. */ class OPENVRML_LOCAL proto_node_metatype : public node_metatype { --- 103,110 ---- * @brief @c node_metatype for @c PROTO%s. * ! * The @c proto_node_metatype is OpenVRML's in-memory representation of a ! * @c PROTO (as opposed to a @c PROTO instance). Through the @c ! * proto_node_type intermediary, it facilitates spawning any number of @c ! * proto_node instances. */ class OPENVRML_LOCAL proto_node_metatype : public node_metatype { *************** *** 170,174 **** * @internal * ! * @brief <code>node_type</code> for PROTO node instances. */ class OPENVRML_LOCAL proto_node_type : public node_type { --- 169,173 ---- * @internal * ! * @brief @c node_type for @c PROTO node instances. */ class OPENVRML_LOCAL proto_node_type : public node_type { *************** *** 1306,1311 **** * @todo It's annoying that we need to carry this around. Should * investigate the possibility of promoting all this stuff to ! * proto_eventout and have proto_eventout privately inherit ! * field_value_listener<FieldValue>. */ --- 1305,1310 ---- * @todo It's annoying that we need to carry this around. Should * investigate the possibility of promoting all this stuff to ! * @c proto_eventout and have @c proto_eventout privately inherit ! * @c field_value_listener<FieldValue>. */ *************** *** 1350,1354 **** /** ! * @brief Get the associated eventIn identifier. */ template <typename FieldValue> --- 1349,1353 ---- /** ! * @brief Get the associated @c eventIn identifier. */ template <typename FieldValue> *************** *** 1412,1416 **** * @param[in] node @c abstract_proto_node. * @param[in] initial_value initial value. This is used by ! * @c proto_exposedfield<FieldValue> */ template <typename FieldValue> --- 1411,1415 ---- * @param[in] node @c abstract_proto_node. * @param[in] initial_value initial value. This is used by ! * @c proto_exposedfield<FieldValue> */ template <typename FieldValue> Index: node_impl_util.cpp =================================================================== RCS file: /cvsroot/openvrml/openvrml/src/libopenvrml/openvrml/node_impl_util.cpp,v retrieving revision 1.14 retrieving revision 1.15 diff -C2 -d -r1.14 -r1.15 *** node_impl_util.cpp 24 Jul 2006 23:55:14 -0000 1.14 --- node_impl_util.cpp 25 Jul 2006 05:05:47 -0000 1.15 *************** *** 28,43 **** * * While the API comprising the members of the @c openvrml namespace ! * provides everything <em>necessary</em> to implement nodes, node ! * implementation can be very verbose. The members of the ! * @c openvrml::node_impl_util namespace can make node implementation * more concise by abstracting and providing code that many node * implementations are likely to have in common. * ! * Specifically, @c node_type_impl centralizes the logic for ! * generalized field access. By using an instance of this class template ! * for your @c openvrml::node_type implementation you can avoid a lot ! * of tedious and repetitive code to implement ! * @c openvrml::node::do_field, ! * @c openvrml::node::do_event_listener, and * @c openvrml::node::do_event_emitter. */ --- 28,42 ---- * * While the API comprising the members of the @c openvrml namespace ! * provides everything @e necessary to implement nodes, node ! * implementation can be very verbose. The members of the @c ! * openvrml::node_impl_util namespace can make node implementation * more concise by abstracting and providing code that many node * implementations are likely to have in common. * ! * In particular, @c node_type_impl centralizes the logic for ! * generalized field access. By using an instance of this class ! * template for your @c openvrml::node_type implementation you can ! * avoid a lot of tedious and repetitive code to implement @c ! * openvrml::node::do_field, @c openvrml::node::do_event_listener, and * @c openvrml::node::do_event_emitter. */ *************** *** 365,371 **** * @fn const std::string openvrml::node_impl_util::event_listener_base::do_eventin_id() const * ! * @brief The associated eventIn identifier. * ! * @return the associated eventIn identifier. */ --- 364,370 ---- * @fn const std::string openvrml::node_impl_util::event_listener_base::do_eventin_id() const * ! * @brief The associated @c eventIn identifier. * ! * @return the associated @c eventIn identifier. */ *************** *** 383,387 **** * @var openvrml::node * openvrml::node_impl_util::event_emitter_base::node_ * ! * @brief The node with which the @c event_emitter is associated. */ --- 382,386 ---- * @var openvrml::node * openvrml::node_impl_util::event_emitter_base::node_ * ! * @brief The @c node with which the @c event_emitter is associated. */ *************** *** 458,464 **** * @fn const std::string openvrml::node_impl_util::event_emitter_base::do_eventout_id() const * ! * @brief The associated eventOut identifier. * ! * @return the associated eventOut identifier. */ --- 457,463 ---- * @fn const std::string openvrml::node_impl_util::event_emitter_base::do_eventout_id() const * ! * @brief The associated @c eventOut identifier. * ! * @return the associated @c eventOut identifier. */ *************** *** 470,474 **** * * @c abstract_node encapsulates the mechanisms for field access and ! * mutation, event dispatch, and eventOut access. */ --- 469,473 ---- * * @c abstract_node encapsulates the mechanisms for field access and ! * mutation, event dispatch, and @c eventOut access. */ *************** *** 476,480 **** * @typedef openvrml::node_field_value_listener<openvrml::sfbool> openvrml::node_impl_util::abstract_node::sfbool_listener * ! * @brief @c openvrml::sfbool listener. Provided for convenience. */ --- 475,479 ---- * @typedef openvrml::node_field_value_listener<openvrml::sfbool> openvrml::node_impl_util::abstract_node::sfbool_listener * ! * @brief @c openvrml::sfbool listener. Provided for convenience. */ *************** *** 482,486 **** * @typedef openvrml::node_field_value_listener<openvrml::sfcolor> openvrml::node_impl_util::abstract_node::sfcolor_listener * ! * @brief @c openvrml::sfcolor listener. Provided for convenience. */ --- 481,485 ---- * @typedef openvrml::node_field_value_listener<openvrml::sfcolor> openvrml::node_impl_util::abstract_node::sfcolor_listener * ! * @brief @c openvrml::sfcolor listener. Provided for convenience. */ *************** *** 488,492 **** * @typedef openvrml::node_field_value_listener<openvrml::sffloat> openvrml::node_impl_util::abstract_node::sffloat_listener * ! * @brief @c openvrml::sffloat listener. Provided for convenience. */ --- 487,491 ---- * @typedef openvrml::node_field_value_listener<openvrml::sffloat> openvrml::node_impl_util::abstract_node::sffloat_listener * ! * @brief @c openvrml::sffloat listener. Provided for convenience. */ *************** *** 494,498 **** * @typedef openvrml::node_field_value_listener<openvrml::sfdouble> openvrml::node_impl_util::abstract_node::sfdouble_listener * ! * @brief @c openvrml::sfdouble listener. Provided for convenience. */ --- 493,497 ---- * @typedef openvrml::node_field_value_listener<openvrml::sfdouble> openvrml::node_impl_util::abstract_node::sfdouble_listener * ! * @brief @c openvrml::sfdouble listener. Provided for convenience. */ *************** *** 500,504 **** * @typedef openvrml::node_field_value_listener<openvrml::sfimage> openvrml::node_impl_util::abstract_node::sfimage_listener * ! * @brief @c openvrml::sfimage listener. Provided for convenience. */ --- 499,503 ---- * @typedef openvrml::node_field_value_listener<openvrml::sfimage> openvrml::node_impl_util::abstract_node::sfimage_listener * ! * @brief @c openvrml::sfimage listener. Provided for convenience. */ *************** *** 506,510 **** * @typedef openvrml::node_field_value_listener<openvrml::sfint32> openvrml::node_impl_util::abstract_node::sfint32_listener * ! * @brief @c openvrml::sfint32 listener. Provided for convenience. */ --- 505,509 ---- * @typedef openvrml::node_field_value_listener<openvrml::sfint32> openvrml::node_impl_util::abstract_node::sfint32_listener * ! * @brief @c openvrml::sfint32 listener. Provided for convenience. */ *************** *** 512,516 **** * @typedef openvrml::node_field_value_listener<openvrml::sfnode> openvrml::node_impl_util::abstract_node::sfnode_listener * ! * @brief @c openvrml::sfnode listener. Provided for convenience. */ --- 511,515 ---- * @typedef openvrml::node_field_value_listener<openvrml::sfnode> openvrml::node_impl_util::abstract_node::sfnode_listener * ! * @brief @c openvrml::sfnode listener. Provided for convenience. */ *************** *** 518,522 **** * @typedef openvrml::node_field_value_listener<openvrml::sfrotation> openvrml::node_impl_util::abstract_node::sfrotation_listener * ! * @brief @c openvrml::sfrotation listener. Provided for convenience. */ --- 517,521 ---- * @typedef openvrml::node_field_value_listener<openvrml::sfrotation> openvrml::node_impl_util::abstract_node::sfrotation_listener * ! * @brief @c openvrml::sfrotation listener. Provided for convenience. */ *************** *** 524,528 **** * @typedef openvrml::node_field_value_listener<openvrml::sfstring> openvrml::node_impl_util::abstract_node::sfstring_listener * ! * @brief @c openvrml::sfstring listener. Provided for convenience. */ --- 523,527 ---- * @typedef openvrml::node_field_value_listener<openvrml::sfstring> openvrml::node_impl_util::abstract_node::sfstring_listener * ! * @brief @c openvrml::sfstring listener. Provided for convenience. */ *************** *** 530,534 **** * @typedef openvrml::node_field_value_listener<openvrml::sftime> openvrml::node_impl_util::abstract_node::sftime_listener * ! * @brief @c openvrml::sftime listener. Provided for convenience. */ --- 529,533 ---- * @typedef openvrml::node_field_value_listener<openvrml::sftime> openvrml::node_impl_util::abstract_node::sftime_listener * ! * @brief @c openvrml::sftime listener. Provided for convenience. */ *************** *** 536,540 **** * @typedef openvrml::node_field_value_listener<openvrml::sfvec2f> openvrml::node_impl_util::abstract_node::sfvec2f_listener * ! * @brief @c openvrml::sfvec2f listener. Provided for convenience. */ --- 535,539 ---- * @typedef openvrml::node_field_value_listener<openvrml::sfvec2f> openvrml::node_impl_util::abstract_node::sfvec2f_listener * ! * @brief @c openvrml::sfvec2f listener. Provided for convenience. */ *************** *** 542,546 **** * @typedef openvrml::node_field_value_listener<openvrml::sfvec2d> openvrml::node_impl_util::abstract_node::sfvec2d_listener * ! * @brief @c openvrml::sfvec2d listener. Provided for convenience. */ --- 541,545 ---- * @typedef openvrml::node_field_value_listener<openvrml::sfvec2d> openvrml::node_impl_util::abstract_node::sfvec2d_listener * ! * @brief @c openvrml::sfvec2d listener. Provided for convenience. */ *************** *** 548,552 **** * @typedef openvrml::node_field_value_listener<openvrml::sfvec3f> openvrml::node_impl_util::abstract_node::sfvec3f_listener * ! * @brief @c openvrml::sfvec3f listener. Provided for convenience. */ --- 547,551 ---- * @typedef openvrml::node_field_value_listener<openvrml::sfvec3f> openvrml::node_impl_util::abstract_node::sfvec3f_listener * ! * @brief @c openvrml::sfvec3f listener. Provided for convenience. */ *************** *** 554,558 **** * @typedef openvrml::node_field_value_listener<openvrml::sfvec3d> openvrml::node_impl_util::abstract_node::sfvec3d_listener * ! * @brief @c openvrml::sfvec3d listener. Provided for convenience. */ --- 553,557 ---- * @typedef openvrml::node_field_value_listener<openvrml::sfvec3d> openvrml::node_impl_util::abstract_node::sfvec3d_listener * ! * @brief @c openvrml::sfvec3d listener. Provided for convenience. */ *************** *** 560,564 **** * @typedef openvrml::node_field_value_listener<openvrml::mfcolor> openvrml::node_impl_util::abstract_node::mfcolor_listener * ! * @brief @c openvrml::mfcolor listener. Provided for convenience. */ --- 559,563 ---- * @typedef openvrml::node_field_value_listener<openvrml::mfcolor> openvrml::node_impl_util::abstract_node::mfcolor_listener * ! * @brief @c openvrml::mfcolor listener. Provided for convenience. */ *************** *** 566,570 **** * @typedef openvrml::node_field_value_listener<openvrml::mffloat> openvrml::node_impl_util::abstract_node::mffloat_listener * ! * @brief @c openvrml::mffloat listener. Provided for convenience. */ --- 565,569 ---- * @typedef openvrml::node_field_value_listener<openvrml::mffloat> openvrml::node_impl_util::abstract_node::mffloat_listener * ! * @brief @c openvrml::mffloat listener. Provided for convenience. */ *************** *** 572,576 **** * @typedef openvrml::node_field_value_listener<openvrml::mfdouble> openvrml::node_impl_util::abstract_node::mfdouble_listener * ! * @brief @c openvrml::mfdouble listener. Provided for convenience. */ --- 571,575 ---- * @typedef openvrml::node_field_value_listener<openvrml::mfdouble> openvrml::node_impl_util::abstract_node::mfdouble_listener * ! * @brief @c openvrml::mfdouble listener. Provided for convenience. */ *************** *** 578,582 **** * @typedef openvrml::node_field_value_listener<openvrml::mfint32> openvrml::node_impl_util::abstract_node::mfint32_listener * ! * @brief @c openvrml::mfint32 listener. Provided for convenience. */ --- 577,581 ---- * @typedef openvrml::node_field_value_listener<openvrml::mfint32> openvrml::node_impl_util::abstract_node::mfint32_listener * ! * @brief @c openvrml::mfint32 listener. Provided for convenience. */ *************** *** 584,588 **** * @typedef openvrml::node_field_value_listener<openvrml::mfnode> openvrml::node_impl_util::abstract_node::mfnode_listener * ! * @brief @c openvrml::mfnode listener. Provided for convenience. */ --- 583,587 ---- * @typedef openvrml::node_field_value_listener<openvrml::mfnode> openvrml::node_impl_util::abstract_node::mfnode_listener * ! * @brief @c openvrml::mfnode listener. Provided for convenience. */ *************** *** 590,594 **** * @typedef openvrml::node_field_value_listener<openvrml::mfrotation> openvrml::node_impl_util::abstract_node::mfrotation_listener * ! * @brief @c openvrml::mfrotation listener. Provided for convenience. */ --- 589,593 ---- * @typedef openvrml::node_field_value_listener<openvrml::mfrotation> openvrml::node_impl_util::abstract_node::mfrotation_listener * ! * @brief @c openvrml::mfrotation listener. Provided for convenience. */ *************** *** 596,600 **** * @typedef openvrml::node_field_value_listener<openvrml::mfstring> openvrml::node_impl_util::abstract_node::mfstring_listener * ! * @brief @c openvrml::mfstring listener. Provided for convenience. */ --- 595,599 ---- * @typedef openvrml::node_field_value_listener<openvrml::mfstring> openvrml::node_impl_util::abstract_node::mfstring_listener * ! * @brief @c openvrml::mfstring listener. Provided for convenience. */ *************** *** 602,606 **** * @typedef openvrml::node_field_value_listener<openvrml::mftime> openvrml::node_impl_util::abstract_node::mftime_listener * ! * @brief @c openvrml::mftime listener. Provided for convenience. */ --- 601,605 ---- * @typedef openvrml::node_field_value_listener<openvrml::mftime> openvrml::node_impl_util::abstract_node::mftime_listener * ! * @brief @c openvrml::mftime listener. Provided for convenience. */ *************** *** 608,612 **** * @typedef openvrml::node_field_value_listener<openvrml::mfvec2f> openvrml::node_impl_util::abstract_node::mfvec2f_listener * ! * @brief @c openvrml::mfvec2f listener. Provided for convenience. */ --- 607,611 ---- * @typedef openvrml::node_field_value_listener<openvrml::mfvec2f> openvrml::node_impl_util::abstract_node::mfvec2f_listener * ! * @brief @c openvrml::mfvec2f listener. Provided for convenience. */ *************** *** 614,618 **** * @typedef openvrml::node_field_value_listener<openvrml::mfvec2d> openvrml::node_impl_util::abstract_node::mfvec2d_listener * ! * @brief @c openvrml::mfvec2d listener. Provided for convenience. */ --- 613,617 ---- * @typedef openvrml::node_field_value_listener<openvrml::mfvec2d> openvrml::node_impl_util::abstract_node::mfvec2d_listener * ! * @brief @c openvrml::mfvec2d listener. Provided for convenience. */ *************** *** 620,624 **** * @typedef openvrml::node_field_value_listener<openvrml::mfvec3f> openvrml::node_impl_util::abstract_node::mfvec3f_listener * ! * @brief @c openvrml::mfvec3f listener. Provided for convenience. */ --- 619,623 ---- * @typedef openvrml::node_field_value_listener<openvrml::mfvec3f> openvrml::node_impl_util::abstract_node::mfvec3f_listener * ! * @brief @c openvrml::mfvec3f listener. Provided for convenience. */ *************** *** 626,630 **** * @typedef openvrml::node_field_value_listener<openvrml::mfvec3d> openvrml::node_impl_util::abstract_node::mfvec3d_listener * ! * @brief @c openvrml::mfvec3d listener. Provided for convenience. */ --- 625,629 ---- * @typedef openvrml::node_field_value_listener<openvrml::mfvec3d> openvrml::node_impl_util::abstract_node::mfvec3d_listener * ! * @brief @c openvrml::mfvec3d listener. Provided for convenience. */ *************** *** 640,644 **** * @brief Construct. * ! * @param[in] node node from which events will be emitted. * @param[in] value associated field value. */ --- 639,643 ---- * @brief Construct. * ! * @param[in] node @c node from which events will be emitted. * @param[in] value associated field value. */ *************** *** 846,851 **** * @brief Construct. * ! * @param[in] type the node_type associated with this node. ! * @param[in] scope the scope to which the node belongs. */ --- 845,850 ---- * @brief Construct. * ! * @param[in] type the @c node_type associated with this node. ! * @param[in] scope the @c scope to which the @c node belongs. */ *************** *** 859,867 **** * @fn const openvrml::field_value & openvrml::node_impl_util::abstract_node::do_field(const std::string & id) const * ! * @brief Get a field value for a node. * * @param[in] id a field name. * ! * @exception unsupported_interface if the node has no field @p id. */ --- 858,866 ---- * @fn const openvrml::field_value & openvrml::node_impl_util::abstract_node::do_field(const std::string & id) const * ! * @brief Get a field value for a @c node. * * @param[in] id a field name. * ! * @exception unsupported_interface if the @c node has no @c field @p id. */ *************** *** 871,881 **** * @brief Get an event listener. * ! * This method is called by node::event_listener. * ! * @param[in] id eventIn identifier. * * @return the event listener. * ! * @exception unsupported_interface if the node has no eventIn @p id. */ --- 870,880 ---- * @brief Get an event listener. * ! * This method is called by @c node::event_listener. * ! * @param[in] id @c eventIn identifier. * * @return the event listener. * ! * @exception unsupported_interface if the @c node has no @c eventIn @p id. */ *************** *** 885,895 **** * @brief Get an event emitter. * ! * This method is called by node::event_emitter. * ! * @param[in] id eventOut identifier. * * @return the event emitter. * ! * @exception unsupported_interface if the node has no eventOut @p id. */ --- 884,894 ---- * @brief Get an event emitter. * ! * This method is called by @c node::event_emitter. * ! * @param[in] id @c eventOut identifier. * * @return the event emitter. * ! * @exception unsupported_interface if the @c node has no @c eventOut @p id. */ *************** *** 918,922 **** * @fn openvrml::node_impl_util::node_type_impl::event_listener_ptr::event_listener_ptr(EventListenerMember Node::* ptr_to_mem) * ! * @brief Construct * * @param[in] ptr_to_mem a pointer to an --- 917,921 ---- * @fn openvrml::node_impl_util::node_type_impl::event_listener_ptr::event_listener_ptr(EventListenerMember Node::* ptr_to_mem) * ! * @brief Construct. * * @param[in] ptr_to_mem a pointer to an *************** *** 933,937 **** * @fn openvrml::node_impl_util::node_type_impl::event_emitter_ptr::event_emitter_ptr(EventEmitterMember Node::* ptr_to_mem) * ! * @brief Construct * * @param[in] ptr_to_mem a pointer to an --- 932,936 ---- * @fn openvrml::node_impl_util::node_type_impl::event_emitter_ptr::event_emitter_ptr(EventEmitterMember Node::* ptr_to_mem) * ! * @brief Construct. * * @param[in] ptr_to_mem a pointer to an *************** *** 957,969 **** * @fn void openvrml::node_impl_util::node_type_impl::add_eventin(const openvrml::field_value::type_id type, const std::string & id, const event_listener_ptr_ptr & event_listener) * ! * @brief Add an eventIn. * * @param[in] type the field value type. ! * @param[in] id the eventIn identifier. ! * @param[in] event_listener the @c openvrml::event_listener ! * associated with the eventIn. * ! * @exception std::invalid_argument if an interface with a conflicting ! * @p id has already been added to the * @c node_type. * @exception std::bad_alloc if memory allocation fails. --- 956,968 ---- * @fn void openvrml::node_impl_util::node_type_impl::add_eventin(const openvrml::field_value::type_id type, const std::string & id, const event_listener_ptr_ptr & event_listener) * ! * @brief Add an @c eventIn. * * @param[in] type the field value type. ! * @param[in] id the @c eventIn identifier. ! * @param[in] event_listener the @c openvrml::event_listener associated ! * with the @c eventIn. * ! * @exception std::invalid_argument if an interface with a conflicting @p id ! * has already been added to the * @c node_type. * @exception std::bad_alloc if memory allocation fails. *************** *** 973,982 **** * @fn void openvrml::node_impl_util::node_type_impl::add_eventout(const openvrml::field_value::type_id type, const std::string & id, const event_emitter_ptr_ptr & event_emitter) * ! * @brief Add an eventOut. * * @param[in] type the field value type. ! * @param[in] id the eventOut identifier. * @param[in] event_emitter the @c openvrml::event_emitter ! * associated with the eventOut. * * @exception std::invalid_argument if an interface with a conflicting --- 972,981 ---- * @fn void openvrml::node_impl_util::node_type_impl::add_eventout(const openvrml::field_value::type_id type, const std::string & id, const event_emitter_ptr_ptr & event_emitter) * ! * @brief Add an @c eventOut. * * @param[in] type the field value type. ! * @param[in] id the @c eventOut identifier. * @param[in] event_emitter the @c openvrml::event_emitter ! * associated with the @c eventOut. * * @exception std::invalid_argument if an interface with a conflicting *************** *** 989,1002 **** * @fn void openvrml::node_impl_util::node_type_impl::add_exposedfield(const openvrml::field_value::type_id type, const std::string & id, const event_listener_ptr_ptr & event_listener, const field_ptr_ptr & field, const event_emitter_ptr_ptr & event_emitter) * ! * @brief Add an exposedField. * * @param[in] type the field value type. ! * @param[in] id the exposedField identifier. * @param[in] event_listener the @c openvrml::event_listener ! * associated with the exposedField. * @param[in] field the @c openvrml::field_value ! * associated with the exposedField. * @param[in] event_emitter the @c openvrml::event_emitter ! * associated with the exposedField. * * @exception std::invalid_argument if an interface with a conflicting --- 988,1001 ---- * @fn void openvrml::node_impl_util::node_type_impl::add_exposedfield(const openvrml::field_value::type_id type, const std::string & id, const event_listener_ptr_ptr & event_listener, const field_ptr_ptr & field, const event_emitter_ptr_ptr & event_emitter) * ! * @brief Add an @c exposedField. * * @param[in] type the field value type. ! * @param[in] id the @c exposedField identifier. * @param[in] event_listener the @c openvrml::event_listener ! * associated with the @c exposedField. * @param[in] field the @c openvrml::field_value ! * associated with the @c exposedField. * @param[in] event_emitter the @c openvrml::event_emitter ! * associated with the @c exposedField. * * @exception std::invalid_argument if an interface with a conflicting *************** *** 1009,1018 **** * @fn void openvrml::node_impl_util::node_type_impl::add_field(const openvrml::field_value::type_id type, const std::string & id, const field_ptr_ptr & field) * ! * @brief Add a field. * * @param[in] type the field value type. * @param[in] id the field identifier. * @param[in] field the @c openvrml::field_value associated with the ! * field. * * @exception std::invalid_argument if an interface with a conflicting --- 1008,1017 ---- * @fn void openvrml::node_impl_util::node_type_impl::add_field(const openvrml::field_value::type_id type, const std::string & id, const field_ptr_ptr & field) * ! * @brief Add a @c field. * * @param[in] type the field value type. * @param[in] id the field identifier. * @param[in] field the @c openvrml::field_value associated with the ! * @c field. * * @exception std::invalid_argument if an interface with a conflicting *************** *** 1032,1041 **** * @param[in] node the @c openvrml::node for which to return the * @c openvrml::field_value. ! * @param[in] id field identifier. * * @return @p node's @c openvrml::field_value corresponding to ! * the field identifier @p id. * ! * @exception openvrml::unsupported_interface if @p node has no field * @p id. */ --- 1031,1040 ---- * @param[in] node the @c openvrml::node for which to return the * @c openvrml::field_value. ! * @param[in] id @c field identifier. * * @return @p node's @c openvrml::field_value corresponding to ! * the @c field identifier @p id. * ! * @exception openvrml::unsupported_interface if @p node has no @c field * @p id. */ *************** *** 1049,1058 **** * @param[in] node the node for which to return the * @c openvrml::field_value. ! * @param[in] id field identifier. * * @return @p node's @c openvrml::field_value corresponding to ! * the field identifier @p id. * ! * @exception openvrml::unsupported_interface if @p node has no field * @p id. */ --- 1048,1057 ---- * @param[in] node the node for which to return the * @c openvrml::field_value. ! * @param[in] id @c field identifier. * * @return @p node's @c openvrml::field_value corresponding to ! * the @c field identifier @p id. * ! * @exception openvrml::unsupported_interface if @p node has no @c field * @p id. */ *************** *** 1062,1066 **** * * @brief @p node's @c openvrml::event_listener corresponding to ! * the eventIn identifier @p id. * * Delegates to --- 1061,1065 ---- * * @brief @p node's @c openvrml::event_listener corresponding to ! * the @c eventIn identifier @p id. * * Delegates to *************** *** 1069,1078 **** * @param[in] node the @c openvrml::node for which to return the * @c openvrml::event_listener. ! * @param[in] id eventIn identifier. * * @return @p node's @c openvrml::event_listener corresponding to * the eventIn identifier @p id. * ! * @exception openvrml::unsupported_interface if @p node has no eventIn * @p id. */ --- 1068,1077 ---- * @param[in] node the @c openvrml::node for which to return the * @c openvrml::event_listener. ! * @param[in] id @c eventIn identifier. * * @return @p node's @c openvrml::event_listener corresponding to * the eventIn identifier @p id. * ! * @exception openvrml::unsupported_interface if @p node has no @c eventIn * @p id. */ *************** *** 1082,1095 **** * * @brief @p node's @c openvrml::event_listener corresponding to ! * the eventIn identifier @p id. * * @param[in] node the @c openvrml::node for which to return the * @c openvrml::event_listener. ! * @param[in] id eventIn identifier. * * @return @p node's @c openvrml::event_listener corresponding to ! * the eventIn identifier @p id. * ! * @exception openvrml::unsupported_interface if @p node has no eventIn * @p id. */ --- 1081,1094 ---- * * @brief @p node's @c openvrml::event_listener corresponding to ! * the @c eventIn identifier @p id. * * @param[in] node the @c openvrml::node for which to return the * @c openvrml::event_listener. ! * @param[in] id @c eventIn identifier. * * @return @p node's @c openvrml::event_listener corresponding to ! * the @c eventIn identifier @p id. * ! * @exception openvrml::unsupported_interface if @p node has no @c eventIn * @p id. */ *************** *** 1099,1103 **** * * @brief @p node's @c openvrml::event_emitter corresponding to ! * the eventOut identifier @p id. * * Delegates to @c node_type_impl<Node>::do_event_emitter. --- 1098,1102 ---- * * @brief @p node's @c openvrml::event_emitter corresponding to ! * the @c eventOut identifier @p id. * * Delegates to @c node_type_impl<Node>::do_event_emitter. *************** *** 1105,1114 **** * @param[in] node the @c openvrml::node for which to return the * @c openvrml::event_emitter. ! * @param[in] id eventOut identifier. * * @return @p node's @c openvrml::event_emitter corresponding to ! * the eventOut identifier @p id. * ! * @exception openvrml::unsupported_interface if @p node has no eventOut * @p id. */ --- 1104,1113 ---- * @param[in] node the @c openvrml::node for which to return the * @c openvrml::event_emitter. ! * @param[in] id @c eventOut identifier. * * @return @p node's @c openvrml::event_emitter corresponding to ! * the @c eventOut identifier @p id. * ! * @exception openvrml::unsupported_interface if @p node has no @c eventOut * @p id. */ *************** *** 1118,1122 **** * * @brief @p node's @c openvrml::event_emitter corresponding to ! * the eventOut identifier @p id. * * Delegates to @c node_type_impl<Node>::do_event_emitter. --- 1117,1121 ---- * * @brief @p node's @c openvrml::event_emitter corresponding to ! * the @c eventOut identifier @p id. * * Delegates to @c node_type_impl<Node>::do_event_emitter. *************** *** 1124,1133 **** * @param[in] node the @c openvrml::node for which to return the * @c openvrml::event_emitter. ! * @param[in] id eventOut identifier. * * @return @p node's @c openvrml::event_emitter corresponding to ! * the eventOut identifier @p id. * ! * @exception openvrml::unsupported_interface if @p node has no eventOut * @p id. */ --- 1123,1132 ---- * @param[in] node the @c openvrml::node for which to return the * @c openvrml::event_emitter. ! * @param[in] id @c eventOut identifier. * * @return @p node's @c openvrml::event_emitter corresponding to ! * the @c eventOut identifier @p id. * ! * @exception openvrml::unsupported_interface if @p node has no @c eventOut * @p id. */ *************** *** 1148,1154 **** * @brief Create a node instance. * ! * @param[in] scope the @c scope the new node will belong ! * to. ! * @param[in] initial_values initial values for the new node's fields. * * @return a new node instance. --- 1147,1153 ---- * @brief Create a node instance. * ! * @param[in] scope the @c scope the new node will belong to. ! * @param[in] initial_values initial values for the new <code>node</code>'s ! * fields. * * @return a new node instance. |
