Cleanup pass on documentation that was dumping garbage into doxygen output.

(bzr r10696)

19 files changed, 74 insertions, 59 deletions

diff --git a/src/2geom/basic-intersection.h b/src/2geom/basic-intersection.h
index 5a813ae99..8e29b4617 100644
--- a/src/2geom/basic-intersection.h
+++ b/src/2geom/basic-intersection.h
@@ -1,7 +1,8 @@
 /**
- * \file
- * \brief Basic intersection routines
- *
+ * @file
+ * Basic intersection routines.
+ */
+/*
  * Authors:
  *      ? <?@?.?>
  * 
diff --git a/src/2geom/conic_section_clipper.h b/src/2geom/conic_section_clipper.h
index a02cda4d3..3e4ac8429 100644
--- a/src/2geom/conic_section_clipper.h
+++ b/src/2geom/conic_section_clipper.h
@@ -1,7 +1,8 @@
 /**
- * \file
- * \brief Conic section clipping with respect to a rectangle
- *
+ * @file
+ * Conic section clipping with respect to a rectangle.
+ */
+/*
  * Authors:
  *      Marco Cecchetti <mrcekets at gmail>
  *
diff --git a/src/2geom/conic_section_clipper_cr.h b/src/2geom/conic_section_clipper_cr.h
index 31f5a4269..687fa182d 100644
--- a/src/2geom/conic_section_clipper_cr.h
+++ b/src/2geom/conic_section_clipper_cr.h
@@ -1,7 +1,8 @@
 /**
- * \file
- * \brief Conic section clipping with respect to a rectangle
- *
+ * @file
+ * Conic section clipping with respect to a rectangle.
+ */
+/*
  * Authors:
  *      Marco Cecchetti <mrcekets at gmail>
  *
diff --git a/src/2geom/conic_section_clipper_impl.h b/src/2geom/conic_section_clipper_impl.h
index 7db4fca9f..ba213b8d5 100644
--- a/src/2geom/conic_section_clipper_impl.h
+++ b/src/2geom/conic_section_clipper_impl.h
@@ -1,7 +1,8 @@
 /**
- * \file
- * \brief Conic section clipping with respect to a rectangle
- *
+ * @file
+ * Conic section clipping with respect to a rectangle.
+ */
+/*
  * Authors:
  *      Marco Cecchetti <mrcekets at gmail>
  *
diff --git a/src/2geom/conicsec.h b/src/2geom/conicsec.h
index be9a68bfa..d9c5e7bc5 100644
--- a/src/2geom/conicsec.h
+++ b/src/2geom/conicsec.h
@@ -1,7 +1,8 @@
 /**
- * \file
- * \brief Conic Section
- *
+ * @file
+ * Conic Section.
+ */
+/*
  * Authors:
  *      Nathan Hurst <njh@njhurst.com>
  *
diff --git a/src/2geom/convex-cover.h b/src/2geom/convex-cover.h
index e4b5de200..4c1b59d17 100644
--- a/src/2geom/convex-cover.h
+++ b/src/2geom/convex-cover.h
@@ -1,7 +1,8 @@
 /**
- * \file
- * \brief Dynamic convex hull structure
- *
+ * @file
+ * Dynamic convex hull structure.
+ */
+/*
  * Copyright 2006 Nathan Hurst <njh@mail.csse.monash.edu.au>
  * Copyright 2006 Michael G. Sloan <mgsloan@gmail.com>
  *
diff --git a/src/2geom/ellipse.h b/src/2geom/ellipse.h
index 297254366..2d6ba399f 100644
--- a/src/2geom/ellipse.h
+++ b/src/2geom/ellipse.h
@@ -1,7 +1,8 @@
 /**
- * \file
- * \brief  Ellipse Curve
- *
+ * @file
+ * Ellipse Curve.
+ */
+/*
  * Authors:
  *      Marco Cecchetti <mrcekets at gmail.com>
  *
diff --git a/src/2geom/geom.h b/src/2geom/geom.h
index 5aeded23d..b9d910e2a 100644
--- a/src/2geom/geom.h
+++ b/src/2geom/geom.h
@@ -1,7 +1,8 @@
 /**
- *  \file
- *  \brief Various geometrical calculations
- *
+ * @file
+ * Various geometrical calculations.
+ */
+/*
  *  Authors:
  *   Nathan Hurst <njh@mail.csse.monash.edu.au>
  *
diff --git a/src/2geom/linear.h b/src/2geom/linear.h
index df6dd9904..6302d810e 100644
--- a/src/2geom/linear.h
+++ b/src/2geom/linear.h
@@ -1,7 +1,8 @@
 /**
- * \file
- * \brief  Linear fragment function class
- *
+ * @file
+ * Linear fragment function class.
+ */
+/*
  *  Authors:
  *   Nathan Hurst <njh@mail.csse.monash.edu.au>
  *   Michael Sloan <mgsloan@gmail.com>
diff --git a/src/2geom/nearest-point.h b/src/2geom/nearest-point.h
index 19485242c..484c47afc 100644
--- a/src/2geom/nearest-point.h
+++ b/src/2geom/nearest-point.h
@@ -1,7 +1,8 @@
 /**
- * \file
- * \brief  nearest point routines for D2<SBasis> and Piecewise<D2<SBasis>>
- *
+ * @file
+ * nearest point routines for D2<SBasis> and Piecewise<D2<SBasis>>.
+ */
+/*
  * Authors:
  *
  * 		Marco Cecchetti <mrcekets at gmail.com>
diff --git a/src/2geom/piecewise.h b/src/2geom/piecewise.h
index 837f33ea7..310de23b1 100644
--- a/src/2geom/piecewise.h
+++ b/src/2geom/piecewise.h
@@ -1,7 +1,4 @@
-/**
- * \file
- * \brief Piecewise function class
- *
+/*
  * Copyright 2007 Michael Sloan <mgsloan@gmail.com>
  *
  * This library is free software; you can redistribute it and/or
diff --git a/src/2geom/sbasis-geometric.h b/src/2geom/sbasis-geometric.h
index f7216c15a..841d75a28 100644
--- a/src/2geom/sbasis-geometric.h
+++ b/src/2geom/sbasis-geometric.h
@@ -1,13 +1,14 @@
-#ifndef _SBASIS_GEOMETRIC
-#define _SBASIS_GEOMETRIC
+#ifndef SEEN_SBASIS_GEOMETRIC_
+#define SEEN_SBASIS_GEOMETRIC_
 #include <2geom/d2.h>
 #include <2geom/piecewise.h>
 #include <vector>
 
 /**
- * \file
- * \brief two-dimensional geometric operators.  
- *
+ * @file
+ * two-dimensional geometric operators.
+ */
+/*
  * Copyright 2007, JFBarraud
  * Copyright 2007, njh
  * 
@@ -104,7 +105,7 @@ std::vector<double> find_tangents(Point P, D2<SBasis> const &A);
 
 };
 
-#endif
+#endif // SEEN_SBASIS_GEOMETRIC_
 
 /*
   Local Variables:
diff --git a/src/2geom/sbasis-math.h b/src/2geom/sbasis-math.h
index e6d40a3de..c3f7518eb 100644
--- a/src/2geom/sbasis-math.h
+++ b/src/2geom/sbasis-math.h
@@ -1,7 +1,8 @@
 /**
- * \file
- * \brief some std functions to work with (pw)s-basis
- *
+ * @file
+ * some std functions to work with (pw)s-basis.
+ */
+/*
  *  Authors:
  *   Jean-Francois Barraud
  *
diff --git a/src/2geom/sbasis-poly.h b/src/2geom/sbasis-poly.h
index e0bef9333..70abfeea1 100644
--- a/src/2geom/sbasis-poly.h
+++ b/src/2geom/sbasis-poly.h
@@ -5,9 +5,10 @@
 #include <2geom/sbasis.h>
 
 /**
- * \file
- * \brief Conversion between SBasis and Poly.  Not recommended for general use due to instability.
- *
+ * @file
+ * Conversion between SBasis and Poly.  Not recommended for general use due to instability.
+ */
+/*
  * Authors:
  *      ? <?@?.?>
  * 
diff --git a/src/2geom/sbasis.h b/src/2geom/sbasis.h
index 7a7e33fe4..f3598ccc8 100644
--- a/src/2geom/sbasis.h
+++ b/src/2geom/sbasis.h
@@ -1,7 +1,8 @@
 /**
- * \file
- * \brief Defines S-power basis function class
- *
+ * @file
+ * Defines S-power basis function class.
+ */
+/*
  *  Authors:
  *   Nathan Hurst <njh@mail.csse.monash.edu.au>
  *   Michael Sloan <mgsloan@gmail.com>
diff --git a/src/2geom/shape.h b/src/2geom/shape.h
index 0a7ee9709..9f7ead4aa 100644
--- a/src/2geom/shape.h
+++ b/src/2geom/shape.h
@@ -1,6 +1,4 @@
-/**
- * \brief  Shapes are special paths on which boolops can be performed
- *
+/*
  * Authors:
  *      Michael G. Sloan <mgsloan@gmail.com>
  *      Nathan Hurst <njh@mail.csse.monash.edu.au>
@@ -63,6 +61,9 @@ enum {
   BOOLOP_UNION        = BOOLOP_JUST_A | BOOLOP_JUST_B | BOOLOP_BOTH
 };
 
+/**
+ * Shapes are special paths on which boolops can be performed.
+ */
 class Shape {
     Regions content;
     mutable bool fill;
diff --git a/src/2geom/svg-path-parser.h b/src/2geom/svg-path-parser.h
index 93fd23b77..1aab8bb36 100644
--- a/src/2geom/svg-path-parser.h
+++ b/src/2geom/svg-path-parser.h
@@ -1,7 +1,8 @@
 /**
- * \file
- * \brief  parse SVG path specifications
- *
+ * @file
+ * parse SVG path specifications.
+ */
+/*
  * Copyright 2007 MenTaLguY <mental@rydia.net>
  * Copyright 2007 Aaron Spike <aaron@ekips.org>
  *
diff --git a/src/2geom/svg-path.h b/src/2geom/svg-path.h
index 89192fb72..89dcb4759 100644
--- a/src/2geom/svg-path.h
+++ b/src/2geom/svg-path.h
@@ -1,7 +1,8 @@
 /**
- * \file
- * \brief  callback interface for SVG path data
- *
+ * @file
+ * callback interface for SVG path data.
+ */
+/*
  * Copyright 2007 MenTaLguY <mental@rydia.net>
  *
  * This library is free software; you can redistribute it and/or
diff --git a/src/2geom/toposweep.h b/src/2geom/toposweep.h
index 428115dd3..b8c1bdcf4 100644
--- a/src/2geom/toposweep.h
+++ b/src/2geom/toposweep.h
@@ -2,7 +2,8 @@
 /**
  * \file
  * \brief  TopoSweep - topology / graph representation of a PathVector, for boolean operations and related tasks
- *
+ */
+/*
  * Authors:
  * 		Michael Sloan <mgsloan at gmail.com>
  * 		Nathan Hurst <njhurst at njhurst.com>