Menu
▾
▴
SF.net SVN: openvrml:[3698] trunk
|
From: <br...@us...> - 2008-09-28 02:40:50
|
Revision: 3698
http://openvrml.svn.sourceforge.net/openvrml/?rev=3698&view=rev
Author: braden
Date: 2008-09-28 02:40:43 +0000 (Sun, 28 Sep 2008)
Log Message:
-----------
Documentation improvements. No longer use the Doxygen default style sheet at all. Also, added X3D link to the page footer.
Modified Paths:
--------------
trunk/ChangeLog
trunk/doc/Doxyfile
trunk/doc/doxygen-footer
trunk/doc/doxygen-header
trunk/src/libopenvrml/openvrml/browser.cpp
trunk/src/libopenvrml/openvrml/local/proto.cpp
trunk/src/libopenvrml/openvrml/local/proto.h
trunk/src/libopenvrml/openvrml/node.cpp
trunk/src/libopenvrml/openvrml/script.cpp
Added Paths:
-----------
trunk/doc/manual/x3d-white-on-black.png
Modified: trunk/ChangeLog
===================================================================
--- trunk/ChangeLog 2008-09-27 07:43:08 UTC (rev 3697)
+++ trunk/ChangeLog 2008-09-28 02:40:43 UTC (rev 3698)
@@ -1,5 +1,20 @@
2008-09-27 Braden McDaniel <br...@en...>
+ Documentation improvements. No longer use the Doxygen default
+ style sheet at all. Also, added X3D link to the page footer.
+
+ * doc/Doxyfile
+ * doc/doxygen-footer
+ * doc/doxygen-header
+ * doc/manual/x3d-white-on-black.png
+ * src/libopenvrml/openvrml/local/proto.cpp
+ * src/libopenvrml/openvrml/local/proto.h
+ * src/libopenvrml/openvrml/node.cpp
+ * src/libopenvrml/openvrml/browser.cpp
+ * src/libopenvrml/openvrml/script.cpp
+
+2008-09-27 Braden McDaniel <br...@en...>
+
Fixes for the Visual C++ build.
* ide-projects/Windows/VisualC9_0/OpenVRML/openvrml/openvrml.vcproj
Modified: trunk/doc/Doxyfile
===================================================================
--- trunk/doc/Doxyfile 2008-09-27 07:43:08 UTC (rev 3697)
+++ trunk/doc/Doxyfile 2008-09-28 02:40:43 UTC (rev 3698)
@@ -93,7 +93,7 @@
FILE_PATTERNS = *.cpp \
*.h
RECURSIVE = YES
-EXCLUDE =
+EXCLUDE = ../src/libopenvrml/openvrml/local
EXCLUDE_SYMLINKS = NO
EXCLUDE_SYMBOLS =
EXAMPLE_PATH = ../examples
Modified: trunk/doc/doxygen-footer
===================================================================
--- trunk/doc/doxygen-footer 2008-09-27 07:43:08 UTC (rev 3697)
+++ trunk/doc/doxygen-footer 2008-09-28 02:40:43 UTC (rev 3698)
@@ -1,5 +1,5 @@
</div>
-<address class="footer"><span class="images"><a href="http://opengl.org"><img src="OGL_sm_wht.png" width="68" height="32" border="0" alt="OpenGL"></a><a href="http://sourceforge.net"><img src="http://sourceforge.net/sflogo.php?group_id=7151&type=3" width="125" height="37" border="0" alt="SourceForge.net"></a></span><a href="http://sourceforge.net/tracker/?func=add&group_id=7151&atid=107151">Report error</a><br>Generated $datetime by Doxygen $doxygenversion</address>
+<address class="footer"><span class="images"><a href="http://web3d.org/x3d/"><img src="x3d-white-on-black.png" width="43" height="32" border="0" alt="X3D"></a><a href="http://opengl.org"><img src="OGL_sm_wht.png" width="68" height="32" border="0" alt="OpenGL"></a><a href="http://sourceforge.net"><img src="http://sourceforge.net/sflogo.php?group_id=7151&type=3" width="125" height="37" border="0" alt="SourceForge.net"></a></span><a href="http://sourceforge.net/tracker/?func=add&group_id=7151&atid=107151">Report error</a><br>Generated $datetime by Doxygen $doxygenversion</address>
<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>
<script type="text/javascript">_uacct = "UA-446379-2"; urchinTracker();</script>
</body>
Modified: trunk/doc/doxygen-header
===================================================================
--- trunk/doc/doxygen-header 2008-09-27 07:43:08 UTC (rev 3697)
+++ trunk/doc/doxygen-header 2008-09-28 02:40:43 UTC (rev 3698)
@@ -12,18 +12,13 @@
<link rel="index" href="functions" title="OpenVRML Compound Members">
<link rel="appendix" href="conformance" title="Conformance Test Results">
<style type="text/css">
-@import url("doxygen.css");
@import url("tabs.css");
@import url("http://openvrml.org/openvrml.css");
-body, td {
- font-size: 100%;
+table {
+ width: 100%;
}
-p, center, td, th, ul, dl, div {
- font-family: inherit;
-}
-
h2 {
border-bottom-style: solid;
border-bottom-width: 1px;
@@ -47,22 +42,22 @@
padding-bottom: 0.5em;
}
-div.nav a.el:link, div.nav a.el:visited,
-div.navpath a.el:link, div.navpath a.el:visited {
+div.nav :link, div.nav :visited,
+div.navpath :link, div.navpath :visited {
border-width: 1px;
border-style: solid;
border-color: silver;
padding: 2px;
}
-div.nav a.el:link:hover, div.nav a.el:visited:hover,
-div.navpath a.el:link:hover, div.navpath a.el:visited:hover {
+div.nav :link:hover, div.nav :visited:hover,
+div.navpath :link:hover, div.navpath :visited:hover {
border-style: outset;
border-color: gray;
}
-div.nav a.el:active,
-div.navpath a.el:active {
+div.nav :active,
+div.navpath :active {
border-style: inset;
border-color: gray;
}
@@ -71,70 +66,26 @@
background-color: transparent;
}
-div.qindex {
- background-color: transparent;
- border: none;
-}
-a {
- color: inherit;
-}
-a.qindex {
+.el {
text-decoration: inherit;
- color: inherit;
- padding: 0;
-}
-a.qindex:visited {
- text-decoration: inherit;
- font-weight: inherit;
- color: inherit;
- padding: 0;
-}
-a.qindex:hover {
- text-decoration: inherit;
- background-color: transparent;
- padding: 0;
-}
-a.qindexHL {
- text-decoration: inherit;
- font-weight: inherit;
- background-color: transparent;
- color: inherit;
- padding: 0;
-}
-a.qindexHL:hover {
- text-decoration: inherit;
- background-color: transparent;
- color: inherit;
- padding: 0;
-}
-a.qindexHL:visited {
- text-decoration: inherit;
- background-color: transparent;
- color: inherit;
-}
-a.el {
- text-decoration: inherit;
font-weight: inherit
}
-a.elRef {
+.elRef {
font-weight: inherit
}
-a.code:link, a.code:visited {
+.code:link, .code:visited {
text-decoration: inherit;
font-weight: inherit;
color: inherit;
}
-a.codeRef:link {
+.codeRef:link {
font-weight: normal;
color: inherit;
}
-a {
- color: inherit;
-}
-a:visited {
+:visited {
color: silver;
}
-a:hover {
+:link:hover {
color: inherit;
text-decoration: inherit;
background-color: transparent;
@@ -144,18 +95,6 @@
line-height: 1.2em;
}
-div.qindex {
- font-size: smaller;
-}
-
-div.qindex .qindex:link, div.qindex .qindex:visited {
- font-weight: inherit;
-}
-
-div.qindex .qindexHL:link, div.qindex .qindexHL:visited {
- font-weight: bold;
-}
-
td.memItemLeft, td.memItemRight,
td.memTemplParams, td.memTemplItemLeft, td.memTemplItemRight,
.memtemplate, .memname td {
@@ -164,8 +103,30 @@
td.memItemLeft, td.memItemRight, td.mdescLeft, td.mdescRight {
background-color: rgb(95%, 95%, 95%);
+ border-color: rgb(65%, 65%, 65%);
+ border-width: 1px;
+ font-size: smaller;
}
+.memItemLeft {
+ margin-top: 0.5em;
+ border-top-style: solid;
+}
+.mdescLeft {
+ border-bottom-style: solid;
+}
+.memItemRight {
+ border-top-style: solid;
+ margin-top: 0.5em;
+}
+.mdescRight {
+ border-bottom-style: solid;
+}
+
+.mdescRight {
+ font-style: italic;
+}
+
.mdTable {
background-color: rgb(95%, 95%, 95%);
}
@@ -188,16 +149,41 @@
}
.memitem {
- background-color: rgb(95%, 95%, 95%);
- border-color: rgb(80%, 80%, 80%);
+ padding: 0;
}
+.memitem table {
+ width: auto;
+}
+
+.memproto, .memdoc {
+ border-width: 1px;
+ border-color: rgb(65%, 65%, 65%);
+}
+
.memproto {
background-color: rgb(90%, 90%, 90%);
- border-color: rgb(65%, 65%, 65%);
font-weight: inherit;
+ font-size: smaller;
+ border-top-style: solid;
+ border-left-style: solid;
+ border-right-style: solid;
+ -webkit-border-top-left-radius: 0.6em;
+ -webkit-border-top-right-radius: 0.6em;
+ -moz-border-radius-topleft: 0.6em;
+ -moz-border-radius-topright: 0.6em;
}
+.memdoc {
+ background-color: rgb(95%, 95%, 95%);
+ padding: 2px 5px;
+ border-style: solid;
+ -webkit-border-bottom-left-radius: 0.6em;
+ -webkit-border-bottom-right-radius: 0.6em;
+ -moz-border-radius-bottomleft: 0.6em;
+ -moz-border-radius-bottomright: 0.6em;
+}
+
.memname {
font-weight: inherit;
}
Property changes on: trunk/doc/manual/x3d-white-on-black.png
___________________________________________________________________
Added: svn:mime-type
+ image/png
Modified: trunk/src/libopenvrml/openvrml/browser.cpp
===================================================================
--- trunk/src/libopenvrml/openvrml/browser.cpp 2008-09-27 07:43:08 UTC (rev 3697)
+++ trunk/src/libopenvrml/openvrml/browser.cpp 2008-09-28 02:40:43 UTC (rev 3698)
@@ -54,7 +54,6 @@
# include <boost/multi_index/detail/scope_guard.hpp>
# include <boost/ptr_container/ptr_map.hpp>
# include <boost/thread/thread.hpp>
-# include <boost/utility.hpp>
# include <algorithm>
# include <functional>
# include <cerrno>
Modified: trunk/src/libopenvrml/openvrml/local/proto.cpp
===================================================================
--- trunk/src/libopenvrml/openvrml/local/proto.cpp 2008-09-27 07:43:08 UTC (rev 3697)
+++ trunk/src/libopenvrml/openvrml/local/proto.cpp 2008-09-28 02:40:43 UTC (rev 3698)
@@ -958,7 +958,7 @@
/**
* @internal
*
- * @class proto_node::proto_exposedfield
+ * @class openvrml::local::proto_node::proto_exposedfield
*
* @brief @c PROTO @c exposedField handler class template.
*/
Modified: trunk/src/libopenvrml/openvrml/local/proto.h
===================================================================
--- trunk/src/libopenvrml/openvrml/local/proto.h 2008-09-27 07:43:08 UTC (rev 3697)
+++ trunk/src/libopenvrml/openvrml/local/proto.h 2008-09-28 02:40:43 UTC (rev 3698)
@@ -347,32 +347,32 @@
/**
* @internal
*
- * @class abstract_proto_node::proto_eventin
+ * @class openvrml::local::abstract_proto_node::proto_eventin
*
* @brief @c PROTO @c eventIn handler class template.
*/
/**
- * @typedef abstract_proto_node::proto_eventin::listeners
+ * @typedef openvrml::local::abstract_proto_node::proto_eventin::listeners
*
* @brief Set of event listeners.
*/
/**
- * @var abstract_proto_node::proto_eventin::listeners abstract_proto_node::proto_eventin::listeners_
+ * @var openvrml::local::abstract_proto_node::proto_eventin::listeners openvrml::local::abstract_proto_node::proto_eventin::listeners_
*
* @brief Set of event listeners to which events are delegated for
* processing.
*/
/**
- * @typedef abstract_proto_node::proto_eventin::field_value_type
+ * @typedef openvrml::local::abstract_proto_node::proto_eventin::field_value_type
*
* @brief Field value type.
*/
/**
- * @typedef abstract_proto_node::proto_eventin::event_listener_type
+ * @typedef openvrml::local::abstract_proto_node::proto_eventin::event_listener_type
*
* @brief Type of event listeners to which the instance delegates.
*/
@@ -463,7 +463,7 @@
/**
* @internal
*
- * @class abstract_proto_node::proto_eventout
+ * @class openvrml::local::abstract_proto_node::proto_eventout
*
* @brief @c PROTO @c eventOut handler class template.
*/
@@ -471,7 +471,7 @@
/**
* @internal
*
- * @class abstract_proto_node::proto_eventout::listener_t
+ * @class openvrml::local::abstract_proto_node::proto_eventout::listener_t
*
* @brief Listens for events emitted from @c node%s in the @c PROTO
* implementation in order to propagate them out of the @c PROTO
@@ -479,7 +479,7 @@
*/
/**
- * @var abstract_proto_node::proto_eventout & abstract_proto_node::proto_eventout::listener_t::emitter
+ * @var openvrml::local::abstract_proto_node::proto_eventout & abstract_proto_node::proto_eventout::listener_t::emitter
*
* @brief Reference to the outer @c proto_eventout class.
*
@@ -490,13 +490,13 @@
*/
/**
- * @var abstract_proto_node & abstract_proto_node::proto_eventout::listener_t::node
+ * @var openvrml::local::abstract_proto_node & openvrml::local::abstract_proto_node::proto_eventout::listener_t::node
*
* @brief Reference to the @c abstract_proto_node instance.
*/
/**
- * @var FieldValue abstract_proto_node::proto_eventout::listener_t::value
+ * @var FieldValue openvrml::local::abstract_proto_node::proto_eventout::listener_t::value
*
* @brief The value of the most recently emitted event.
*/
@@ -562,7 +562,7 @@
}
/**
- * @var abstract_proto_node::proto_eventout::listener_t abstract_proto_node::proto_eventout::listener
+ * @var openvrml::local::abstract_proto_node::proto_eventout::listener_t abstract_proto_node::proto_eventout::listener
*
* @brief Listens for events emitted from nodes in the @c PROTO
* implementation in order to propagate them out of the @c PROTO
@@ -570,19 +570,19 @@
*/
/**
- * @typedef abstract_proto_node::proto_eventout<FieldValue>::field_value_type
+ * @typedef openvrml::local::abstract_proto_node::proto_eventout<FieldValue>::field_value_type
*
* @brief Field value type.
*/
/**
- * @typedef abstract_proto_node::proto_eventout<FieldValue>::event_emitter_type
+ * @typedef openvrml::local::abstract_proto_node::proto_eventout<FieldValue>::event_emitter_type
*
* @brief Event emitter type.
*/
/**
- * @typedef abstract_proto_node::proto_eventout<FieldValue>::event_listener_type
+ * @typedef openvrml::local::abstract_proto_node::proto_eventout<FieldValue>::event_listener_type
*
* @brief Event listener type.
*/
Modified: trunk/src/libopenvrml/openvrml/node.cpp
===================================================================
--- trunk/src/libopenvrml/openvrml/node.cpp 2008-09-27 07:43:08 UTC (rev 3697)
+++ trunk/src/libopenvrml/openvrml/node.cpp 2008-09-28 02:40:43 UTC (rev 3698)
@@ -543,6 +543,14 @@
/**
+ * @typedef openvrml::node_type_decls
+ *
+ * @brief A map of node type identifiers to their corresponding
+ * @c node_interface_set%s.
+ */
+
+
+/**
* @class openvrml::node_metatype_id openvrml/node.h
*
* @brief Identifier for @c node_metatype%s.
@@ -844,12 +852,12 @@
/**
* @brief Create a new @c node_type.
*
- * @c node_type%s can be said to subset the master type provided by the @c
- * node_metatype. Each @c node_metatype instance can support certain @c node
- * interfaces; the @c node_interface_set passed to @c
- * node_metatype::create_type must be a subset of those supported interfaces.
+ * @c node_type%s can be said to subset the master type provided by the
+ * @c node_metatype. Each @c node_metatype instance can support certain
+ * @c node interfaces; the @c node_interface_set passed to @c #create_type
+ * must be a subset of those supported interfaces.
*
- * This function delegates to @c node_metatype::do_create_type.
+ * This function delegates to @c #do_create_type.
*
* @param[in] id the name for the new @c node_type.
* @param[in] interfaces a @c node_interface_set containing the
@@ -888,7 +896,7 @@
* @p interfaces.
* @exception std::bad_alloc if memory allocation fails.
*
- * @sa node_metatype::create_type
+ * @sa #create_type
* @sa http://boost.org/libs/smart_ptr/shared_ptr.htm
*/
@@ -1281,8 +1289,10 @@
*/
/**
- * @var class openvrml::node::proto_node
+ * @internal
*
+ * @var class openvrml::node::local::proto_node
+ *
* @brief A @c PROTO instance.
*/
Modified: trunk/src/libopenvrml/openvrml/script.cpp
===================================================================
--- trunk/src/libopenvrml/openvrml/script.cpp 2008-09-27 07:43:08 UTC (rev 3697)
+++ trunk/src/libopenvrml/openvrml/script.cpp 2008-09-28 02:40:43 UTC (rev 3698)
@@ -53,7 +53,7 @@
* @brief Abstract class implemented by scripting language bindings.
*
* The runtime instantiates subclasses of script for each VRML97 Script node;
- * and calls its methods appropriately to execute script code.
+ * and calls its methods appropriately to execute %script code.
*/
/**
@@ -75,13 +75,14 @@
/**
* @var openvrml::script_node & openvrml::script::node
*
- * @brief A reference to the script_node that uses this script object.
+ * @brief A reference to the @c script_node that uses this @c script object.
*/
/**
* @brief Construct.
*
- * @param[in] node a reference to the script_node that uses this script object.
+ * @param[in] node a reference to the @c script_node that uses this @c script
+ * object.
*/
openvrml::script::script(script_node & node):
node(node)
@@ -96,7 +97,7 @@
/**
* @brief Initialize the Script node.
*
- * Delegates to @c script::do_initialize.
+ * Delegates to @c #do_initialize.
*
* @param[in] timestamp the current time.
*/
@@ -117,7 +118,7 @@
/**
* @brief Process an event.
*
- * Delegates to @c script::do_process_event.
+ * Delegates to @c #do_process_event.
*
* @param[in] id eventIn identifier.
* @param[in] value event value.
@@ -142,9 +143,9 @@
*/
/**
- * @brief Execute script code after processing events.
+ * @brief Execute %script code after processing events.
*
- * Delegates to @c script::do_events_processed.
+ * Delegates to @c #do_events_processed.
*
* @param[in] timestamp the current time.
*/
@@ -156,7 +157,7 @@
/**
* @fn void openvrml::script::do_events_processed(double timestamp)
*
- * @brief Execute script code after processing events.
+ * @brief Execute %script code after processing events.
*
* @param[in] timestamp the current time.
*/
@@ -164,7 +165,7 @@
/**
* @brief Shut down the Script node.
*
- * Delegates to <code>script::do_shutdown</code>.
+ * Delegates to @c #do_shutdown.
*
* @param[in] timestamp the current time.
*/
@@ -194,11 +195,12 @@
}
/**
- * @brief Whether the browser may delay sending input events to the script
- * until its outputs are needed by the browser.
+ * @brief Whether the @c browser may delay sending input events to the
+ * @c script until its outputs are needed by the browser.
*
- * @return @c true if the browser may delay sending input events to the script
- * until its outputs are needed by the browser; @c false otherwise.
+ * @return @c true if the @c browser may delay sending input events to the
+ * @c script until its outputs are needed by the @c browser; @c false
+ * otherwise.
*/
bool openvrml::script::must_evaluate() const OPENVRML_NOTHROW
{
@@ -284,12 +286,12 @@
/**
* @internal
*
- * @brief Process direct outputs in @a script::direct_output_map_.
+ * @brief Process direct outputs in @a #direct_output_map_.
*
* This function is called at the end of initialization and processing normal
* events.
*
- * @post <code>script::direct_output_map_.empty()</code> is @c true.
+ * @post @c script::direct_output_map_.empty() is @c true.
*/
void openvrml::script::process_direct_output(double timestamp)
{
@@ -326,7 +328,7 @@
{}
/**
- * @fn std::auto_ptr<openvrml::script> openvrml::script_factory::create_script(script_node & node, const boost::shared_ptr<std::istream> & source)
+ * @fn std::auto_ptr<openvrml::script> openvrml::script_factory::create_script(script_node & node, const boost::shared_ptr<resource_istream> & source)
*
* @brief Create a @c script.
*
@@ -351,7 +353,7 @@
/**
* @internal
*
- * @var class script_factory_registry::script_node
+ * @var class openvrml::script_factory_registry::script_node
*
* @brief @c script_node is the only class that should ever need to
* instantiate @c script_factory_registry.
@@ -630,7 +632,7 @@
*
* @brief Class object for @c script_node%s.
*
- * There is one @c script_node_metatype per browser instance.
+ * There is one @c script_node_metatype per @c browser instance.
*
* @see browser::scriptNodeClass
*/
@@ -679,7 +681,7 @@
*
* @var class openvrml::script_node::script
*
- * @brief Abstract base class for script runtimes.
+ * @brief Abstract base class for %script runtimes.
*/
/**
@@ -1836,7 +1838,7 @@
/**
* @internal
*
- * @var openvrml::script_node::event_listener_map_t openvrml::script_node::event_listener_map
+ * @var openvrml::script_node::event_listener_map_t openvrml::script_node::event_listener_map_
*
* @brief Map of event listeners.
*/
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
