Menu
▾
▴
[openvrml-commit] openvrml/src/libopenvrml/openvrml basetypes.cpp, 1.42, 1.43 basetypes.h, 1.27, 1.28 bounding_volume.cpp, 1.16, 1.17 browser.cpp, 1.205, 1.206 event.cpp, 1.14, 1.15 event.h, 1.13, 1.14 exposedfield.cpp, 1.6, 1.7 field_value.cpp, 1.29, 1.30 frustum.cpp, 1.8, 1.9 node.cpp, 1.90, 1.91 node.h, 1.57, 1.58 node_impl_util.cpp, 1.15, 1.16 rendering_context.cpp, 1.3, 1.4 scope.cpp, 1.20, 1.21 script.cpp, 1.79, 1.80 viewer.cpp, 1.16, 1.17 viewer.h, 1.14, 1.15 vrml97node.cpp, 1.122, 1.123
Update of /cvsroot/openvrml/openvrml/src/libopenvrml/openvrml In directory sc8-pr-cvs3.sourceforge.net:/tmp/cvs-serv12313/src/libopenvrml/openvrml Modified Files: basetypes.cpp basetypes.h bounding_volume.cpp browser.cpp event.cpp event.h exposedfield.cpp field_value.cpp frustum.cpp node.cpp node.h node_impl_util.cpp rendering_context.cpp scope.cpp script.cpp viewer.cpp viewer.h vrml97node.cpp Log Message: Doc-comment improvements. Index: node_impl_util.cpp =================================================================== RCS file: /cvsroot/openvrml/openvrml/src/libopenvrml/openvrml/node_impl_util.cpp,v retrieving revision 1.15 retrieving revision 1.16 diff -C2 -d -r1.15 -r1.16 *** node_impl_util.cpp 25 Jul 2006 05:05:47 -0000 1.15 --- node_impl_util.cpp 6 Mar 2007 07:24:01 -0000 1.16 *************** *** 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 *************** *** 23,26 **** --- 23,32 ---- /** + * @file openvrml/node_impl_util.h + * + * @brief Definition of utility classes to facilitate node implementations. + */ + + /** * @namespace openvrml::node_impl_util * Index: node.cpp =================================================================== RCS file: /cvsroot/openvrml/openvrml/src/libopenvrml/openvrml/node.cpp,v retrieving revision 1.90 retrieving revision 1.91 diff -C2 -d -r1.90 -r1.91 *** node.cpp 10 Dec 2006 07:07:30 -0000 1.90 --- node.cpp 6 Mar 2007 07:24:01 -0000 1.91 *************** *** 35,39 **** /** ! * @class openvrml::unsupported_interface * * @brief Exception to indicate that a @c node interface is not supported. --- 35,45 ---- /** ! * @file openvrml/node.h ! * ! * @brief Abstract node types and supporting types. ! */ ! ! /** ! * @class openvrml::unsupported_interface openvrml/node.h * * @brief Exception to indicate that a @c node interface is not supported. *************** *** 97,101 **** /** ! * @class openvrml::node_interface * * @brief Type information for an interface of a @c node. --- 103,107 ---- /** ! * @class openvrml::node_interface openvrml/node.h * * @brief Type information for an interface of a @c node. *************** *** 309,313 **** /** ! * @struct openvrml::node_interface_matches_eventin * * @brief Determine if a @c node_interface matches an @c eventIn identifier. --- 315,319 ---- /** ! * @struct openvrml::node_interface_matches_eventin openvrml/node.h * * @brief Determine if a @c node_interface matches an @c eventIn identifier. *************** *** 348,352 **** /** ! * @struct openvrml::node_interface_matches_eventout * * @brief Determine if a @c node_interface matches an @c eventOut identifier. --- 354,358 ---- /** ! * @struct openvrml::node_interface_matches_eventout openvrml/node.h * * @brief Determine if a @c node_interface matches an @c eventOut identifier. *************** *** 388,392 **** /** ! * @struct openvrml::node_interface_matches_exposedfield * * @brief Determine if a @c node_interface matches an @c exposedField --- 394,398 ---- /** ! * @struct openvrml::node_interface_matches_exposedfield openvrml/node.h * * @brief Determine if a @c node_interface matches an @c exposedField *************** *** 407,413 **** * * A @c node_interface matches an @c exposedField identifier if the ! * @c node_interface%'s @a type is @c node_interface::exposedfield_id and the ! * @c node_interface%'s @a id is lexicographically equal to the @c exposedField ! * identifier. * * @param[in] interface @c node_interface. --- 413,419 ---- * * A @c node_interface matches an @c exposedField identifier if the ! * <code>node_interface</code>'s @a type is @c node_interface::exposedfield_id ! * and the <code>node_interface</code>'s @a id is lexicographically equal to ! * the @c exposedField identifier. * * @param[in] interface @c node_interface. *************** *** 420,424 **** /** ! * @struct openvrml::node_interface_matches_field * * @brief Determine if a @c node_interface matches an field --- 426,430 ---- /** ! * @struct openvrml::node_interface_matches_field openvrml/node.h * * @brief Determine if a @c node_interface matches an field *************** *** 450,454 **** /** ! * @struct openvrml::node_interface_compare * * @brief Function object to compare two @c node_interface%s based on their --- 456,460 ---- /** ! * @struct openvrml::node_interface_compare openvrml/node.h * * @brief Function object to compare two @c node_interface%s based on their *************** *** 541,545 **** /** ! * @class openvrml::node_metatype_id * * @brief Identifier for @c node_metatype%s. --- 547,551 ---- /** ! * @class openvrml::node_metatype_id openvrml/node.h * * @brief Identifier for @c node_metatype%s. *************** *** 706,710 **** /** ! * @class openvrml::node_metatype * * @brief A class object for node instances. --- 712,716 ---- /** ! * @class openvrml::node_metatype openvrml/node.h * * @brief A class object for node instances. *************** *** 784,788 **** * new root @c scene. It is called after the individual @c node instances * have been initialized, and before the world starts running. It delegates ! * to @c node_metatype::do_initialize. * * @param[in,out] initial_viewpoint the @c viewpoint_node that should be bound --- 790,794 ---- * new root @c scene. It is called after the individual @c node instances * have been initialized, and before the world starts running. It delegates ! * to @c #do_initialize. * * @param[in,out] initial_viewpoint the @c viewpoint_node that should be bound *************** *** 818,822 **** * @brief <code>node_metatype</code>-specific rendering. * ! * This function delegates to @c node_metatype::do_render. * * @param[in,out] v the @c viewer to which to render. --- 824,828 ---- * @brief <code>node_metatype</code>-specific rendering. * ! * This function delegates to @c #do_render. * * @param[in,out] v the @c viewer to which to render. *************** *** 894,899 **** * * This function is called during destruction of the @c browser, after the ! * root @c scene has been shut down. This function delegates to @c ! * node_metatype::do_shutdown. * * @param[in] time the current time. --- 900,905 ---- * * This function is called during destruction of the @c browser, after the ! * root @c scene has been shut down. This function delegates to ! * @c #do_shutdown. * * @param[in] time the current time. *************** *** 907,911 **** * @brief Shut down. * ! * This function is called by @c node_metatype::shutdown. * * @param[in] time the current time. --- 913,917 ---- * @brief Shut down. * ! * This function is called by @c #shutdown. * * @param[in] time the current time. *************** *** 923,927 **** /** ! * @class openvrml::node_type * * @brief Type information object for @c node%s. --- 929,933 ---- /** ! * @class openvrml::node_type openvrml/node.h * * @brief Type information object for @c node%s. *************** *** 989,993 **** * @brief Get the set of interfaces for the @c node_type. * ! * This function delegates to @c node_type::do_interfaces. * * @return the set of interfaces. --- 995,999 ---- * @brief Get the set of interfaces for the @c node_type. * ! * This function delegates to @c #do_interfaces. * * @return the set of interfaces. *************** *** 1116,1120 **** /** ! * @class openvrml::field_value_type_mismatch * * @brief Thrown when field value types do not match, generally in a @c ROUTE --- 1122,1126 ---- /** ! * @class openvrml::field_value_type_mismatch openvrml/node.h * * @brief Thrown when field value types do not match, generally in a @c ROUTE *************** *** 1157,1161 **** /** ! * @class openvrml::node * * @brief A @c node in the scene graph. --- 1163,1167 ---- /** ! * @class openvrml::node openvrml/node.h * * @brief A @c node in the scene graph. *************** *** 3048,3052 **** /** ! * @class openvrml::appearance_node * * @brief Abstract base class for appearance nodes. --- 3054,3058 ---- /** ! * @class openvrml::appearance_node openvrml/node.h * * @brief Abstract base class for appearance nodes. *************** *** 3133,3137 **** /** ! * @class openvrml::bounded_volume_node * * @brief Abstract base class for nodes that represent a bounded volume in the --- 3139,3143 ---- /** ! * @class openvrml::bounded_volume_node openvrml/node.h * * @brief Abstract base class for nodes that represent a bounded volume in the *************** *** 3257,3261 **** /** ! * @class openvrml::child_node * * @brief Abstract base class for child nodes. --- 3263,3267 ---- /** ! * @class openvrml::child_node openvrml/node.h * * @brief Abstract base class for child nodes. *************** *** 3383,3387 **** /** ! * @class openvrml::color_node * * @brief Abstract base class for color nodes. --- 3389,3393 ---- /** ! * @class openvrml::color_node openvrml/node.h * * @brief Abstract base class for color nodes. *************** *** 3427,3431 **** /** ! * @class openvrml::color_rgba_node * * @brief Abstract base class for RGBA color nodes. --- 3433,3437 ---- /** ! * @class openvrml::color_rgba_node openvrml/node.h * * @brief Abstract base class for RGBA color nodes. *************** *** 3472,3476 **** /** ! * @class openvrml::coordinate_node * * @brief Abstract base class for coordinate nodes. --- 3478,3482 ---- /** ! * @class openvrml::coordinate_node openvrml/node.h * * @brief Abstract base class for coordinate nodes. *************** *** 3517,3521 **** /** ! * @class openvrml::font_style_node * * @brief Abstract base class for font style nodes. --- 3523,3527 ---- /** ! * @class openvrml::font_style_node openvrml/node.h * * @brief Abstract base class for font style nodes. *************** *** 3632,3636 **** /** ! * @class openvrml::geometry_node * * @brief Abstract base class for geometry nodes. --- 3638,3642 ---- /** ! * @class openvrml::geometry_node openvrml/node.h * * @brief Abstract base class for geometry nodes. *************** *** 3763,3767 **** /** ! * @class openvrml::grouping_node * * @brief Abstract base class for grouping nodes. --- 3769,3773 ---- /** ! * @class openvrml::grouping_node openvrml/node.h * * @brief Abstract base class for grouping nodes. *************** *** 3859,3863 **** /** ! * @class openvrml::light_node * * @brief Abstract base class for light nodes. --- 3865,3869 ---- /** ! * @class openvrml::light_node openvrml/node.h * * @brief Abstract base class for light nodes. *************** *** 3897,3901 **** /** ! * @class openvrml::material_node * * @brief Abstract base class for material nodes. --- 3903,3907 ---- /** ! * @class openvrml::material_node openvrml/node.h * * @brief Abstract base class for material nodes. *************** *** 3982,3986 **** /** ! * @class openvrml::navigation_info_node * * @brief Abstract base class for normal nodes. --- 3988,3992 ---- /** ! * @class openvrml::navigation_info_node openvrml/node.h * * @brief Abstract base class for normal nodes. *************** *** 4061,4065 **** /** ! * @class openvrml::normal_node * * @brief Abstract base class for normal nodes. --- 4067,4071 ---- /** ! * @class openvrml::normal_node openvrml/node.h * * @brief Abstract base class for normal nodes. *************** *** 4105,4109 **** /** ! * @class openvrml::pointing_device_sensor_node * * @brief A node that can be affected by a pointing device. --- 4111,4115 ---- /** ! * @class openvrml::pointing_device_sensor_node openvrml/node.h * * @brief A node that can be affected by a pointing device. *************** *** 4181,4185 **** /** ! * @class openvrml::scoped_light_node * * @brief A light that falls within a specified area. --- 4187,4191 ---- /** ! * @class openvrml::scoped_light_node openvrml/node.h * * @brief A light that falls within a specified area. *************** *** 4241,4245 **** /** ! * @class openvrml::sound_source_node * * @brief Abstract base class for sound source nodes. --- 4247,4251 ---- /** ! * @class openvrml::sound_source_node openvrml/node.h * * @brief Abstract base class for sound source nodes. *************** *** 4278,4282 **** /** ! * @class openvrml::texture_node * * @brief Abstract base class for texture nodes. --- 4284,4288 ---- /** ! * @class openvrml::texture_node openvrml/node.h * * @brief Abstract base class for texture nodes. *************** *** 4394,4398 **** /** ! * @class openvrml::texture_coordinate_node * * @brief Abstract base class for texture coordinate nodes. --- 4400,4404 ---- /** ! * @class openvrml::texture_coordinate_node openvrml/node.h * * @brief Abstract base class for texture coordinate nodes. *************** *** 4440,4444 **** /** ! * @class openvrml::texture_transform_node * * @brief Abstract base class for texture transform nodes. --- 4446,4450 ---- /** ! * @class openvrml::texture_transform_node openvrml/node.h * * @brief Abstract base class for texture transform nodes. *************** *** 4496,4500 **** /** ! * @class openvrml::time_dependent_node * * @brief Abstract base class for time-dependent nodes. --- 4502,4506 ---- /** ! * @class openvrml::time_dependent_node openvrml/node.h * * @brief Abstract base class for time-dependent nodes. *************** *** 4553,4557 **** /** ! * @class openvrml::transform_node * * @brief Abstract base class for transform nodes. --- 4559,4563 ---- /** ! * @class openvrml::transform_node openvrml/node.h * * @brief Abstract base class for transform nodes. *************** *** 4601,4605 **** /** ! * @class openvrml::viewpoint_node * * @brief Abstract base class for viewpoint nodes. --- 4607,4611 ---- /** ! * @class openvrml::viewpoint_node openvrml/node.h * * @brief Abstract base class for viewpoint nodes. *************** *** 4685,4708 **** /** ! * @class openvrml::node_traverser * ! * @brief Traverse the children of each @c node in a node hierarchy only once. * * The @c node_traverser provides a generalized traversal mechanism that * avoids redundantly traversing branches of the @c node hierarchy. If a * @c node occurs multiple places in a branch, <strong>the children of that ! * @c node will be visted in the traversal only once</strong>. * * For each @c node encountered in the traversal, @c node_traverser does the * following: * ! * -# Call @c node_traverser::on_entering. * -# Traverse descendants, if any. ! * -# Call @c node_traverser::on_leaving. * ! * Concrete subclasses of @c node_traverser implement the @c on_entering ! * and/or @c on_leaving member functions in order to perform some operation(s) * on each node. The traversal can be ended prematurely by calling ! * @c node_traverser::halt_traversal. */ --- 4691,4715 ---- /** ! * @class openvrml::node_traverser openvrml/node.h * ! * @brief Traverse the children of each @c node in a @c node hierarchy only ! * once. * * The @c node_traverser provides a generalized traversal mechanism that * avoids redundantly traversing branches of the @c node hierarchy. If a * @c node occurs multiple places in a branch, <strong>the children of that ! * @c node will be visited in the traversal only once</strong>. * * For each @c node encountered in the traversal, @c node_traverser does the * following: * ! * -# Call @c #on_entering. * -# Traverse descendants, if any. ! * -# Call @c #on_leaving. * ! * Concrete subclasses of @c node_traverser implement the @c #on_entering ! * and/or @c #on_leaving member functions in order to perform some operation(s) * on each node. The traversal can be ended prematurely by calling ! * @c #halt_traversal. */ *************** *** 4745,4749 **** * * In addition to @c std::bad_alloc, this function throws any exception thrown ! * from @c on_entering or @c on_leaving. * * @param[in,out] n the root @c node of the branch to traverse. --- 4752,4756 ---- * * In addition to @c std::bad_alloc, this function throws any exception thrown ! * from @c #on_entering or @c #on_leaving. * * @param[in,out] n the root @c node of the branch to traverse. *************** *** 4768,4772 **** * @overload * ! * @brief Traverse a <code>node</code>. * * @param[in,out] node the root node of the branch to traverse. --- 4775,4779 ---- * @overload * ! * @brief Traverse a @c node. * * @param[in,out] node the root node of the branch to traverse. *************** *** 4795,4804 **** /** ! * @brief Traverse a <code>std::vector</code> of <code>node</code>s. * * @overload * ! * @param[in,out] nodes the root @link openvrml::node nodes@endlink of the branch to ! * traverse. */ void --- 4802,4811 ---- /** ! * @brief Traverse a @c std::vector of @c node%s. * * @overload * ! * @param[in,out] nodes the root @link openvrml::node nodes@endlink of the ! * branch to traverse. */ void *************** *** 4831,4839 **** * * If this method is called during a traversal, no more descendant @c node%s ! * will be traversed. Note that if @c halt_traversal is called in the ! * implementation of @c on_entering, @c on_leaving will still be called for * the current node and any parent nodes (that is, any node for which ! * @c on_entering has been called). Implementations of @c on_leaving can call ! * @c node_traverser::halted to check whether the traversal has been halted. */ void openvrml::node_traverser::halt_traversal() OPENVRML_NOTHROW --- 4838,4846 ---- * * If this method is called during a traversal, no more descendant @c node%s ! * will be traversed. Note that if @c #halt_traversal is called in the ! * implementation of @c #on_entering, @c #on_leaving will still be called for * the current node and any parent nodes (that is, any node for which ! * @c #on_entering has been called). Implementations of @c #on_leaving can ! * call @c #halted to check whether the traversal has been halted. */ void openvrml::node_traverser::halt_traversal() OPENVRML_NOTHROW *************** *** 4845,4849 **** * @brief Indicate whether the traversal has been halted. * ! * This function is useful in implementations of @c on_leaving that need to * check whether the traversal has been halted. * --- 4852,4856 ---- * @brief Indicate whether the traversal has been halted. * ! * This function is useful in implementations of @c #on_leaving that need to * check whether the traversal has been halted. * Index: node.h =================================================================== RCS file: /cvsroot/openvrml/openvrml/src/libopenvrml/openvrml/node.h,v retrieving revision 1.57 retrieving revision 1.58 diff -C2 -d -r1.57 -r1.58 *** node.h 6 Aug 2006 03:37:19 -0000 1.57 --- node.h 6 Mar 2007 07:24:01 -0000 1.58 *************** *** 25,32 **** # include <deque> - # include <list> # include <set> # include <utility> - # include <boost/thread/mutex.hpp> # include <boost/thread/recursive_mutex.hpp> # include <openvrml/field_value.h> --- 25,30 ---- Index: vrml97node.cpp =================================================================== RCS file: /cvsroot/openvrml/openvrml/src/libopenvrml/openvrml/vrml97node.cpp,v retrieving revision 1.122 retrieving revision 1.123 diff -C2 -d -r1.122 -r1.123 *** vrml97node.cpp 25 Feb 2007 02:37:13 -0000 1.122 --- vrml97node.cpp 6 Mar 2007 07:24:01 -0000 1.123 *************** *** 16113,16120 **** * @brief Set the bind state. * ! * This function is called by ! * <code>bound_node_stack<BindableNode>::bind</code>. It sets the ! * "bind" state and fires an event; it does not actually put the ! * node onto the bound node stack. * * @param[in] val the bind state. --- 16113,16119 ---- * @brief Set the bind state. * ! * This function is called by @c bound_node_stack<BindableNode>::bind. It ! * sets the “bind” state and fires an event; it does not ! * actually put the node onto the bound node stack. * * @param[in] val the bind state. *************** *** 21482,21486 **** node_metatype(text_metatype::id, browser) { ! # if OPENVRML_ENABLE_RENDER_TEXT_NODE FT_Error error = 0; error = FT_Init_FreeType(&this->freeTypeLibrary); --- 21481,21485 ---- node_metatype(text_metatype::id, browser) { ! # ifdef OPENVRML_ENABLE_RENDER_TEXT_NODE FT_Error error = 0; error = FT_Init_FreeType(&this->freeTypeLibrary); *************** *** 21496,21500 **** text_metatype::~text_metatype() OPENVRML_NOTHROW { ! # if OPENVRML_ENABLE_RENDER_TEXT_NODE FT_Error error = 0; error = FT_Done_FreeType(this->freeTypeLibrary); --- 21495,21499 ---- text_metatype::~text_metatype() OPENVRML_NOTHROW { ! # ifdef OPENVRML_ENABLE_RENDER_TEXT_NODE FT_Error error = 0; error = FT_Done_FreeType(this->freeTypeLibrary); *************** *** 22595,22599 **** OPENVRML_NOTHROW { ! # if OPENVRML_ENABLE_RENDER_TEXT_NODE if (this->face) { FT_Error ftError = FT_Done_Face(this->face); --- 22594,22598 ---- OPENVRML_NOTHROW { ! # ifdef OPENVRML_ENABLE_RENDER_TEXT_NODE if (this->face) { FT_Error ftError = FT_Done_Face(this->face); *************** *** 22603,22607 **** } ! # if OPENVRML_ENABLE_RENDER_TEXT_NODE OPENVRML_LOCAL ptrdiff_t utf8_to_ucs4_(const unsigned char * src_orig, --- 22602,22606 ---- } ! # ifdef OPENVRML_ENABLE_RENDER_TEXT_NODE OPENVRML_LOCAL ptrdiff_t utf8_to_ucs4_(const unsigned char * src_orig, Index: viewer.h =================================================================== RCS file: /cvsroot/openvrml/openvrml/src/libopenvrml/openvrml/viewer.h,v retrieving revision 1.14 retrieving revision 1.15 diff -C2 -d -r1.14 -r1.15 *** viewer.h 22 Jan 2007 23:38:01 -0000 1.14 --- viewer.h 6 Mar 2007 07:24:01 -0000 1.15 *************** *** 23,28 **** # define OPENVRML_VIEWER_H - # include <cstddef> - # include <vector> # include <boost/utility.hpp> # include <openvrml/bounding_volume.h> --- 23,26 ---- Index: viewer.cpp =================================================================== RCS file: /cvsroot/openvrml/openvrml/src/libopenvrml/openvrml/viewer.cpp,v retrieving revision 1.16 retrieving revision 1.17 diff -C2 -d -r1.16 -r1.17 *** viewer.cpp 22 Jan 2007 23:38:01 -0000 1.16 --- viewer.cpp 6 Mar 2007 07:24:01 -0000 1.17 *************** *** 24,27 **** --- 24,33 ---- // + /** + * @file openvrml/viewer.h + * + * @brief Definition of @c openvrml::viewer. + */ + # ifdef HAVE_CONFIG_H # include <config.h> Index: script.cpp =================================================================== RCS file: /cvsroot/openvrml/openvrml/src/libopenvrml/openvrml/script.cpp,v retrieving revision 1.79 retrieving revision 1.80 diff -C2 -d -r1.79 -r1.80 *** script.cpp 1 Jan 2007 21:25:45 -0000 1.79 --- script.cpp 6 Mar 2007 07:24:01 -0000 1.80 *************** *** 32,36 **** /** ! * @class openvrml::script * * @brief Abstract class implemented by scripting language bindings. --- 32,42 ---- /** ! * @file openvrml/script.h ! * ! * @brief Pluggable scripting engine support. ! */ ! ! /** ! * @class openvrml::script openvrml/script.h * * @brief Abstract class implemented by scripting language bindings. *************** *** 292,296 **** /** ! * @class openvrml::script_node_metatype * * @brief Class object for @c script_node%s. --- 298,302 ---- /** ! * @class openvrml::script_node_metatype openvrml/script.h * * @brief Class object for @c script_node%s. *************** *** 335,339 **** /** ! * @class openvrml::script_node * * @brief Represents a VRML Script node. --- 341,345 ---- /** ! * @class openvrml::script_node openvrml/script.h * * @brief Represents a VRML Script node. *************** *** 353,357 **** /** ! * @class openvrml::script_node::eventout * * @brief An @c event_emitter along with the emitted value. --- 359,363 ---- /** ! * @class openvrml::script_node::eventout openvrml/script.h * * @brief An @c event_emitter along with the emitted value. *************** *** 496,500 **** * @internal * ! * @class openvrml::script_node::script_node_type * * @brief Type objects for @c script_node%s. --- 502,506 ---- * @internal * ! * @class openvrml::script_node::script_node_type openvrml/script.h * * @brief Type objects for @c script_node%s. *************** *** 597,603 **** * @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 --- 603,611 ---- * @c script_node constructor. * ! * @param[in] scope the @c scope to which the @c node should ! * belong. ! * @param[in] initial_values a map of initial values for the ! * <code>node</code>'s @c field%s and ! * @c exposedField%s. * * @exception unsupported_interface if @p initial_values specifies a field *************** *** 1023,1027 **** * * @param[in] type the type of listener to create. ! * @param[in] id eventIn identifier. * @param[in] node the containing script_node. * --- 1031,1035 ---- * * @param[in] type the type of listener to create. ! * @param[in] id @c eventIn identifier. * @param[in] node the containing script_node. * *************** *** 1193,1197 **** * @internal * ! * @class openvrml::script_node::set_url_listener_t * * @brief @c set_url event listener. --- 1201,1205 ---- * @internal * ! * @class openvrml::script_node::set_url_listener_t openvrml/script.h * * @brief @c set_url event listener. *************** *** 1229,1233 **** * @brief Process an event. * ! * @param[in] value new url value. * @param[in] timestamp the current time. * --- 1237,1241 ---- * @brief Process an event. * ! * @param[in] value new @c url value. * @param[in] timestamp the current time. * *************** *** 1256,1260 **** * @internal * ! * @class openvrml::script_node::url_changed_emitter * * @brief @c url_changed event emitter. --- 1264,1268 ---- * @internal * ! * @class openvrml::script_node::url_changed_emitter openvrml/script.h * * @brief @c url_changed event emitter. *************** *** 1279,1285 **** /** ! * @brief The eventOut identifier. * ! * @return the eventOut identifier. */ const std::string --- 1287,1293 ---- /** ! * @brief The @c eventOut identifier. * ! * @return the @c eventOut identifier. */ const std::string *************** *** 1292,1298 **** * @internal * ! * @class openvrml::script_node::set_metadata_listener * ! * @brief set_metadata event listener. */ --- 1300,1306 ---- * @internal * ! * @class openvrml::script_node::set_metadata_listener openvrml/script.h * ! * @brief @c set_metadata event listener. */ *************** *** 1300,1304 **** * @brief Construct. * ! * @param[in] node a reference to the containing script_node. */ openvrml::script_node::set_metadata_listener:: --- 1308,1312 ---- * @brief Construct. * ! * @param[in] node a reference to the containing @c script_node. */ openvrml::script_node::set_metadata_listener:: *************** *** 1315,1321 **** /** ! * @brief Get the eventIn identifier. * ! * @return the eventIn identifier. */ const std::string --- 1323,1329 ---- /** ! * @brief Get the @c eventIn identifier. * ! * @return the @c eventIn identifier. */ const std::string *************** *** 1352,1358 **** * @internal * ! * @class openvrml::script_node::metadata_changed_emitter * ! * @brief metadata_changed event emitter. */ --- 1360,1366 ---- * @internal * ! * @class openvrml::script_node::metadata_changed_emitter openvrml/script.h * ! * @brief @c metadata_changed event emitter. */ *************** *** 1411,1415 **** * @var openvrml::sfbool openvrml::script_node::direct_output * ! * @brief directOutput field. */ --- 1419,1423 ---- * @var openvrml::sfbool openvrml::script_node::direct_output * ! * @brief @c directOutput field. */ *************** *** 1419,1423 **** * @var openvrml::sfbool openvrml::script_node::must_evaluate * ! * @brief mustEvaluate field. */ --- 1427,1431 ---- * @var openvrml::sfbool openvrml::script_node::must_evaluate * ! * @brief @c mustEvaluate field. */ *************** *** 1427,1431 **** * @var openvrml::script_node::set_url_listener_t openvrml::script_node::set_url_listener * ! * @brief set_url eventIn handler. */ --- 1435,1439 ---- * @var openvrml::script_node::set_url_listener_t openvrml::script_node::set_url_listener * ! * @brief @c set_url @c eventIn handler. */ *************** *** 1435,1439 **** * @var openvrml::mfstring openvrml::script_node::url_ * ! * @brief url exposedField. */ --- 1443,1447 ---- * @var openvrml::mfstring openvrml::script_node::url_ * ! * @brief @c url @c exposedField. */ *************** *** 1499,1504 **** * @var int openvrml::script_node::events_received * ! * @brief A count of the number of events received since script_node::update ! * was called. */ --- 1507,1512 ---- * @var int openvrml::script_node::events_received * ! * @brief A count of the number of events received since @c #update was ! * called. */ *************** *** 1510,1517 **** * directly when creating a new @c script_node from scratch. However, a * @c script_node can be duplicated (or “cloned”) 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 --- 1518,1524 ---- * directly when creating a new @c script_node from scratch. However, a * @c script_node can be duplicated (or “cloned”) by calling ! * @c node_type::create_node on @c #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 *************** *** 1693,1699 **** * @internal * ! * @brief Return a pointer to this script_node. * ! * @return a pointer to this script_node. */ openvrml::script_node * openvrml::script_node::to_script() OPENVRML_NOTHROW --- 1700,1706 ---- * @internal * ! * @brief Return a pointer to this @c script_node. * ! * @return a pointer to this @c script_node. */ openvrml::script_node * openvrml::script_node::to_script() OPENVRML_NOTHROW *************** *** 1739,1745 **** * @fn const openvrml::script_node::eventout_map_t & openvrml::script_node::eventout_map() const * ! * @brief eventOut map accessor. * ! * @return the eventOut map. */ --- 1746,1752 ---- * @fn const openvrml::script_node::eventout_map_t & openvrml::script_node::eventout_map() const * ! * @brief @c eventOut map accessor. * ! * @return the @c eventOut map. */ *************** *** 1748,1752 **** * * @brief Special assignment function to take into account the fact that ! * Script nodes can be self referential. * * “Undo” the refcounting appropriately: decrement the refcount on --- 1755,1759 ---- * * @brief Special assignment function to take into account the fact that ! * Script nodes can be self-referential. * * “Undo” the refcounting appropriately: decrement the refcount on *************** *** 1754,1759 **** * any self-references for which ownership is relinquished. * ! * @param[in] inval input sfnode. ! * @param[out] retval output sfnode. */ void openvrml::script_node::assign_with_self_ref_check(const sfnode & inval, --- 1761,1766 ---- * any self-references for which ownership is relinquished. * ! * @param[in] inval input @c sfnode. ! * @param[out] retval output @c sfnode. */ void openvrml::script_node::assign_with_self_ref_check(const sfnode & inval, *************** *** 1802,1807 **** * any self-references for which ownership is relinquished. * ! * @param[in] inval input mfnode. ! * @param[out] retval output mfnode. */ void openvrml::script_node::assign_with_self_ref_check(const mfnode & inval, --- 1809,1814 ---- * any self-references for which ownership is relinquished. * ! * @param[in] inval input @c mfnode. ! * @param[out] retval output @c mfnode. */ void openvrml::script_node::assign_with_self_ref_check(const mfnode & inval, *************** *** 1890,1901 **** * @brief Get an event listener. * ! * This method is called by node::event_listener. Subclasses must implement ! * this method. * ! * @param[in] id eventIn identifier. * * @return the event listener. * ! * @exception unsupported_interface if the node has no eventIn @p id. */ openvrml::event_listener & --- 1897,1908 ---- * @brief Get an event listener. * ! * This method is called by @c node::event_listener. Subclasses must ! * implement this method. * ! * @param[in] id @c eventIn identifier. * * @return the event listener. * ! * @exception unsupported_interface if the node has no @c eventIn @p id. */ openvrml::event_listener & *************** *** 1923,1933 **** * @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. */ openvrml::event_emitter & --- 1930,1940 ---- * @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. */ openvrml::event_emitter & *************** *** 1968,1978 **** * @fn const openvrml::script_node::eventout_map_t & openvrml::script_node::eventout_map() const * ! * @brief eventOut map. * ! * @return the eventOut map. */ /** ! * @brief Called by node::shutdown. * * @param[in] timestamp the current time. --- 1975,1985 ---- * @fn const openvrml::script_node::eventout_map_t & openvrml::script_node::eventout_map() const * ! * @brief @c eventOut map. * ! * @return the @c eventOut map. */ /** ! * @brief Called by @c node::shutdown. * * @param[in] timestamp the current time. *************** *** 1985,1989 **** /** ! * @brief render_child implementation. * * @param[in,out] v viewer implementation responsible for actually --- 1992,1996 ---- /** ! * @brief @c node::render_child implementation. * * @param[in,out] v viewer implementation responsible for actually *************** *** 2662,2666 **** /** ! * @class Base class template for SFColor, SFNode, SFRotation, * SFVec2f, SFVec3f. */ --- 2669,2673 ---- /** ! * @brief Base class template for SFColor, SFNode, SFRotation, * SFVec2f, SFVec3f. */ *************** *** 2690,2694 **** /** ! * @class Base class template for MFFloat, MFTime. * * In JavaScript, all floating point values are treated as doubles. --- 2697,2701 ---- /** ! * @brief Base class template for MFFloat, MFTime. * * In JavaScript, all floating point values are treated as doubles. Index: exposedfield.cpp =================================================================== RCS file: /cvsroot/openvrml/openvrml/src/libopenvrml/openvrml/exposedfield.cpp,v retrieving revision 1.6 retrieving revision 1.7 diff -C2 -d -r1.6 -r1.7 *** exposedfield.cpp 24 Jul 2006 23:55:14 -0000 1.6 --- exposedfield.cpp 6 Mar 2007 07:24:01 -0000 1.7 *************** *** 27,30 **** --- 27,36 ---- /** + * @file openvrml/exposedfield.h + * + * @brief Definition of @c openvrml::exposedfield. + */ + + /** * @class openvrml::exposedfield * Index: event.cpp =================================================================== RCS file: /cvsroot/openvrml/openvrml/src/libopenvrml/openvrml/event.cpp,v retrieving revision 1.14 retrieving revision 1.15 diff -C2 -d -r1.14 -r1.15 *** event.cpp 23 Aug 2006 15:02:04 -0000 1.14 --- event.cpp 6 Mar 2007 07:24:01 -0000 1.15 *************** *** 27,31 **** /** ! * @class openvrml::event_listener * * @brief Abstract base class of event listeners. --- 27,37 ---- /** ! * @file openvrml/event.h ! * ! * @brief Event emitter and listener interfaces. ! */ ! ! /** ! * @class openvrml::event_listener openvrml/event.h * * @brief Abstract base class of event listeners. *************** *** 56,60 **** /** ! * @class openvrml::node_event_listener * * @brief Base class for event listeners of nodes. --- 62,66 ---- /** ! * @class openvrml::node_event_listener openvrml/event.h * * @brief Base class for event listeners of nodes. *************** *** 120,124 **** /** ! * @class openvrml::field_value_listener * * @brief Concrete event listener template. --- 126,130 ---- /** ! * @class openvrml::field_value_listener openvrml/event.h * * @brief Concrete event listener template. *************** *** 352,356 **** /** ! * @class openvrml::node_field_value_listener * * @brief Base class for @c field_value_listener%s that are members of nodes. --- 358,362 ---- /** ! * @class openvrml::node_field_value_listener openvrml/event.h * * @brief Base class for @c field_value_listener%s that are members of nodes. *************** *** 373,377 **** /** ! * @class openvrml::event_emitter * * @brief Abstract base class of event emitters. --- 379,383 ---- /** ! * @class openvrml::event_emitter openvrml/event.h * * @brief Abstract base class of event emitters. *************** *** 548,552 **** /** ! * @class openvrml::field_value_emitter * * @brief Concrete event emitter template. --- 554,558 ---- /** ! * @class openvrml::field_value_emitter openvrml/event.h * * @brief Concrete event emitter template. Index: frustum.cpp =================================================================== RCS file: /cvsroot/openvrml/openvrml/src/libopenvrml/openvrml/frustum.cpp,v retrieving revision 1.8 retrieving revision 1.9 diff -C2 -d -r1.8 -r1.9 *** frustum.cpp 25 Feb 2006 08:37:27 -0000 1.8 --- frustum.cpp 6 Mar 2007 07:24:01 -0000 1.9 *************** *** 29,32 **** --- 29,38 ---- /** + * @file openvrml/frustum.h + * + * @brief Definition of @c openvrml::frustum. + */ + + /** * @class openvrml::frustum * Index: browser.cpp =================================================================== RCS file: /cvsroot/openvrml/openvrml/src/libopenvrml/openvrml/browser.cpp,v retrieving revision 1.205 retrieving revision 1.206 diff -C2 -d -r1.205 -r1.206 *** browser.cpp 6 Mar 2007 03:26:15 -0000 1.205 --- browser.cpp 6 Mar 2007 07:24:00 -0000 1.206 *************** *** 64,67 **** --- 64,73 ---- # include "x3d_cad_geometry.h" + /** + * @file openvrml/browser.h + * + * @brief Classes that manage the scene. + */ + namespace openvrml { *************** *** 104,110 **** * * 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 { --- 110,116 ---- * * 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 { *************** *** 439,459 **** * And @c proto_node_type has, in turn, a many-to-one relationship with * the @c proto_node_metatype instance that creates them. Unlike a ! * typical node implementation, there will very likely be more than one @c ! * proto_node_metatype instance known to the @c browser instance; there * will be one for each @c PROTO known to the @c browser. * ! * As the @c proto_node_metatype encodes the data in a @c PROTO, the @c ! * proto_node_type can be seen as modeling @c EXTERNPROTO. Each @c ! * EXTERNPROTO will spawn a new @c proto_node_type from the @c ! * proto_node_metatype that corresponds to the @c PROTO to which the @c ! * EXTERNPROTO refers. Recall that an @c EXTERNPROTO provides a subset of ! * the interfaces defined for a @c PROTO; thus, for a @c PROTO with ! * <var>n</var> interfaces, there are <var>n</var>! possible unique @c ! * EXTERNPROTO%s (and thus unique @c proto_node_type instances). * * Structurally, the implementation of @c proto_node is very similar to * that of @c proto_node_metatype. The difference is that event pathways ! * for @c ROUTE%s and @c IS mappings are actually created in the @c ! * proto_node. The @c proto_node_metatype, on the other hand, includes * metadata about how these event pathways @e should be created. */ --- 445,465 ---- * And @c proto_node_type has, in turn, a many-to-one relationship with * the @c proto_node_metatype instance that creates them. Unlike a ! * typical node implementation, there will very likely be more than one ! * @c proto_node_metatype instance known to the @c browser instance; there * will be one for each @c PROTO known to the @c browser. * ! * As the @c proto_node_metatype encodes the data in a @c PROTO, the ! * @c proto_node_type can be seen as modeling @c EXTERNPROTO. Each ! * @c EXTERNPROTO will spawn a new @c proto_node_type from the ! * @c proto_node_metatype that corresponds to the @c PROTO to which the ! * @c EXTERNPROTO refers. Recall that an @c EXTERNPROTO provides a subset ! * of the interfaces defined for a @c PROTO; thus, for a @c PROTO with ! * <var>n</var> interfaces, there are <var>n</var>! possible unique ! * @c EXTERNPROTO%s (and thus unique @c proto_node_type instances). * * Structurally, the implementation of @c proto_node is very similar to * that of @c proto_node_metatype. The difference is that event pathways ! * for @c ROUTE%s and @c IS mappings are actually created in the ! * @c proto_node. The @c proto_node_metatype, on the other hand, includes * metadata about how these event pathways @e should be created. */ *************** *** 580,585 **** /** ! * @brief A node path is used to store the path to a node for the purpose ! * of duplicating a route in a cloned node hierarchy. */ typedef std::list<node_path_element> node_path_t; --- 586,591 ---- /** ! * @brief A @c node path is used to store the path to a @c node for the ! * purpose of duplicating a route in a cloned @c node hierarchy. */ typedef std::list<node_path_element> node_path_t; *************** *** 2567,2571 **** * @brief Construct. * ! * @param[in] t node type. */ default_navigation_info:: --- 2573,2577 ---- * @brief Construct. * ! * @param[in] t @c node_type. */ default_navigation_info:: *************** *** 3601,3607 **** * @param[in] uri URI associated with @p in. * @param[in] type MIME media type of the data to be read from @p in. ! * @param[in] scene a scene. ! * @param[out] nodes the root nodes. ! * @param[out] meta the scene metadata. * * @exception openvrml::bad_media_type --- 3607,3613 ---- * @param[in] uri URI associated with @p in. * @param[in] type MIME media type of the data to be read from @p in. ! * @param[in] scene a @c scene. ! * @param[out] nodes the root @c node%s. ! * @param[out] meta the @c scene metadata. * * @exception openvrml::bad_media_type *************** *** 4523,4527 **** /** ! * @class openvrml::resource_istream * * @brief An abstract input stream for network resources. --- 4529,4533 ---- /** ! * @class openvrml::resource_istream openvrml/browser.h * * @brief An abstract input stream for network resources. *************** *** 4553,4557 **** * @brief Get the URL associated with the stream. * ! * This function delegates to @c do_url. * * @return the URL associated with the stream. --- 4559,4563 ---- * @brief Get the URL associated with the stream. * ! * This function delegates to @c #do_url. * * @return the URL associated with the stream. *************** *** 4576,4580 **** * @brief Get the MIME content type associated with the stream. * ! * This function delegates to @c do_type. * * @return the MIME content type associated with the stream. --- 4582,4586 ---- * @brief Get the MIME content type associated with the stream. * ! * This function delegates to @c #do_type. * * @return the MIME content type associated with the stream. *************** *** 4597,4601 **** * @brief Indicates whether data is available to be read from the stream. * ! * This function delegates to @c do_data_available. * * @return @c true if there is data in the stream buffer to be read; @c false --- 4603,4607 ---- * @brief Indicates whether data is available to be read from the stream. * ! * This function delegates to @c #do_data_available. * * @return @c true if there is data in the stream buffer to be read; @c false *************** *** 4654,4663 **** * @brief Fetch a network resource. * ! * Called by @c resource_fetcher::get_resource, clients of OpenVRML are ! * required to provide an implementation for this function. OpenVRML depends ! * on the implementation of this function for all of its input needs. As ! * such, what kind of resources OpenVRML is capable of resolving is entirely ! * dependent on code provided by the application. A trivial implementation ! * designed to handle only @c file resources can use @c std::filebuf: * * @code --- 4660,4669 ---- * @brief Fetch a network resource. * ! * Called by @c #get_resource, clients of OpenVRML are required to provide an ! * implementation for this function. OpenVRML depends on the implementation ! * of this function for all of its input needs. As such, what kind of ! * resources OpenVRML is capable of resolving is entirely dependent on code ! * provided by the application. A trivial implementation designed to handle ! * only @c file resources can use @c std::filebuf: * * @code *************** *** 4773,4780 **** /** ! * @class openvrml::stream_listener * ! * @brief An interface to simplify asynchronously reading a @c ! * resource_istream. */ --- 4779,4786 ---- /** ! * @class openvrml::stream_listener openvrml/browser.h * ! * @brief An interface to simplify asynchronously reading a ! * @c resource_istream. */ *************** *** 4788,4792 **** * @brief Called once the stream is available for use. * ! * This function calls @c stream_listener::do_stream_available. * * @param[in] uri the URI associated with the stream. --- 4794,4798 ---- * @brief Called once the stream is available for use. * ! * This function calls @c #do_stream_available. * * @param[in] uri the URI associated with the stream. *************** *** 4803,4807 **** * @fn void openvrml::stream_listener::do_stream_available(const std::string & uri, const std::string & media_type) * ! * @brief Called by @c stream_listener::stream_available. * * Concrete @c stream_listener%s must override this function. --- 4809,4813 ---- * @fn void openvrml::stream_listener::do_stream_available(const std::string & uri, const std::string & media_type) * ! * @brief Called by @c #stream_available. * * Concrete @c stream_listener%s must override this function. *************** *** 4814,4818 **** * @brief Called when data is available. * ! * This function calls @c stream_listener::do_data_available. * * @param[in] data the data. --- 4820,4824 ---- * @brief Called when data is available. * ! * This function calls @c #do_data_available. * * @param[in] data the data. *************** *** 4828,4832 **** * @fn void openvrml::stream_listener::do_data_available(const std::vector<unsigned char> & data) * ! * @brief Called by @c stream_listener::data_available. * * @param[in] data the data. --- 4834,4838 ---- * @fn void openvrml::stream_listener::do_data_available(const std::vector<unsigned char> & data) * ! * @brief Called by @c #data_available. * * @param[in] data the data. *************** *** 4887,4891 **** /** ! * @class openvrml::invalid_vrml * * @brief Exception thrown when the parser fails due to errors in the VRML --- 4893,4897 ---- /** ! * @class openvrml::invalid_vrml openvrml/browser.h * * @brief Exception thrown when the parser fails due to errors in the VRML *************** *** 4937,4941 **** /** ! * @class openvrml::viewer_in_use * * @brief Exception thrown when attempting to associate a @c viewer --- 4943,4947 ---- /** ! * @class openvrml::viewer_in_use openvrml/browser.h * * @brief Exception thrown when attempting to associate a @c viewer *************** *** 4959,4963 **** /** ! * @class openvrml::browser_event * * @brief A <code>browser</code>-wide event. --- 4965,4969 ---- /** ! * @class openvrml::browser_event openvrml/browser.h * * @brief A <code>browser</code>-wide event. *************** *** 5043,5047 **** /** ! * @class openvrml::browser_listener * * @brief This class should be inherited by classes that want to listen for --- 5049,5053 ---- /** ! * @class openvrml::browser_listener openvrml/browser.h * * @brief This class should be inherited by classes that want to listen for *************** *** 5054,5059 **** * @var openvrml::browser_listener::browser * ! * @brief @c browser instances need to call @c ! * browser_listener::browser_changed. */ --- 5060,5064 ---- * @var openvrml::browser_listener::browser * ! * @brief @c browser instances need to call @c #browser_changed. */ *************** *** 5069,5074 **** * @brief Send a @c browser_event. * ! * This function delegates to ! * @c browser_listener::do_browser_changed. * * @param[in] event the @c browser_event to send. --- 5074,5078 ---- * @brief Send a @c browser_event. * ! * This function delegates to @c #do_browser_changed. * * @param[in] event the @c browser_event to send. *************** *** 5087,5091 **** /** ! * @class openvrml::browser * * @brief Encapsulates a VRML browser. --- 5091,5095 ---- /** ! * @class openvrml::browser openvrml/browser.h * * @brief Encapsulates a VRML browser. *************** *** 5125,5129 **** * @internal * ! * @class openvrml::browser::node_metatype_map * * @brief The map of @c node_metatype%s. --- 5129,5133 ---- * @internal * ! * @class openvrml::browser::node_metatype_map openvrml/browser.h * * @brief The map of @c node_metatype%s. *************** *** 5425,5433 **** * @internal * * @var boost::thread_group openvrml::browser::load_proto_thread_group_ * ! * @brief The threads that load EXTERNPROTO implementations. * ! * These threads @b must be joined by the browser before it is destroyed. */ --- 5429,5448 ---- * @internal * + * @var boost::scoped_ptr<boost::thread> openvrml::browser::load_root_scene_thread_ + * + * @brief The thread that loads the root scene. + * + * This thread is spawned by @c #load_url. It is joined there (in a subsequent + * call to @c #load_url) or when the @c browser is destroyed. + */ + + /** + * @internal + * * @var boost::thread_group openvrml::browser::load_proto_thread_group_ * ! * @brief The threads that load @c EXTERNPROTO implementations. * ! * These threads @b must be joined by the @c browser before it is destroyed. */ *************** *** 5445,5449 **** * @var openvrml::script_node_metatype openvrml::browser::script_node_metatype_ * ! * @brief @c node_metatype for Script nodes in the browser. */ --- 5460,5464 ---- * @var openvrml::script_node_metatype openvrml::browser::script_node_metatype_ * ! * @brief @c node_metatype for Script @c node%s in the @c browser. */ *************** *** 5453,5457 **** * @var openvrml::scene * openvrml::browser::scene_ * ! * @brief Pointer to the root scene. */ --- 5468,5472 ---- * @var openvrml::scene * openvrml::browser::scene_ * ! * @brief Pointer to the root @c scene. */ *************** *** 5461,5466 **** * @var boost::intrusive_ptr<openvrml::node> openvrml::browser::default_viewpoint_ * ! * @brief The “default” @c viewpoint_node used when no @c ! * viewpoint_node in the scene is bound. */ --- 5476,5481 ---- * @var boost::intrusive_ptr<openvrml::node> openvrml::browser::default_viewpoint_ * ! * @brief The “default” @c viewpoint_node used when no ! * @c viewpoint_node in the scene is bound. */ *************** *** 5495,5499 **** * @var std::list<openvrml::viewpoint_node *> openvrml::browser::viewpoint_list * ! * @brief A list of all the Viewpoint nodes in the browser. */ --- 5510,5514 ---- * @var std::list<openvrml::viewpoint_node *> openvrml::browser::viewpoint_list * ! * @brief A list of all the Viewpoint @c node%s in the @c browser. */ *************** *** 5503,5507 **** * @var std::list<openvrml::node *> openvrml::browser::scoped_lights * ! * @brief A list of all the scoped light nodes in the browser. */ --- 5518,5522 ---- * @var std::list<openvrml::node *> openvrml::browser::scoped_lights * ! * @brief A list of all the scoped light @c node%s in the @c browser. */ *************** *** 5511,5515 **** * @var std::list<openvrml::script_node *> openvrml::browser::scripts * ! * @brief A list of all the Script nodes in the browser. */ --- 5526,5530 ---- * @var std::list<openvrml::script_node *> openvrml::browser::scripts * ! * @brief A list of all the Script @c node%s in the @c browser. */ *************** *** 5519,5523 **** * @var std::list<openvrml::time_dependent_node *> openvrml::browser::timers * ! * @brief A list of all the TimeSensor nodes in the browser. */ --- 5534,5538 ---- * @var std::list<openvrml::time_dependent_node *> openvrml::browser::timers * ! * @brief A list of all the TimeSensor @c node%s in the @c browser. */ *************** *** 5527,5532 **** * @var std::set<openvrml::browser_listener *> openvrml::browser::listeners_ * ! * @brief The set of @c browser_listener%s that will receive @c ! * browser_event%s. * * @sa openvrml::browser::add_listener --- 5542,5547 ---- * @var std::set<openvrml::browser_listener *> openvrml::browser::listeners_ * ! * @brief The set of @c browser_listener%s that will receive ! * @c browser_event%s. * * @sa openvrml::browser::add_listener *************** *** 5543,5547 **** * @var boost::mutex openvrml::browser::modified_mutex_ * ! * @brief Mutex protecting @c browser::modified_. */ --- 5558,5562 ---- * @var boost::mutex openvrml::browser::modified_mutex_ * ! * @brief Mutex protecting @c #modified_. */ *************** *** 5596,5600 **** * @var boost::mutex openvrml::browser::out_mutex_ * ! * @brief Mutex guarding @a out_. */ --- 5611,5615 ---- * @var boost::mutex openvrml::browser::out_mutex_ * ! * @brief Mutex guarding @c #out_. */ *************** *** 5608,5612 **** * @var boost::mutex openvrml::browser::err_mutex_ * ! * @brief Mutex guarding @a err_. */ --- 5623,5627 ---- * @var boost::mutex openvrml::browser::err_mutex_ * ! * @brief Mutex guarding @c #err_. */ *************** *** 5621,5629 **** * * @brief Set by @c node::bounding_volume_dirty on any node in this browser graph, ! * cleared by @c update_flags. * ! * @c true if the bvolume dirty flag has been set on a node in the ! * browser graph, but has not yet been propagated to that node's ! * ancestors. */ --- 5636,5644 ---- * * @brief Set by @c node::bounding_volume_dirty on any node in this browser graph, ! * cleared by @c #update_flags. * ! * @c true if the bvolume dirty flag has been set on a @c node in the ! * @c browser graph, but has not yet been propagated to that ! * <code>node</code>'s ancestors. */ *************** *** 5713,5720 **** * the browser, it will be replaced. * ! * @warning If @c std::bad_alloc is thrown here, the <code>browser</code>'s @c ! * node_metatype map is left in an unknown state. In all likelihood ! * any preexisting entry in the map with the same implementation ! * identifier as @p id will have been removed. * * @param[in] id a @c node_metatype identifier. --- 5728,5735 ---- * the browser, it will be replaced. * ! * @warning If @c std::bad_alloc is thrown here, the <code>browser</code>'s ! * @c node_metatype map is left in an unknown state. In all ! * likelihood any preexisting entry in the map with the same ! * implementation identifier as @p id will have been removed. * * @param[in] id a @c node_metatype identifier. *************** *** 5932,5940 **** /** ! * @brief Get the list of @link viewpoint_node viewpoint_nodes@endlink for the ! * world. * ! * @return the list of @link viewpoint_node viewpoint_nodes@endlink for the ! * world. */ const std::list<openvrml::viewpoint_node *> & --- 5947,5953 ---- /** ! * @brief Get the list of @c viewpoint_node%s for the world. * ! * @return the list of @c viewpoint_node%s for the world. */ const std::list<openvrml::viewpoint_node *> & *************** *** 5989,5993 **** * @brief Get the @c browser version. * ! * @return the version of openvrml. * * Specific browsers may wish to override this method. --- 6002,6006 ---- * @brief Get the @c browser version. * ! * @return the version of OpenVRML. * * Specific browsers may wish to override this method. *************** *** 6709,6714 **** * The invariant is that if a <code>node</code>'s bounding volume is out of * date, then the bounding volumes of all that <code>node</code>'s ancestors ! * must be out of date. However, @c node does not maintain a parent pointer. So ! * we must d... [truncated message content] |
