Update of /cvsroot/openvrml/openvrml/src/libopenvrml/openvrml
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv29274/src/libopenvrml/openvrml
Modified Files:
field_value.cpp node.cpp
Log Message:
Doc-comment improvements.
Index: field_value.cpp
===================================================================
RCS file: /cvsroot/openvrml/openvrml/src/libopenvrml/openvrml/field_value.cpp,v
retrieving revision 1.15
retrieving revision 1.16
diff -C2 -d -r1.15 -r1.16
*** field_value.cpp 2 Nov 2005 15:41:04 -0000 1.15
--- field_value.cpp 3 Nov 2005 04:05:43 -0000 1.16
***************
*** 59,62 ****
--- 59,64 ----
/**
+ * @internal
+ *
* @class openvrml::field_value::counted_impl_base
*
***************
*** 98,101 ****
--- 100,105 ----
/**
+ * @internal
+ *
* @class openvrml::field_value::counted_impl
*
***************
*** 115,118 ****
--- 119,124 ----
* <code>value_type</code> of a
* @link openvrml::FieldValueConcept Field Value@endlink.
+ *
+ * @sa http://boost.org/libs/smart_ptr/shared_ptr.htm
*/
***************
*** 644,654 ****
* @par Refinement of
* <a href="http://www.sgi.com/tech/stl/DefaultConstructible.html">
! * DefaultConstructible</a>,
* <a href="http://www.boost.org/libs/utility/CopyConstructible.html">
! * CopyConstructible</a>,
* <a href="http://www.sgi.com/tech/stl/Assignable.html">
* Assignable</a>,
* <a href="http://www.sgi.com/tech/stl/EqualityComparable.html">
! * EqualityComparable</a>
*
* @par Associated types
--- 650,660 ----
* @par Refinement of
* <a href="http://www.sgi.com/tech/stl/DefaultConstructible.html">
! * Default Constructible</a>,
* <a href="http://www.boost.org/libs/utility/CopyConstructible.html">
! * Copy Constructible</a>,
* <a href="http://www.sgi.com/tech/stl/Assignable.html">
* Assignable</a>,
* <a href="http://www.sgi.com/tech/stl/EqualityComparable.html">
! * Equality Comparable</a>
*
* @par Associated types
Index: node.cpp
===================================================================
RCS file: /cvsroot/openvrml/openvrml/src/libopenvrml/openvrml/node.cpp,v
retrieving revision 1.64
retrieving revision 1.65
diff -C2 -d -r1.64 -r1.65
*** node.cpp 2 Nov 2005 08:50:24 -0000 1.64
--- node.cpp 3 Nov 2005 04:05:43 -0000 1.65
***************
*** 690,693 ****
--- 690,695 ----
* @p interfaces.
* @exception std::bad_alloc if memory allocation fails.
+ *
+ * @sa http://boost.org/libs/smart_ptr/shared_ptr.htm
*/
const boost::shared_ptr<openvrml::node_type>
***************
*** 717,720 ****
--- 719,723 ----
*
* @sa node_class::create_type
+ * @sa http://boost.org/libs/smart_ptr/shared_ptr.htm
*/
***************
*** 824,828 ****
* fields and exposedFields.
*
! * @return a node_ptr to a new node.
*
* @exception unsupported_interface if @p initial_values specifies a field
--- 827,831 ----
* fields and exposedFields.
*
! * @return a <code>boost::intrusive_ptr</code> to a new node.
*
* @exception unsupported_interface if @p initial_values specifies a field
***************
*** 832,835 ****
--- 835,840 ----
* wrong type.
* @exception std::bad_alloc if memory allocation fails.
+ *
+ * @sa http://boost.org/libs/smart_ptr/intrustive_ptr.html
*/
const boost::intrusive_ptr<openvrml::node>
***************
*** 854,858 ****
* fields and exposedFields.
*
! * @return a node_ptr to a new node.
*
* @exception unsupported_interface if @p initial_values specifies a field
--- 859,863 ----
* fields and exposedFields.
*
! * @return a <code>boost::intrusive_ptr</code> to a new node.
*
* @exception unsupported_interface if @p initial_values specifies a field
***************
*** 862,865 ****
--- 867,872 ----
* wrong type.
* @exception std::bad_alloc if memory allocation fails.
+ *
+ * @sa http://boost.org/libs/smart_ptr/intrustive_ptr.html
*/
***************
*** 1399,1402 ****
--- 1406,1411 ----
*
* @brief The scope to which the node belongs.
+ *
+ * @sa http://boost.org/libs/smart_ptr/shared_ptr.htm
*/
***************
*** 1593,1596 ****
--- 1602,1607 ----
*
* @return the scope to which the node belongs.
+ *
+ * @sa http://boost.org/libs/smart_ptr/shared_ptr.htm
*/
|