Next pass of doxygen @brief cleanup.

(bzr r10658)

15 files changed, 35 insertions, 30 deletions

diff --git a/src/display/cairo-templates.h b/src/display/cairo-templates.h
index d4c8e1493..b48a22702 100644
--- a/src/display/cairo-templates.h
+++ b/src/display/cairo-templates.h
@@ -1,6 +1,6 @@
 /**
  * @file
- * @brief Cairo software blending templates
+ * Cairo software blending templates.
  *//*
  * Authors:
  *   Krzysztof Kosiński <tweenk.pl@gmail.com>
@@ -31,11 +31,12 @@ static const int OPENMP_THRESHOLD = 2048;
 #include "display/cairo-utils.h"
 
 /**
- * @brief Blend two surfaces using the supplied functor.
+ * Blend two surfaces using the supplied functor.
  * This template blends two Cairo image surfaces using a blending functor that takes
  * two 32-bit ARGB pixel values and returns a modified 32-bit pixel value.
  * Differences in input surface formats are handled transparently. In future, this template
- * will also handle software fallback for GL surfaces. */
+ * will also handle software fallback for GL surfaces.
+ */
 template <typename Blend>
 void ink_cairo_surface_blend(cairo_surface_t *in1, cairo_surface_t *in2, cairo_surface_t *out, Blend blend)
 {
@@ -303,12 +304,13 @@ void ink_cairo_surface_filter(cairo_surface_t *in, cairo_surface_t *out, Filter
 
 
 /**
- * @brief Synthesize surface pixels based on their position.
+ * Synthesize surface pixels based on their position.
  * This template accepts a functor that gets called with the x and y coordinates of the pixels,
  * given as integers.
  * @param out       Output surface
  * @param out_area  The region of the output surface that should be synthesized
- * @param synth     Synthesis functor */
+ * @param synth     Synthesis functor
+ */
 template <typename Synth>
 void ink_cairo_surface_synthesize(cairo_surface_t *out, cairo_rectangle_t const &out_area, Synth synth)
 {
diff --git a/src/display/cairo-utils.h b/src/display/cairo-utils.h
index 1de88785d..dc11231b9 100644
--- a/src/display/cairo-utils.h
+++ b/src/display/cairo-utils.h
@@ -1,6 +1,6 @@
 /**
  * @file
- * @brief Cairo integration helpers
+ * Cairo integration helpers.
  *//*
  * Authors:
  *   Krzysztof Kosiński <tweenk.pl@gmail.com>
@@ -21,9 +21,11 @@ struct SPColor;
 
 namespace Inkscape {
 
-/** @brief RAII idiom for Cairo groups.
+/**
+ * RAII idiom for Cairo groups.
  * Groups are temporary surfaces used when rendering e.g. masks and opacity.
- * Use this class to ensure that each group push is matched with a pop. */
+ * Use this class to ensure that each group push is matched with a pop.
+ */
 class CairoGroup {
 public:
     CairoGroup(cairo_t *_ct);
@@ -38,7 +40,7 @@ private:
     bool pushed;
 };
 
-/** @brief RAII idiom for Cairo state saving */
+/** RAII idiom for Cairo state saving. */
 class CairoSave {
 public:
     CairoSave(cairo_t *_ct, bool save=false)
@@ -64,7 +66,7 @@ private:
     bool saved;
 };
 
-/** @brief Cairo context with Inkscape-specific operations */
+/** Cairo context with Inkscape-specific operations. */
 class CairoContext : public Cairo::Context {
 public:
     CairoContext(cairo_t *obj, bool ref = false);
diff --git a/src/display/canvas-axonomgrid.cpp b/src/display/canvas-axonomgrid.cpp
index d346669ef..089fe88d1 100644
--- a/src/display/canvas-axonomgrid.cpp
+++ b/src/display/canvas-axonomgrid.cpp
@@ -46,11 +46,11 @@ enum Dim3 { X=0, Y, Z };
 static double deg_to_rad(double deg) { return deg*M_PI/180.0;}
 
 /**
-    \brief  This function renders a line on a particular canvas buffer,
-            using Bresenham's line drawing function.
-            http://www.cs.unc.edu/~mcmillan/comp136/Lecture6/Lines.html
-            Coordinates are interpreted as SCREENcoordinates
-*/
+ * This function renders a line on a particular canvas buffer,
+ * using Bresenham's line drawing function.
+ * http://www.cs.unc.edu/~mcmillan/comp136/Lecture6/Lines.html
+ * Coordinates are interpreted as SCREENcoordinates
+ */
 static void
 sp_caxonomgrid_drawline (SPCanvasBuf *buf, gint x0, gint y0, gint x1, gint y1, guint32 rgba)
 {
diff --git a/src/display/canvas-grid.h b/src/display/canvas-grid.h
index db098d507..10feeca0e 100644
--- a/src/display/canvas-grid.h
+++ b/src/display/canvas-grid.h
@@ -1,5 +1,5 @@
 /** @file
- * @brief Cartesian grid item for the Inkscape canvas
+ * Cartesian grid item for the Inkscape canvas.
  */
 /* Copyright (C) Johan Engelen 2006-2007 <johan@shouraizou.nl>
  * Copyright (C) Lauris Kaplinski 2000
@@ -46,8 +46,7 @@ enum GridType {
 
 class CanvasGrid;
 
-/** \brief  All the variables that are tracked for a grid specific
-            canvas item. */
+/** All the variables that are tracked for a grid specific canvas item. */
 struct GridCanvasItem : public SPCanvasItem{
     CanvasGrid *grid; // the owning grid object
 };
diff --git a/src/display/drawing-context.h b/src/display/drawing-context.h
index 4ada79057..fb6662202 100644
--- a/src/display/drawing-context.h
+++ b/src/display/drawing-context.h
@@ -1,6 +1,6 @@
 /**
  * @file
- * @brief Cairo drawing context with Inkscape extensions
+ * Cairo drawing context with Inkscape extensions.
  *//*
  * Authors:
  *   Krzysztof Kosiński <tweenk.pl@gmail.com>
diff --git a/src/display/drawing-group.h b/src/display/drawing-group.h
index 961e5b9a3..974b3c977 100644
--- a/src/display/drawing-group.h
+++ b/src/display/drawing-group.h
@@ -1,6 +1,6 @@
 /**
  * @file
- * @brief Group belonging to an SVG drawing element
+ * Group belonging to an SVG drawing element.
  *//*
  * Authors:
  *   Krzysztof Kosiński <tweenk.pl@gmail.com>
diff --git a/src/display/drawing-image.h b/src/display/drawing-image.h
index 300d6f0b5..306096d0e 100644
--- a/src/display/drawing-image.h
+++ b/src/display/drawing-image.h
@@ -1,6 +1,6 @@
 /**
  * @file
- * @brief Bitmap image belonging to an SVG drawing
+ * Bitmap image belonging to an SVG drawing.
  *//*
  * Authors:
  *   Krzysztof Kosiński <tweenk.pl@gmail.com>
diff --git a/src/display/drawing-item.h b/src/display/drawing-item.h
index ca8b21336..cd8f128d8 100644
--- a/src/display/drawing-item.h
+++ b/src/display/drawing-item.h
@@ -1,6 +1,6 @@
 /**
  * @file
- * @brief Canvas item belonging to an SVG drawing element
+ * Canvas item belonging to an SVG drawing element.
  *//*
  * Authors:
  *   Krzysztof Kosiński <tweenk.pl@gmail.com>
diff --git a/src/display/drawing-shape.h b/src/display/drawing-shape.h
index 27bd7fbba..ce9bed2eb 100644
--- a/src/display/drawing-shape.h
+++ b/src/display/drawing-shape.h
@@ -1,6 +1,6 @@
 /**
  * @file
- * @brief Group belonging to an SVG drawing element
+ * Group belonging to an SVG drawing element.
  *//*
  * Authors:
  *   Krzysztof Kosiński <tweenk.pl@gmail.com>
diff --git a/src/display/drawing-surface.h b/src/display/drawing-surface.h
index e3637d402..1ec848405 100644
--- a/src/display/drawing-surface.h
+++ b/src/display/drawing-surface.h
@@ -1,6 +1,6 @@
 /**
  * @file
- * @brief Cairo surface that remembers its origin
+ * Cairo surface that remembers its origin.
  *//*
  * Authors:
  *   Krzysztof Kosiński <tweenk.pl@gmail.com>
diff --git a/src/display/drawing-text.h b/src/display/drawing-text.h
index 73caa6a7c..929d2bf2d 100644
--- a/src/display/drawing-text.h
+++ b/src/display/drawing-text.h
@@ -1,6 +1,6 @@
 /**
  * @file
- * @brief Group belonging to an SVG drawing element
+ * Group belonging to an SVG drawing element.
  *//*
  * Authors:
  *   Krzysztof Kosiński <tweenk.pl@gmail.com>
diff --git a/src/display/drawing.h b/src/display/drawing.h
index cfba4ebe6..bf3c4bbe8 100644
--- a/src/display/drawing.h
+++ b/src/display/drawing.h
@@ -1,6 +1,6 @@
 /**
  * @file
- * @brief SVG drawing for display
+ * SVG drawing for display.
  *//*
  * Authors:
  *   Krzysztof Kosiński <tweenk.pl@gmail.com>
diff --git a/src/display/nr-filter-primitive.h b/src/display/nr-filter-primitive.h
index 42a1c98b7..da2097156 100644
--- a/src/display/nr-filter-primitive.h
+++ b/src/display/nr-filter-primitive.h
@@ -97,7 +97,8 @@ public:
      */
     Geom::Rect filter_primitive_area(FilterUnits const &units);
 
-    /** @brief Indicate whether the filter primitive can handle the given affine.
+    /**
+     *Indicate whether the filter primitive can handle the given affine.
      *
      * Results of some filter primitives depend on the coordinate system used when rendering.
      * A gaussian blur with equal x and y deviation will remain unchanged by rotations.
@@ -108,7 +109,8 @@ public:
      * with edges parallel to the axes of the user coordinate system. This means
      * the matrices from FilterUnits will contain at most a (possibly non-uniform) scale
      * and a translation. When all primitives of the filter return true, the rendering is
-     * performed in display coordinate space and no intermediate surface is used. */
+     * performed in display coordinate space and no intermediate surface is used.
+     */
     virtual bool can_handle_affine(Geom::Affine const &) { return false; }
 
 protected:
diff --git a/src/display/nr-style.h b/src/display/nr-style.h
index 0ba6ce2c6..ce154cec0 100644
--- a/src/display/nr-style.h
+++ b/src/display/nr-style.h
@@ -1,6 +1,6 @@
 /**
  * @file
- * @brief Style information for rendering
+ * Style information for rendering.
  *//*
  * Authors:
  *   Krzysztof Kosiński <tweenk.pl@gmail.com>
diff --git a/src/display/sodipodi-ctrlrect.h b/src/display/sodipodi-ctrlrect.h
index 45f8523ed..a83c7bc38 100644
--- a/src/display/sodipodi-ctrlrect.h
+++ b/src/display/sodipodi-ctrlrect.h
@@ -3,7 +3,7 @@
 
 /**
  * \file sodipodi-ctrlrect.h
- * \brief Simple non-transformed rectangle, usable for rubberband
+ * Simple non-transformed rectangle, usable for rubberband.
  *
  * Authors:
  *   Lauris Kaplinski <lauris@ximian.com>