Documentation update pass.

(bzr r10692)

10 files changed, 34 insertions, 35 deletions

diff --git a/src/widgets/dash-selector.h b/src/widgets/dash-selector.h
index 6db66f805..1fadf4385 100644
--- a/src/widgets/dash-selector.h
+++ b/src/widgets/dash-selector.h
@@ -1,9 +1,6 @@
-#ifndef __SP_DASH_SELECTOR_NEW_H__
-#define __SP_DASH_SELECTOR_NEW_H__
+#ifndef SEEN_SP_DASH_SELECTOR_NEW_H
+#define SEEN_SP_DASH_SELECTOR_NEW_H
 
-/** @file
- * @brief Option menu for selecting dash patterns
- */
 /* Authors:
  *   Lauris Kaplinski <lauris@kaplinski.com>
  *   Maximilian Albert <maximilian.albert> (gtkmm-ification)
@@ -25,6 +22,9 @@ class Adjustment;
 }
 
 // TODO: should we rather derive this from OptionMenu and add the spinbutton somehow else?
+/**
+ * Option menu for selecting dash patterns.
+ */
 class SPDashSelector : public Gtk::HBox {
 public:
     SPDashSelector();
@@ -47,7 +47,7 @@ private:
     static gchar const *const _prefs_path;
 };
 
-#endif
+#endif // SEEN_SP_DASH_SELECTOR_NEW_H
 
 /*
   Local Variables:
diff --git a/src/widgets/eek-preview.cpp b/src/widgets/eek-preview.cpp
index 5de246f6b..d867647ed 100644
--- a/src/widgets/eek-preview.cpp
+++ b/src/widgets/eek-preview.cpp
@@ -1,7 +1,3 @@
-/**
- * @file
- * EEK preview stuff.
- */
 /* ***** BEGIN LICENSE BLOCK *****
  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  *
diff --git a/src/widgets/eek-preview.h b/src/widgets/eek-preview.h
index c15f25eb6..7275ab9b4 100644
--- a/src/widgets/eek-preview.h
+++ b/src/widgets/eek-preview.h
@@ -1,6 +1,3 @@
-/** @file
- * @brief EEK preview stuff
- */
 /* ***** BEGIN LICENSE BLOCK *****
  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  *
@@ -43,6 +40,11 @@
 #include <gdk/gdk.h>
 #include <gtk/gtk.h>
 
+/**
+ * @file
+ * Generic implementation of a object that can be shown by a preview.
+ */
+
 G_BEGIN_DECLS
 
 
diff --git a/src/widgets/ege-paint-def.cpp b/src/widgets/ege-paint-def.cpp
index 36777d16a..c4325659d 100644
--- a/src/widgets/ege-paint-def.cpp
+++ b/src/widgets/ege-paint-def.cpp
@@ -1,7 +1,3 @@
-/**
- * @file
- * EGE paint definition.
- */
 /* ***** BEGIN LICENSE BLOCK *****
  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  *
diff --git a/src/widgets/ege-paint-def.h b/src/widgets/ege-paint-def.h
index 32f92ac3d..856146019 100644
--- a/src/widgets/ege-paint-def.h
+++ b/src/widgets/ege-paint-def.h
@@ -1,6 +1,3 @@
-/** @file
- * @brief EGE paint definition
- */
 /* ***** BEGIN LICENSE BLOCK *****
  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  *
@@ -49,6 +46,9 @@ namespace ege
 typedef void (*ColorCallback)( void* data );
 
 
+/**
+ * Pure data representation of a color definition.
+ */
 class PaintDef
 {
 public:
diff --git a/src/widgets/sp-attribute-widget.cpp b/src/widgets/sp-attribute-widget.cpp
index 9cdf9fab3..b8ac50092 100644
--- a/src/widgets/sp-attribute-widget.cpp
+++ b/src/widgets/sp-attribute-widget.cpp
@@ -1,7 +1,3 @@
-/**
- * @file
- * Widget that listens and modifies repr attributes.
- */
 /* Authors:
  *  Lauris Kaplinski <lauris@ximian.com>
  *   Abhishek Sharma
diff --git a/src/widgets/sp-attribute-widget.h b/src/widgets/sp-attribute-widget.h
index 93342ff4e..a4acf9504 100644
--- a/src/widgets/sp-attribute-widget.h
+++ b/src/widgets/sp-attribute-widget.h
@@ -1,5 +1,6 @@
-/** @file
- * @brief Widget that listens and modifies repr attributes
+/**
+ * @file
+ * Widget that listens and modifies repr attributes.
  */
 /* Authors:
  *  Lauris Kaplinski <lauris@kaplinski.com>
diff --git a/src/widgets/stroke-style.cpp b/src/widgets/stroke-style.cpp
index 3594e2049..488b10666 100644
--- a/src/widgets/stroke-style.cpp
+++ b/src/widgets/stroke-style.cpp
@@ -1,7 +1,3 @@
-/**
- * @file
- * Stroke style dialog.
- */
 /* Authors:
  *   Lauris Kaplinski <lauris@kaplinski.com>
  *   Bryce Harrington <brycehar@bryceharrington.org>
diff --git a/src/widgets/stroke-style.h b/src/widgets/stroke-style.h
index b8ab05810..882901f45 100644
--- a/src/widgets/stroke-style.h
+++ b/src/widgets/stroke-style.h
@@ -1,5 +1,6 @@
-/** @file
- * @brief  Stroke style dialog
+/**
+ * @file
+ * Widgets used in the stroke style dialog.
  */
 /* Author:
  *   Lauris Kaplinski <lauris@ximian.com>
@@ -19,9 +20,19 @@ class Widget;
 class Container;
 }
 
+/**
+ * Creates an instance of a paint style widget.
+ */
 Gtk::Widget *sp_stroke_style_paint_widget_new(void);
+
+/**
+ * Creates an instance of a line style widget.
+ */
 Gtk::Container *sp_stroke_style_line_widget_new(void);
 
+/**
+ * Switches a line or paint style widget to track the given desktop.
+ */
 void sp_stroke_style_widget_set_desktop(Gtk::Widget *widget, SPDesktop *desktop);
 
 #endif // SEEN_DIALOGS_STROKE_STYLE_H
diff --git a/src/widgets/toolbox.h b/src/widgets/toolbox.h
index a3fbddf0c..d7a1b9bd2 100644
--- a/src/widgets/toolbox.h
+++ b/src/widgets/toolbox.h
@@ -1,9 +1,7 @@
 #ifndef SEEN_TOOLBOX_H
 #define SEEN_TOOLBOX_H
 
-/**
- * \brief Main toolbox
- *
+/*
  * Authors:
  *   Lauris Kaplinski <lauris@kaplinski.com>
  *   Frank Felfe <innerspace@iname.com>
@@ -26,6 +24,9 @@ class SPEventContext;
 namespace Inkscape {
 namespace UI {
 
+/**
+ * Main toolbox source.
+ */
 class ToolboxFactory
 {
 public: