Update of /cvsroot/openvrml/openvrml/src/libopenvrml/openvrml
In directory sc8-pr-cvs3.sourceforge.net:/tmp/cvs-serv19410/src/libopenvrml/openvrml
Modified Files:
browser.cpp
Log Message:
Doc-comment improvements.
Index: browser.cpp
===================================================================
RCS file: /cvsroot/openvrml/openvrml/src/libopenvrml/openvrml/browser.cpp,v
retrieving revision 1.181
retrieving revision 1.182
diff -C2 -d -r1.181 -r1.182
*** browser.cpp 25 Jul 2006 05:11:14 -0000 1.181
--- browser.cpp 25 Jul 2006 06:17:56 -0000 1.182
***************
*** 7521,7530 ****
/**
! * @brief Load the scene from a stream.
*
* @param[in,out] in an input stream.
*
! * @exception bad_media_type if @p in.type() is not "model/vrml",
! * "x-world/x-vrml", or "model/x3d+vrml".
* @exception invalid_vrml if @p in has invalid syntax.
*/
--- 7521,7532 ----
/**
! * @brief Load the @c scene from a stream.
*
* @param[in,out] in an input stream.
*
! * @exception bad_media_type if @p in.type() is not
! * “model/vrml”,
! * “x-world/x-vrml”, or
! * “model/x3d+vrml”.
* @exception invalid_vrml if @p in has invalid syntax.
*/
***************
*** 7544,7548 ****
/**
! * @brief Initialize the scene.
*
* @param[in] timestamp the current time.
--- 7546,7550 ----
/**
! * @brief Initialize the @c scene.
*
* @param[in] timestamp the current time.
***************
*** 7632,7638 ****
/**
! * @brief Root nodes for the scene.
*
! * @return the root nodes for the scene.
*/
const std::vector<boost::intrusive_ptr<openvrml::node> > &
--- 7634,7640 ----
/**
! * @brief Root @c node%s for the @c scene.
*
! * @return the root @c node%s for the @c scene.
*/
const std::vector<boost::intrusive_ptr<openvrml::node> > &
***************
*** 7647,7656 ****
*
* This function calls @c scene::shutdown to shut down the
! * <code>scene</code>'s existing nodes.
*
* @param[in] n the new root nodes for the @c scene.
*
! * @exception std::invalid_argument if any of the nodes in @p n has already been
! * initialized.
* @exception std::bad_alloc if memory allocation fails.
*/
--- 7649,7658 ----
*
* This function calls @c scene::shutdown to shut down the
! * <code>scene</code>'s existing @c node%s.
*
* @param[in] n the new root nodes for the @c scene.
*
! * @exception std::invalid_argument if any of the @c node%s in @p n has
! * already been initialized.
* @exception std::bad_alloc if memory allocation fails.
*/
***************
*** 7676,7682 ****
/**
! * @brief Get the root scope.
*
! * @return the root scope.
*/
const openvrml::scope * openvrml::scene::root_scope() const
--- 7678,7684 ----
/**
! * @brief Get the root @c scope.
*
! * @return the root @c scope.
*/
const openvrml::scope * openvrml::scene::root_scope() const
***************
*** 7690,7696 ****
/**
! * @brief Get the absolute URI for the scene.
*
! * @return the absolute URI for the scene.
*
* @exception std::bad_alloc if memory allocation fails.
--- 7692,7698 ----
/**
! * @brief Get the absolute URI for the @c scene.
*
! * @return the absolute URI for the @c scene.
*
* @exception std::bad_alloc if memory allocation fails.
***************
*** 7731,7735 ****
*
* This method simply resolves any relative references in @p uri and calls
! * browser::load_url.
*
* @note There are a couple of edge cases here where we are probably doing the
--- 7733,7737 ----
*
* This method simply resolves any relative references in @p uri and calls
! * @c browser::load_url.
*
* @note There are a couple of edge cases here where we are probably doing the
***************
*** 7791,7795 ****
*
* Relative URIs in @p url are resolved against the absolute URI of the
! * <code>scene</code>.
*
* @param[in] url a list of alternative URIs.
--- 7793,7797 ----
*
* Relative URIs in @p url are resolved against the absolute URI of the
! * @c scene.
*
* @param[in] url a list of alternative URIs.
|
