SF.net SVN: openvrml:[4176] trunk/src/libopenvrml/openvrml/node_impl_util. cpp

[<br...@us...>]

Revision: 4176
          http://openvrml.svn.sourceforge.net/openvrml/?rev=4176&view=rev
Author:   braden
Date:     2010-08-13 07:51:06 +0000 (Fri, 13 Aug 2010)

Log Message:
-----------
Doc-comment improvements.

Modified Paths:
--------------
    trunk/src/libopenvrml/openvrml/node_impl_util.cpp

Modified: trunk/src/libopenvrml/openvrml/node_impl_util.cpp
===================================================================
--- trunk/src/libopenvrml/openvrml/node_impl_util.cpp	2010-08-13 06:11:09 UTC (rev 4175)
+++ trunk/src/libopenvrml/openvrml/node_impl_util.cpp	2010-08-13 07:51:06 UTC (rev 4176)
@@ -206,7 +206,11 @@
  * @endcode
  *
  * In this example, @c set_wiggly_listener, @c wiggly, and @c height_field are
- * all members of the @c my_node class.
+ * all members of the @c my_node class.  @c set_wiggly_listener is an instance
+ * of a class that inherits
+ * @c openvrml::node_field_value_listener@<openvrml::sfbool>; @c wiggly is an
+ * instance of @c openvrml::sfbool; and @c height_field is an instance of
+ * @c openvrml::exposedfield@<openvrml::mffloat>.
  *
  * @param namespace_scope       the namespace scope where @p node_instance_type
  *                              is defined.
@@ -237,12 +241,15 @@
  * 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.
+ * 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.  Most %node implementations can take
+ * advantage of this simply by using the
+ * @c #OPENVRML_NODE_IMPL_UTIL_DEFINE_DO_CREATE_TYPE macro when implementing a
+ * concrete @c openvrml::node_metatype.
  */
 
 /**


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.