|
From: <br...@us...> - 2008-08-15 22:48:35
|
Revision: 3516
http://openvrml.svn.sourceforge.net/openvrml/?rev=3516&view=rev
Author: braden
Date: 2008-08-15 22:48:45 +0000 (Fri, 15 Aug 2008)
Log Message:
-----------
Improved doc-comment.
Modified Paths:
--------------
trunk/ChangeLog
trunk/src/libopenvrml/openvrml/browser.cpp
Modified: trunk/ChangeLog
===================================================================
--- trunk/ChangeLog 2008-08-15 20:29:54 UTC (rev 3515)
+++ trunk/ChangeLog 2008-08-15 22:48:45 UTC (rev 3516)
@@ -1,5 +1,11 @@
2008-08-15 Braden McDaniel <br...@en...>
+ * src/libopenvrml/openvrml/browser.cpp
+ (openvrml::browser::load_url(const std::vector<std::string> &,
+ const std::vector<std::string> &)): Improved doc-comment.
+
+2008-08-15 Braden McDaniel <br...@en...>
+
* src/libopenvrml/openvrml/node.cpp: Symbols with internal linkage
don't need visibility attributes.
Modified: trunk/src/libopenvrml/openvrml/browser.cpp
===================================================================
--- trunk/src/libopenvrml/openvrml/browser.cpp 2008-08-15 20:29:54 UTC (rev 3515)
+++ trunk/src/libopenvrml/openvrml/browser.cpp 2008-08-15 22:48:45 UTC (rev 3516)
@@ -10757,13 +10757,21 @@
};
/**
- * @brief Load a VRML world into the browser.
+ * @brief Asynchronously load a VRML world into the @c browser.
*
+ * This function takes an alternative URI list consistent with such lists as
+ * they appear in VRML nodes. @c openvrml::browser_event::initialized will be
+ * emitted once the world has been loaded and initialized.
+ *
+ * For synchronously loading a world, see @c #set_world.
+ *
* @param[in] url a URI.
* @param[in] parameter parameters for @p url.
*
* @exception std::bad_alloc if memory allocation fails.
* @exception boost::thread_resource_error if thread creation fails.
+ *
+ * @sa #set_world
*/
void openvrml::browser::load_url(const std::vector<std::string> & url,
const std::vector<std::string> &)
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|