44f8eb
From 50b8acd29d65596fea12e3497ac485d6fdb85420 Mon Sep 17 00:00:00 2001
44f8eb
From: =?UTF-8?q?Ralf=20Cors=C3=A9pius?= <corsepiu@corsepiu.home>
44f8eb
Date: Fri, 4 May 2012 13:10:08 +0200
44f8eb
Subject: [PATCH 04/10] doxygen
44f8eb
44f8eb
---
44f8eb
 docs/doxygen/footer.html                        |  2 +-
44f8eb
 src/actions/SoGLRenderAction.cpp                |  4 ++--
44f8eb
 src/base/SbDPViewVolume.cpp                     |  2 +-
44f8eb
 src/base/SbViewVolume.cpp                       |  2 +-
44f8eb
 src/collision/SoIntersectionDetectionAction.cpp |  2 +-
44f8eb
 src/elements/SoElement.cpp                      | 12 ++++++------
44f8eb
 src/fields/SoMField.cpp                         |  2 +-
44f8eb
 src/fields/SoSFImage.cpp                        |  2 +-
44f8eb
 src/fields/SoSFImage3.cpp                       |  2 +-
44f8eb
 src/fields/SoSField.cpp                         |  2 +-
44f8eb
 src/geo/SoGeoOrigin.cpp                         |  6 +++---
44f8eb
 src/misc/SoOffscreenRenderer.cpp                |  2 +-
44f8eb
 src/misc/SoPath.cpp                             |  6 +++---
44f8eb
 src/nodekits/SoBaseKit.cpp                      |  8 ++++----
44f8eb
 src/nodes/SoNurbsProfile.cpp                    |  6 +++---
44f8eb
 15 files changed, 30 insertions(+), 30 deletions(-)
44f8eb
44f8eb
diff --git a/docs/doxygen/footer.html b/docs/doxygen/footer.html
44f8eb
index feaccd5..2bb04ac 100644
44f8eb
--- a/docs/doxygen/footer.html
44f8eb
+++ b/docs/doxygen/footer.html
44f8eb
@@ -1,6 +1,6 @@
44f8eb
 
44f8eb
 

Copyright &copy 1998-2010 by Kongsberg Oil & Gas Technologies. All rights reserved.

44f8eb
 <address style="align: right;"><small>
44f8eb
-Generated on $datetime for $projectname by Doxygen $doxygenversion.</small></address>
44f8eb
+Generated on $date for $projectname by Doxygen $doxygenversion.</small></address>
44f8eb
 </body>
44f8eb
 </html>
44f8eb
diff --git a/src/actions/SoGLRenderAction.cpp b/src/actions/SoGLRenderAction.cpp
44f8eb
index e89629b..550fe52 100644
44f8eb
--- a/src/actions/SoGLRenderAction.cpp
44f8eb
+++ b/src/actions/SoGLRenderAction.cpp
44f8eb
@@ -400,7 +400,7 @@
44f8eb
   A more detailed presentation of the algorithm is written by Cass
44f8eb
   Everitt at NVIDIA;
44f8eb
 
44f8eb
-  "Interactive Order-Independent Transparency"
44f8eb
+  \"Interactive Order-Independent Transparency\"
44f8eb
   http:://developer.nvidia.com/object/order_independent_transparency.html
44f8eb
 
44f8eb
   \since Coin 2.2
44f8eb
@@ -877,7 +877,7 @@ SoGLRenderAction::getTransparencyType(void) const
44f8eb
       glEnable(GL_LINE_SMOOTH);
44f8eb
   \endverbatim
44f8eb
 
44f8eb
-  ...before rendering the scene.
44f8eb
+  \.\.\.before rendering the scene.
44f8eb
 
44f8eb
   This is a simple (and computationally non-intensive) way of doing
44f8eb
   anti-aliasing.
44f8eb
diff --git a/src/base/SbDPViewVolume.cpp b/src/base/SbDPViewVolume.cpp
44f8eb
index 46ead07..0b4af71 100644
44f8eb
--- a/src/base/SbDPViewVolume.cpp
44f8eb
+++ b/src/base/SbDPViewVolume.cpp
44f8eb
@@ -640,7 +640,7 @@ SbDPViewVolume::projectBox(const SbBox3f& box) const
44f8eb
   view = view.narrow(0.25, 0.5, 0.75, 1.0);
44f8eb
   \endcode
44f8eb
 
44f8eb
-  ..will give a view volume with corner points <25, 75> and <50, 100>.
44f8eb
+  \.\.will give a view volume with corner points <25, 75> and <50, 100>.
44f8eb
 
44f8eb
   \sa scale(), scaleWidth(), scaleHeight()
44f8eb
  */
44f8eb
diff --git a/src/base/SbViewVolume.cpp b/src/base/SbViewVolume.cpp
44f8eb
index 958b3e8..4c35c9b 100644
44f8eb
--- a/src/base/SbViewVolume.cpp
44f8eb
+++ b/src/base/SbViewVolume.cpp
44f8eb
@@ -379,7 +379,7 @@ SbViewVolume::projectBox(const SbBox3f& box) const
44f8eb
   view = view.narrow(0.25, 0.5, 0.75, 1.0);
44f8eb
   \endcode
44f8eb
 
44f8eb
-  ..will give a view volume with corner points <25, 75> and <50, 100>.
44f8eb
+  \.\.will give a view volume with corner points <25, 75> and <50, 100>.
44f8eb
 
44f8eb
   \sa scale(), scaleWidth(), scaleHeight()
44f8eb
  */
44f8eb
diff --git a/src/collision/SoIntersectionDetectionAction.cpp b/src/collision/SoIntersectionDetectionAction.cpp
44f8eb
index 5635c9c..54a229f 100644
44f8eb
--- a/src/collision/SoIntersectionDetectionAction.cpp
44f8eb
+++ b/src/collision/SoIntersectionDetectionAction.cpp
44f8eb
@@ -66,7 +66,7 @@
44f8eb
     SoInteraction::init();
44f8eb
 
44f8eb
     if (argc != 2) {
44f8eb
-      (void)fprintf(stderr, "\n\tUsage: testapp <filename.iv>\n\n");
44f8eb
+      (void)fprintf(stderr, "\n\\tUsage: testapp <filename.iv>\n\n");
44f8eb
       exit(1);
44f8eb
     }
44f8eb
 
44f8eb
diff --git a/src/elements/SoElement.cpp b/src/elements/SoElement.cpp
44f8eb
index afa752d..d83a322 100644
44f8eb
--- a/src/elements/SoElement.cpp
44f8eb
+++ b/src/elements/SoElement.cpp
44f8eb
@@ -218,13 +218,13 @@
44f8eb
   void
44f8eb
   usage(const char * appname)
44f8eb
   {
44f8eb
-    (void)fprintf(stderr, "\n\tUsage: %s <modelfile.iv>\n\n", appname);
44f8eb
+    (void)fprintf(stderr, "\n\\tUsage: %s <modelfile.iv>\n\n", appname);
44f8eb
     (void)fprintf(stderr,
44f8eb
-                  "\tLists all texture filenames in the model file,\n"
44f8eb
-                  "\tand on which shape nodes they are used.\n\n"
44f8eb
-                  "\tThe purpose of this example utility is simply to\n"
44f8eb
-                  "\tshow how to create and use an extension element for\n"
44f8eb
-                  "\tscene graph traversal.\n\n");
44f8eb
+                  "\\tLists all texture filenames in the model file,\n"
44f8eb
+                  "\\tand on which shape nodes they are used.\n\n"
44f8eb
+                  "\\tThe purpose of this example utility is simply to\n"
44f8eb
+                  "\\tshow how to create and use an extension element for\n"
44f8eb
+                  "\\tscene graph traversal.\n\n");
44f8eb
   }
44f8eb
 
44f8eb
   int
44f8eb
diff --git a/src/fields/SoMField.cpp b/src/fields/SoMField.cpp
44f8eb
index 305f7e3..32760f9 100644
44f8eb
--- a/src/fields/SoMField.cpp
44f8eb
+++ b/src/fields/SoMField.cpp
44f8eb
@@ -161,7 +161,7 @@
44f8eb
     }
44f8eb
   \endcode
44f8eb
 
44f8eb
-  ..like this, for instance, a Coordinate3 node providing 6 vertex
44f8eb
+  \.\.like this, for instance, a Coordinate3 node providing 6 vertex
44f8eb
   coordinates in the form of SbVec3f values in its "point" field for
44f8eb
   e.g. a faceset, lineset or pointset:
44f8eb
 
44f8eb
diff --git a/src/fields/SoSFImage.cpp b/src/fields/SoSFImage.cpp
44f8eb
index 8e50a89..663d7c3 100644
44f8eb
--- a/src/fields/SoSFImage.cpp
44f8eb
+++ b/src/fields/SoSFImage.cpp
44f8eb
@@ -50,7 +50,7 @@
44f8eb
   FIELDNAME X Y C 0xRRGGBBAA 0xRRGGBBAA ...
44f8eb
   \endcode
44f8eb
 
44f8eb
-  "X" and "Y" are the image dimensions along the given axes, "C" is
44f8eb
+  \"X\" and \"Y\" are the image dimensions along the given axes, "C" is
44f8eb
   the number of components in the image. The number of 0xRRGGBBAA
44f8eb
   pixel color specifications needs to equal the exact number of
44f8eb
   pixels, which of course is given by X*Y. Each part of the pixel
44f8eb
diff --git a/src/fields/SoSFImage3.cpp b/src/fields/SoSFImage3.cpp
44f8eb
index 60d0d83..03a07d7 100644
44f8eb
--- a/src/fields/SoSFImage3.cpp
44f8eb
+++ b/src/fields/SoSFImage3.cpp
44f8eb
@@ -50,7 +50,7 @@
44f8eb
   FIELDNAME X Y Z C 0xRRGGBBAA 0xRRGGBBAA ...
44f8eb
   \endcode
44f8eb
 
44f8eb
-  "X", "Y" and "Z" are the image dimensions along the given axes, "C"
44f8eb
+  \"X\", \"Y\" and \"Z\" are the image dimensions along the given axes, "C"
44f8eb
   is the number of components in the image. The number of 0xRRGGBBAA
44f8eb
   pixel color specifications needs to equal the exact number of
44f8eb
   pixels, which is X*Y*Z. Each part of the pixel color value is in the
44f8eb
diff --git a/src/fields/SoSField.cpp b/src/fields/SoSField.cpp
44f8eb
index a707d35..661f63b 100644
44f8eb
--- a/src/fields/SoSField.cpp
44f8eb
+++ b/src/fields/SoSField.cpp
44f8eb
@@ -59,7 +59,7 @@
44f8eb
     }
44f8eb
   \endcode
44f8eb
 
44f8eb
-  ..like this, for instance, a SpotLight node from a scene
44f8eb
+  \.\.like this, for instance, a SpotLight node from a scene
44f8eb
   graph which will be default \e off when read back from file:
44f8eb
 
44f8eb
   \code
44f8eb
diff --git a/src/geo/SoGeoOrigin.cpp b/src/geo/SoGeoOrigin.cpp
44f8eb
index 6fb8f99..81b504d 100644
44f8eb
--- a/src/geo/SoGeoOrigin.cpp
44f8eb
+++ b/src/geo/SoGeoOrigin.cpp
44f8eb
@@ -220,12 +220,12 @@
44f8eb
   Used to specify a spatial reference frame. Coin currently supports three different
44f8eb
   systems. Support for more systems might be added in the future.
44f8eb
 
44f8eb
-  \li "GD" - The Geodetic system (latitude/longitude).  
44f8eb
+  \li \"GD\" - The Geodetic system (latitude/longitude).  
44f8eb
 
44f8eb
-  \li "UTM" - Universal Transverse Mercator coordinate system. The
44f8eb
+  \li \"UTM\" - Universal Transverse Mercator coordinate system. The
44f8eb
   second string should be the zone, encoded as "Z<n>".
44f8eb
   
44f8eb
-  \li "GC" - Earth-fixed Geocentric with respect to the WGS84 ellipsoid.
44f8eb
+  \li \"GC\" - Earth-fixed Geocentric with respect to the WGS84 ellipsoid.
44f8eb
 
44f8eb
   The "GD" and "UTM" systems can, for future support, have an ellipsoid
44f8eb
   specification. The default is "WE" which is the WGS84 ellipsoid, the only
44f8eb
diff --git a/src/misc/SoOffscreenRenderer.cpp b/src/misc/SoOffscreenRenderer.cpp
44f8eb
index ae28f2d..40f545d 100644
44f8eb
--- a/src/misc/SoOffscreenRenderer.cpp
44f8eb
+++ b/src/misc/SoOffscreenRenderer.cpp
44f8eb
@@ -123,7 +123,7 @@
44f8eb
   
  • dump rendered scene to file
  • 44f8eb
       
    44f8eb
     
    44f8eb
    -  ..then you use some external tool or library to construct the movie
    44f8eb
    +  \.\.then you use some external tool or library to construct the movie
    44f8eb
       file, for instance in MPEG format, from the set of files dumped to
    44f8eb
       disk from the iterative process above.
    44f8eb
     
    44f8eb
    diff --git a/src/misc/SoPath.cpp b/src/misc/SoPath.cpp
    44f8eb
    index a6ed112..79c3c36 100644
    44f8eb
    --- a/src/misc/SoPath.cpp
    44f8eb
    +++ b/src/misc/SoPath.cpp
    44f8eb
    @@ -909,7 +909,7 @@ SoPath::replaceIndex(SoNode * const parent, const int index,
    44f8eb
         }
    44f8eb
       \endcode
    44f8eb
     
    44f8eb
    -  ..if we now do:
    44f8eb
    +  \.\.if we now do:
    44f8eb
     
    44f8eb
       \code
    44f8eb
         SoSeparator * root = new SoSeparator;
    44f8eb
    @@ -919,7 +919,7 @@ SoPath::replaceIndex(SoNode * const parent, const int index,
    44f8eb
         wa.apply(root);
    44f8eb
       \endcode
    44f8eb
     
    44f8eb
    -  ..we would get the scene graph exported like this:
    44f8eb
    +  \.\.we would get the scene graph exported like this:
    44f8eb
     
    44f8eb
       \code
    44f8eb
         Separator {
    44f8eb
    @@ -937,7 +937,7 @@ SoPath::replaceIndex(SoNode * const parent, const int index,
    44f8eb
         }
    44f8eb
       \endcode
    44f8eb
     
    44f8eb
    -  ..and as you can see, \e both the Cone and the Cube nodes has
    44f8eb
    +  \.\.and as you can see, \e both the Cone and the Cube nodes has
    44f8eb
       vanished, as they was not important for the part per se, and not
    44f8eb
       written as part of it.
    44f8eb
     
    44f8eb
    diff --git a/src/nodekits/SoBaseKit.cpp b/src/nodekits/SoBaseKit.cpp
    44f8eb
    index 57205d1..6686f9e 100644
    44f8eb
    --- a/src/nodekits/SoBaseKit.cpp
    44f8eb
    +++ b/src/nodekits/SoBaseKit.cpp
    44f8eb
    @@ -183,7 +183,7 @@
    44f8eb
        shapekit->set("material", "diffuseColor 1 0 0");
    44f8eb
       \endcode
    44f8eb
     
    44f8eb
    -  ..while doing it without shape kits amounts to this:
    44f8eb
    +  \.\.while doing it without shape kits amounts to this:
    44f8eb
     
    44f8eb
       \code
    44f8eb
       SoSeparator * root = new SoSeparator;
    44f8eb
    @@ -193,7 +193,7 @@
    44f8eb
       root->addChild(new SoCube);
    44f8eb
       \endcode
    44f8eb
     
    44f8eb
    -  ..so even for this miniscule mock-up example, you save on code
    44f8eb
    +  \.\.so even for this miniscule mock-up example, you save on code
    44f8eb
       verbosity and complexity.
    44f8eb
     
    44f8eb
     
    44f8eb
    @@ -293,8 +293,8 @@
    44f8eb
         SO_KIT_ADD_FIELD(active, (TRUE));
    44f8eb
         SO_KIT_ADD_FIELD(projectedSize, (5.0f));
    44f8eb
     
    44f8eb
    -    SO_KIT_ADD_CATALOG_ENTRY(topSeparator, SoSeparator, FALSE, this, \x0, FALSE);
    44f8eb
    -    SO_KIT_ADD_CATALOG_ABSTRACT_ENTRY(shape, SoNode, SoCube, TRUE, topSeparator, \x0, TRUE);
    44f8eb
    +    SO_KIT_ADD_CATALOG_ENTRY(topSeparator, SoSeparator, FALSE, this, 0, FALSE);
    44f8eb
    +    SO_KIT_ADD_CATALOG_ABSTRACT_ENTRY(shape, SoNode, SoCube, TRUE, topSeparator, 0, TRUE);
    44f8eb
         SO_KIT_ADD_CATALOG_ENTRY(scale, SoScale, FALSE, topSeparator, shape, FALSE);
    44f8eb
     
    44f8eb
         SO_KIT_INIT_INSTANCE();
    44f8eb
    diff --git a/src/nodes/SoNurbsProfile.cpp b/src/nodes/SoNurbsProfile.cpp
    44f8eb
    index 4916462..697ee78 100644
    44f8eb
    --- a/src/nodes/SoNurbsProfile.cpp
    44f8eb
    +++ b/src/nodes/SoNurbsProfile.cpp
    44f8eb
    @@ -93,7 +93,7 @@
    44f8eb
       }
    44f8eb
       \endcode
    44f8eb
     
    44f8eb
    -  .. with... 
    44f8eb
    +  \.\. with\.\.\. 
    44f8eb
     
    44f8eb
       \code
    44f8eb
       ProfileCoordinate2 {
    44f8eb
    @@ -120,8 +120,8 @@
    44f8eb
       for detailed information, refer to the specialized literature on the
    44f8eb
       topic (for example "An Introduction to NURBS: With Historical
    44f8eb
       Perspective" by David F. Rogers). A basic overview of curve and
    44f8eb
    -  surface rendering using NURBS can also be found in chapter 8 of "The
    44f8eb
    -  Inventor Mentor".
    44f8eb
    +  surface rendering using NURBS can also be found in chapter 8 of \"The
    44f8eb
    +  Inventor Mentor\".
    44f8eb
     
    44f8eb
       FILE FORMAT/DEFAULTS:
    44f8eb
       \code
    44f8eb
    -- 
    44f8eb
    1.8.1.4
    44f8eb