improved documentation

ukoethe · Dec 3, 2010 · f5e0868 · f5e0868
1 parent 5d88871
commit f5e0868
Show file tree

Hide file tree

Showing 7 changed files with 34 additions and 15 deletions.
diff --git a/docsrc/index.dxx b/docsrc/index.dxx
@@ -115,11 +115,18 @@
              <BR>&nbsp;&nbsp;&nbsp;<em>Meta-information about arithmetic types</em>
         <LI> \ref MathConstants
              <BR>&nbsp;&nbsp;&nbsp;<em>M_PI, M_SQRT2</em>
-        <LI> Grid Neighborhood Specification
-             <BR>&nbsp;&nbsp;&nbsp;\ref PixelNeighborhood "2-dimensional" (4- and 8-neighborhood) and
-                                   \ref VoxelNeighborhood "3-dimensional" (6- and 26-neighborhood)
-        <LI> \ref vigra::Rational, \ref vigra::TinyVector, \ref vigra::FFTWComplex, \ref vigra::FixedPoint16
-                <BR>&nbsp;&nbsp;&nbsp;<em>Number types</em>
+        <LI> <b>Grid Neighborhood Specification</b>
+             <UL style="list-style-image:url(documents/bullet.gif)">
+             <LI> \ref PixelNeighborhood "2-dimensional" (4- and 8-neighborhood)
+             <LI> \ref VoxelNeighborhood "3-dimensional" (6- and 26-neighborhood)
+             </UL>
+        <LI> <b>Number Types</b>
+            <UL style="list-style-image:url(documents/bullet.gif)">
+            <LI> \ref vigra::Rational
+            <LI> \ref vigra::TinyVector
+            <LI> \ref vigra::FFTWComplex
+            <LI>\ref vigra::FixedPoint16
+            </UL>
         <LI> \ref RandomNumberGeneration
              <BR>&nbsp;&nbsp;&nbsp;<em>Mersenne twister class and random number functors</em>
         <LI> \ref Polynomials

diff --git a/include/vigra/box.hxx b/include/vigra/box.hxx
@@ -76,8 +76,9 @@ struct EndOutsidePolicy
 
 } // namespace vigra::detail
 
-   /** \addtogroup RangesAndPoints
-     * \brief Represent an n-dimensional box as a (begin, end) pair.
+/** \addtogroup RangesAndPoints */
+//@{
+   /** \brief Represent an n-dimensional box as a (begin, end) pair.
      * Depending on the value type, end() is considered to be
      * outside the box (as in the STL, for integer types), or
      * inside (for floating point types).  size() will always be
@@ -537,6 +538,8 @@ class Box
     }
 };
 
+//@}
+
 } // namespace vigra
 
 #endif // VIGRA_BOX_HXX
diff --git a/include/vigra/diff2d.hxx b/include/vigra/diff2d.hxx
@@ -132,9 +132,9 @@ class Diff2DConstColumnIteratorPolicy
         { d.y += n; }
 };
 
-/** \addtogroup RangesAndPoints Two-dimensional Ranges and Points
+/** \addtogroup RangesAndPoints Ranges and Points
 
-    Specify a 2D position, extent, or rectangle.
+    Specify 2-D and N-D positions, extents, and boxes.
 */
 //@{
 

diff --git a/include/vigra/meshgrid.hxx b/include/vigra/meshgrid.hxx
@@ -40,10 +40,7 @@
 #include "diff2d.hxx"
 
 namespace vigra{
-/** \addtogroup RangesAndPoints Two-dimensional Ranges and Points
-
-    Specify a 2D position, extent, or rectangle.
-*/
+/** \addtogroup RangesAndPoints */
 //@{
 
 /********************************************************/

diff --git a/include/vigra/tinyvector.hxx b/include/vigra/tinyvector.hxx
@@ -596,6 +596,7 @@ class TinyVectorBase
 };
 
 /** \brief Class for fixed size vectors.
+    \ingroup RangesAndPoints
 
     This class contains an array of size SIZE of the specified VALUETYPE.
     The interface conforms to STL vector, except that there are no functions

diff --git a/include/vigra/utilities.hxx b/include/vigra/utilities.hxx
@@ -87,11 +87,13 @@ VIGRA_AS_STRING(void *)
 
     <UL style="list-style-image:url(documents/bullet.gif)">
     <LI> \ref vigra::ArrayVector
-         <BR>&nbsp;&nbsp;&nbsp;<em>replacement for std::vector</em>
+         <BR>&nbsp;&nbsp;&nbsp;<em>replacement for std::vector (always uses consecutive memory)</em>
     <LI> \ref RangesAndPoints
-         <BR>&nbsp;&nbsp;&nbsp;<em>2-dimensional positions, extents, and rectangles</em>
+         <BR>&nbsp;&nbsp;&nbsp;<em>2-D and N-D positions, extents, and boxes</em>
     <LI> \ref PixelNeighborhood
          <BR>&nbsp;&nbsp;&nbsp;<em>4- and 8-neighborhood definitions and circulators</em>
+    <LI> \ref VoxelNeighborhood
+         <BR>&nbsp;&nbsp;&nbsp;<em>6- and 26-neighborhood definitions and circulators</em>
     <LI> \ref vigra::IteratorAdaptor
          <BR>&nbsp;&nbsp;&nbsp;<em>Quickly create STL-compatible 1D iterator adaptors</em>
     <LI> \ref TupleTypes

diff --git a/vigranumpy/docsrc/index.rst b/vigranumpy/docsrc/index.rst
@@ -262,6 +262,15 @@ corner detection, localization of maxima and minima etc.
 .. automodule:: vigra.analysis
    :members:
 
+
+Geometry
+--------
+
+The module vigra.geometry contains geometric primitives (such as polygons) and related algorithms.
+
+.. automodule:: vigra.geometry
+   :members:
+
 
 Machine Learning
 ----------------