summaryrefslogtreecommitdiffstats
path: root/src/ui
diff options
context:
space:
mode:
authorJon A. Cruz <jon@joncruz.org>2011-10-25 07:45:35 +0000
committerJon A. Cruz <jon@joncruz.org>2011-10-25 07:45:35 +0000
commit1a5d5d8a7e796035bc70d5c727d4d901dda50726 (patch)
treee15866e9b83d8948e6f7329193bbe4b6eefaa840 /src/ui
parentcppcheck (diff)
downloadinkscape-1a5d5d8a7e796035bc70d5c727d4d901dda50726.tar.gz
inkscape-1a5d5d8a7e796035bc70d5c727d4d901dda50726.zip
Cleanup pass on documentation that was dumping garbage into doxygen output.
(bzr r10696)
Diffstat (limited to 'src/ui')
-rw-r--r--src/ui/dialog/guides.h8
-rw-r--r--src/ui/view/edit-widget-interface.h9
-rw-r--r--src/ui/view/view-widget.h15
-rw-r--r--src/ui/view/view.h5
-rw-r--r--src/ui/widget/attr-widget.h7
-rw-r--r--src/ui/widget/button.h10
-rw-r--r--src/ui/widget/color-preview.h22
-rw-r--r--src/ui/widget/combo-enums.h10
-rw-r--r--src/ui/widget/dock-item.h7
-rw-r--r--src/ui/widget/entity-entry.h4
-rw-r--r--src/ui/widget/entry.h8
-rw-r--r--src/ui/widget/handlebox.h14
-rw-r--r--src/ui/widget/icon-widget.h7
-rw-r--r--src/ui/widget/labelled.h8
-rw-r--r--src/ui/widget/licensor.h15
-rw-r--r--src/ui/widget/notebook-page.h7
-rw-r--r--src/ui/widget/page-sizer.h10
-rw-r--r--src/ui/widget/panel.h7
-rw-r--r--src/ui/widget/point.h10
-rw-r--r--src/ui/widget/preferences-widget.h6
-rw-r--r--src/ui/widget/random.h9
-rw-r--r--src/ui/widget/registered-enums.h7
-rw-r--r--src/ui/widget/registered-widget.h4
-rw-r--r--src/ui/widget/registry.h5
-rw-r--r--src/ui/widget/rendering-options.h7
-rw-r--r--src/ui/widget/rotateable.h7
-rw-r--r--src/ui/widget/ruler.h25
-rw-r--r--src/ui/widget/scalar-unit.h10
-rw-r--r--src/ui/widget/scalar.h9
-rw-r--r--src/ui/widget/selected-style.h7
-rw-r--r--src/ui/widget/spin-slider.h13
-rw-r--r--src/ui/widget/style-subject.h9
-rw-r--r--src/ui/widget/svg-canvas.h17
-rw-r--r--src/ui/widget/text.h8
-rw-r--r--src/ui/widget/toolbox.h7
-rw-r--r--src/ui/widget/unit-menu.h7
-rw-r--r--src/ui/widget/zoom-status.h14
37 files changed, 191 insertions, 163 deletions
diff --git a/src/ui/dialog/guides.h b/src/ui/dialog/guides.h
index 88d0310b9..20136fbff 100644
--- a/src/ui/dialog/guides.h
+++ b/src/ui/dialog/guides.h
@@ -1,7 +1,4 @@
-/**
- *
- * \brief Dialog for modifying guidelines
- *
+/*
* Author:
* Andrius R. <knutux@gmail.com>
* Johan Engelen
@@ -40,6 +37,9 @@ namespace Widget {
namespace Dialogs {
+/**
+ * Dialog for modifying guidelines.
+ */
class GuidelinePropertiesDialog : public Gtk::Dialog {
public:
GuidelinePropertiesDialog(SPGuide *guide, SPDesktop *desktop);
diff --git a/src/ui/view/edit-widget-interface.h b/src/ui/view/edit-widget-interface.h
index 577beb5ce..ba29d6225 100644
--- a/src/ui/view/edit-widget-interface.h
+++ b/src/ui/view/edit-widget-interface.h
@@ -1,8 +1,4 @@
-/**
- * \file
- *
- * Abstract base class for all EditWidget implementations.
- *
+/*
* Authors:
* Ralf Stephan <ralf@ark.in-berlin.de>
* John Bintz <jcoswell@coswellproductions.org>
@@ -26,6 +22,9 @@ namespace Inkscape {
namespace UI {
namespace View {
+/**
+ * Abstract base class for all EditWidget implementations.
+ */
struct EditWidgetInterface
{
EditWidgetInterface() {}
diff --git a/src/ui/view/view-widget.h b/src/ui/view/view-widget.h
index f216c8e27..5143054d2 100644
--- a/src/ui/view/view-widget.h
+++ b/src/ui/view/view-widget.h
@@ -1,9 +1,7 @@
#ifndef INKSCAPE_UI_VIEW_VIEWWIDGET_H
#define INKSCAPE_UI_VIEW_VIEWWIDGET_H
-/** \file
- * A widget is the UI context for a document view.
- *
+/*
* Authors:
* Lauris Kaplinski <lauris@kaplinski.com>
* Ralf Stephan <ralf@ark.in-berlin.de>
@@ -17,10 +15,13 @@
#include <gtk/gtk.h>
namespace Inkscape {
- namespace UI {
- namespace View {
- class View;
- }}}
+namespace UI {
+namespace View {
+class View;
+} // namespace View
+} // namespace UI
+} // namespace Inkscape
+
class SPViewWidget;
class SPNamedView;
diff --git a/src/ui/view/view.h b/src/ui/view/view.h
index c56d79147..8b30aead2 100644
--- a/src/ui/view/view.h
+++ b/src/ui/view/view.h
@@ -1,9 +1,6 @@
#ifndef INKSCAPE_UI_VIEW_VIEW_H
#define INKSCAPE_UI_VIEW_VIEW_H
-
-/** \file
- * Abstract base class for all SVG document views
- *
+/*
* Authors:
* Lauris Kaplinski <lauris@kaplinski.com>
* Ralf Stephan <ralf@ark.in-berlin.de>
diff --git a/src/ui/widget/attr-widget.h b/src/ui/widget/attr-widget.h
index 7b9c35ab7..94906c8e8 100644
--- a/src/ui/widget/attr-widget.h
+++ b/src/ui/widget/attr-widget.h
@@ -1,6 +1,4 @@
-/**
- * \brief Very basic interface for classes that control attributes
- *
+/*
* Authors:
* Nicholas Bishop <nicholasbishop@gmail.com>
* Rodrigo Kumpera <kumpera@gmail.com>
@@ -32,6 +30,9 @@ enum DefaultValueType
T_CHARPTR
};
+/**
+ * Very basic interface for classes that control attributes.
+ */
class DefaultValueHolder
{
DefaultValueType type;
diff --git a/src/ui/widget/button.h b/src/ui/widget/button.h
index 7e942b324..1ed88a2da 100644
--- a/src/ui/widget/button.h
+++ b/src/ui/widget/button.h
@@ -1,6 +1,4 @@
-/**
- * \brief Button and CheckButton widgets
- *
+/*
* Author:
* buliabyak@gmail.com
*
@@ -20,6 +18,9 @@ namespace Inkscape {
namespace UI {
namespace Widget {
+/**
+ * Button widget.
+ */
class Button : public Gtk::Button
{
public:
@@ -29,6 +30,9 @@ protected:
Gtk::Tooltips _tooltips;
};
+/**
+ * CheckButton widget.
+ */
class CheckButton : public Gtk::CheckButton
{
public:
diff --git a/src/ui/widget/color-preview.h b/src/ui/widget/color-preview.h
index 424c58665..aa4c7e11d 100644
--- a/src/ui/widget/color-preview.h
+++ b/src/ui/widget/color-preview.h
@@ -1,9 +1,6 @@
-#ifndef __COLOR_PREVIEW_H__
-#define __COLOR_PREVIEW_H__
-
-/** \file
- * A simple color preview widget, mainly used within a picker button.
- *
+#ifndef SEEN_COLOR_PREVIEW_H
+#define SEEN_COLOR_PREVIEW_H
+/*
* Authors:
* Lauris Kaplinski <lauris@kaplinski.com>
* Ralf Stephan <ralf@ark.in-berlin.de>
@@ -17,9 +14,12 @@
#include <gtkmm/eventbox.h>
namespace Inkscape {
- namespace UI {
- namespace Widget {
+namespace UI {
+namespace Widget {
+/**
+ * A simple color preview widget, mainly used within a picker button.
+ */
class ColorPreview : public Gtk::Widget {
public:
ColorPreview (guint32 rgba);
@@ -34,9 +34,11 @@ protected:
guint32 _rgba;
};
-}}}
+} // namespace Widget
+} // namespace UI
+} // namespace Inkscape
-#endif
+#endif // SEEN_COLOR_PREVIEW_H
/*
Local Variables:
diff --git a/src/ui/widget/combo-enums.h b/src/ui/widget/combo-enums.h
index d9044daa6..9dfb920a5 100644
--- a/src/ui/widget/combo-enums.h
+++ b/src/ui/widget/combo-enums.h
@@ -1,6 +1,4 @@
-/**
- * \brief Simplified management of enumerations in the UI as combobox.
- *
+/*
* Authors:
* Nicholas Bishop <nicholasbishop@gmail.com>
* Johan Engelen <j.b.c.engelen@ewi.utwente.nl>
@@ -23,6 +21,9 @@ namespace Inkscape {
namespace UI {
namespace Widget {
+/**
+ * Simplified management of enumerations in the UI as combobox.
+ */
template<typename E> class ComboBoxEnum : public Gtk::ComboBox, public AttrWidget
{
private:
@@ -176,6 +177,9 @@ private:
};
+/**
+ * Simplified management of enumerations in the UI as combobox.
+ */
template<typename E> class LabelledComboBoxEnum : public Labelled
{
public:
diff --git a/src/ui/widget/dock-item.h b/src/ui/widget/dock-item.h
index 1780b7525..48cd71846 100644
--- a/src/ui/widget/dock-item.h
+++ b/src/ui/widget/dock-item.h
@@ -1,6 +1,4 @@
-/**
- * \brief A custom wrapper around gdl-dock-item
- *
+/*
* Author:
* Gustav Broberg <broberg@kth.se>
*
@@ -27,6 +25,9 @@ namespace Widget {
class Dock;
+/**
+ * A custom wrapper around gdl-dock-item.
+ */
class DockItem {
public:
diff --git a/src/ui/widget/entity-entry.h b/src/ui/widget/entity-entry.h
index 5bdee9a90..c96f3351d 100644
--- a/src/ui/widget/entity-entry.h
+++ b/src/ui/widget/entity-entry.h
@@ -1,6 +1,4 @@
-/** \file
- * \brief
- *
+/*
* Authors:
* Ralf Stephan <ralf@ark.in-berlin.de>
*
diff --git a/src/ui/widget/entry.h b/src/ui/widget/entry.h
index bb6c1321a..3338f0888 100644
--- a/src/ui/widget/entry.h
+++ b/src/ui/widget/entry.h
@@ -1,7 +1,4 @@
-/** \file
- *
- * \brief Helperclass for Gtk::Entry widgets
- *
+/*
* Authors:
* Johan Engelen <goejendaagh@zonnet.nl>
*
@@ -23,6 +20,9 @@ namespace Inkscape {
namespace UI {
namespace Widget {
+/**
+ * Helperclass for Gtk::Entry widgets.
+ */
class Entry : public Labelled
{
public:
diff --git a/src/ui/widget/handlebox.h b/src/ui/widget/handlebox.h
index 41a993e9d..db384552b 100644
--- a/src/ui/widget/handlebox.h
+++ b/src/ui/widget/handlebox.h
@@ -1,9 +1,4 @@
-/**
- * \brief HandleBox Widget - Adds a detachment handle to another widget.
- *
- * This work really doesn't amount to much more than a convenience constructor
- * for Gtk::HandleBox. Maybe this could be contributed back to Gtkmm, as
- * Gtkmm provides several convenience constructors for other widgets as well.
+/*
*
* Author:
* Derek P. Moore <derekm@hackunix.org>
@@ -22,6 +17,13 @@ namespace Inkscape {
namespace UI {
namespace Widget {
+/**
+ * Adds a detachment handle to another widget.
+ *
+ * This work really doesn't amount to much more than a convenience constructor
+ * for Gtk::HandleBox. Maybe this could be contributed back to Gtkmm, as
+ * Gtkmm provides several convenience constructors for other widgets as well.
+ */
class HandleBox : public Gtk::HandleBox
{
public:
diff --git a/src/ui/widget/icon-widget.h b/src/ui/widget/icon-widget.h
index 3ca461b33..329702f2e 100644
--- a/src/ui/widget/icon-widget.h
+++ b/src/ui/widget/icon-widget.h
@@ -1,6 +1,4 @@
-/**
- * \brief Icon Widget - General image widget (including SVG icons)
- *
+/*
* Author:
* Bryce Harrington <bryce@bryceharrington.org>
*
@@ -19,6 +17,9 @@ namespace Inkscape {
namespace UI {
namespace Widget {
+/**
+ * Icon Widget - General image widget (including SVG icons).
+ */
class IconWidget : public Gtk::Widget
{
public:
diff --git a/src/ui/widget/labelled.h b/src/ui/widget/labelled.h
index a8b00ebb6..9614dc28a 100644
--- a/src/ui/widget/labelled.h
+++ b/src/ui/widget/labelled.h
@@ -1,7 +1,4 @@
-/**
- * \brief Labelled Widget - Adds a label with optional icon or suffix to
- * another widget.
- *
+/*
* Authors:
* Carl Hetherington <inkscape@carlh.net>
* Derek P. Moore <derekm@hackunix.org>
@@ -23,6 +20,9 @@ namespace Inkscape {
namespace UI {
namespace Widget {
+/**
+ * Adds a label with optional icon or suffix to another widget.
+ */
class Labelled : public Gtk::HBox
{
public:
diff --git a/src/ui/widget/licensor.h b/src/ui/widget/licensor.h
index 9f41a6d0d..3c503b5ba 100644
--- a/src/ui/widget/licensor.h
+++ b/src/ui/widget/licensor.h
@@ -1,7 +1,4 @@
-/** \file
- * \brief Widget for specifying a document's license; part of document
- * preferences dialog.
- *
+/*
* Authors:
* Ralf Stephan <ralf@ark.in-berlin.de>
*
@@ -10,8 +7,8 @@
* Released under GNU GPL. Read the file 'COPYING' for more information.
*/
-#ifndef INKSCAPE_UI_WIDGET_LICENSOR__H
-#define INKSCAPE_UI_WIDGET_LICENSOR__H
+#ifndef INKSCAPE_UI_WIDGET_LICENSOR_H
+#define INKSCAPE_UI_WIDGET_LICENSOR_H
#include <gtkmm/box.h>
@@ -29,6 +26,10 @@ class EntityEntry;
class Registry;
+/**
+ * Widget for specifying a document's license; part of document
+ * preferences dialog.
+ */
class Licensor : public Gtk::VBox {
public:
Licensor();
@@ -45,7 +46,7 @@ protected:
} // namespace UI
} // namespace Inkscape
-#endif // INKSCAPE_UI_WIDGET_LICENSOR__H
+#endif // INKSCAPE_UI_WIDGET_LICENSOR_H
/*
Local Variables:
diff --git a/src/ui/widget/notebook-page.h b/src/ui/widget/notebook-page.h
index 38c13005e..bd53870d6 100644
--- a/src/ui/widget/notebook-page.h
+++ b/src/ui/widget/notebook-page.h
@@ -1,6 +1,4 @@
-/**
- * \brief Notebook Page Widget - A tabbed notebook page for dialogs.
- *
+/*
* Author:
* Bryce Harrington <bryce@bryceharrington.org>
*
@@ -20,6 +18,9 @@ namespace Inkscape {
namespace UI {
namespace Widget {
+/**
+ * A tabbed notebook page for dialogs.
+ */
class NotebookPage : public Gtk::VBox
{
public:
diff --git a/src/ui/widget/page-sizer.h b/src/ui/widget/page-sizer.h
index cb7f8a069..7f165266c 100644
--- a/src/ui/widget/page-sizer.h
+++ b/src/ui/widget/page-sizer.h
@@ -1,6 +1,4 @@
-/** \file
- * \brief Widget for specifying page size; part of Document Preferences dialog.
- *
+/*
* Author:
* Ralf Stephan <ralf@ark.in-berlin.de>
*
@@ -9,8 +7,8 @@
* Released under GNU GPL. Read the file 'COPYING' for more information.
*/
-#ifndef INKSCAPE_UI_WIDGET_PAGE_SIZER__H
-#define INKSCAPE_UI_WIDGET_PAGE_SIZER__H
+#ifndef INKSCAPE_UI_WIDGET_PAGE_SIZER_H
+#define INKSCAPE_UI_WIDGET_PAGE_SIZER_H
#include <gtkmm.h>
#include <stddef.h>
@@ -238,7 +236,7 @@ protected:
} // namespace Inkscape
-#endif /* INKSCAPE_UI_WIDGET_PAGE_SIZER__H */
+#endif // INKSCAPE_UI_WIDGET_PAGE_SIZER_H
/*
Local Variables:
diff --git a/src/ui/widget/panel.h b/src/ui/widget/panel.h
index fe3e226b4..3134111c0 100644
--- a/src/ui/widget/panel.h
+++ b/src/ui/widget/panel.h
@@ -1,6 +1,4 @@
-/**
- * \brief Generic Panel widget - A generic dockable container.
- *
+/*
* Authors:
* Bryce Harrington <bryce@bryceharrington.org>
* Jon A. Cruz <jon@joncruz.org>
@@ -35,6 +33,9 @@ namespace Inkscape {
namespace UI {
namespace Widget {
+/**
+ * A generic dockable container.
+ */
class Panel : public Gtk::VBox {
public:
diff --git a/src/ui/widget/point.h b/src/ui/widget/point.h
index 68d2f4c9d..651c8c8fb 100644
--- a/src/ui/widget/point.h
+++ b/src/ui/widget/point.h
@@ -1,7 +1,4 @@
-/**
- * \brief Point Widget - A labelled text box, with spin buttons and optional
- * icon or suffix, for entering arbitrary coordinate values.
- *
+/*
* Authors:
* Johan Engelen <j.b.c.engelen@utwente.nl>
* Carl Hetherington <inkscape@carlh.net>
@@ -13,7 +10,6 @@
*
* Released under GNU GPL. Read the file 'COPYING' for more information.
*/
-
#ifndef INKSCAPE_UI_WIDGET_POINT_H
#define INKSCAPE_UI_WIDGET_POINT_H
@@ -27,6 +23,10 @@ namespace Inkscape {
namespace UI {
namespace Widget {
+/**
+ * A labelled text box, with spin buttons and optional icon or suffix, for
+ * entering arbitrary coordinate values.
+ */
class Point : public Labelled
{
public:
diff --git a/src/ui/widget/preferences-widget.h b/src/ui/widget/preferences-widget.h
index 6caab11ae..83290a045 100644
--- a/src/ui/widget/preferences-widget.h
+++ b/src/ui/widget/preferences-widget.h
@@ -1,6 +1,8 @@
/**
- * \brief Inkscape Preferences dialog
- *
+ * @file
+ * Widgets for Inkscape Preferences dialog.
+ */
+/*
* Authors:
* Marco Scholten
* Bruno Dilly <bruno.dilly@gmail.com>
diff --git a/src/ui/widget/random.h b/src/ui/widget/random.h
index 71cc8d1e5..33f416e3f 100644
--- a/src/ui/widget/random.h
+++ b/src/ui/widget/random.h
@@ -1,7 +1,4 @@
-/**
- * \brief Random Scalar Widget - A labelled text box, with spin buttons and optional
- * icon or suffix, for entering arbitrary number values and generating a random number from it.
- *
+/*
* Authors:
* Johan Engelen <j.b.c.engelen@ewi.utwente.nl>
*
@@ -19,6 +16,10 @@ namespace Inkscape {
namespace UI {
namespace Widget {
+/**
+ * A labelled text box, with spin buttons and optional icon or suffix, for
+ * entering arbitrary number values and generating a random number from it.
+ */
class Random : public Scalar
{
public:
diff --git a/src/ui/widget/registered-enums.h b/src/ui/widget/registered-enums.h
index 056a09fed..9e1682c7d 100644
--- a/src/ui/widget/registered-enums.h
+++ b/src/ui/widget/registered-enums.h
@@ -1,6 +1,4 @@
-/**
- * \brief Simplified management of enumerations in the UI as combobox.
- *
+/*
* Authors:
* Johan Engelen <j.b.c.engelen@ewi.utwente.nl>
*
@@ -19,6 +17,9 @@ namespace Inkscape {
namespace UI {
namespace Widget {
+/**
+ * Simplified management of enumerations in the UI as combobox.
+ */
template<typename E> class RegisteredEnum : public RegisteredWidget< LabelledComboBoxEnum<E> >
{
public:
diff --git a/src/ui/widget/registered-widget.h b/src/ui/widget/registered-widget.h
index f05eb176a..a948e1535 100644
--- a/src/ui/widget/registered-widget.h
+++ b/src/ui/widget/registered-widget.h
@@ -1,6 +1,4 @@
-/** \file
- * \brief
- *
+/*
* Authors:
* Ralf Stephan <ralf@ark.in-berlin.de>
* Johan Engelen <j.b.c.engelen@utwente.nl>
diff --git a/src/ui/widget/registry.h b/src/ui/widget/registry.h
index 4d7ad3068..ed1281d79 100644
--- a/src/ui/widget/registry.h
+++ b/src/ui/widget/registry.h
@@ -1,6 +1,4 @@
-/** \file
- * \brief
- *
+/*
* Authors:
* Ralf Stephan <ralf@ark.in-berlin.de>
*
@@ -8,7 +6,6 @@
*
* Released under GNU GPL. Read the file 'COPYING' for more information.
*/
-
#ifndef INKSCAPE_UI_WIDGET_REGISTRY__H
#define INKSCAPE_UI_WIDGET_REGISTRY__H
diff --git a/src/ui/widget/rendering-options.h b/src/ui/widget/rendering-options.h
index 8e047e682..3e2e046d3 100644
--- a/src/ui/widget/rendering-options.h
+++ b/src/ui/widget/rendering-options.h
@@ -1,6 +1,4 @@
-/**
- * \brief Rendering Options Widget - A container for selecting rendering options
- *
+/*
* Author:
* Kees Cook <kees@outflux.net>
*
@@ -20,6 +18,9 @@ namespace Inkscape {
namespace UI {
namespace Widget {
+/**
+ * A container for selecting rendering options.
+ */
class RenderingOptions : public Gtk::VBox
{
public:
diff --git a/src/ui/widget/rotateable.h b/src/ui/widget/rotateable.h
index 79a6daa5b..15e0bf71c 100644
--- a/src/ui/widget/rotateable.h
+++ b/src/ui/widget/rotateable.h
@@ -1,6 +1,4 @@
-/**
- * \brief widget adjustable by dragging it to rotate away from a zero-change axis
- *
+/*
* Authors:
* buliabyak@gmail.com
*
@@ -20,6 +18,9 @@ namespace Inkscape {
namespace UI {
namespace Widget {
+/**
+ * Widget adjustable by dragging it to rotate away from a zero-change axis.
+ */
class Rotateable: public Gtk::EventBox
{
public:
diff --git a/src/ui/widget/ruler.h b/src/ui/widget/ruler.h
index afe3a4ba7..319624709 100644
--- a/src/ui/widget/ruler.h
+++ b/src/ui/widget/ruler.h
@@ -1,9 +1,7 @@
-#ifndef __UI_WIDGET_RULER_H__
-#define __UI_WIDGET_RULER_H__
+#ifndef SEEN_UI_WIDGET_RULER_H
+#define SEEN_UI_WIDGET_RULER_H
-/** \file
- * Gtkmm facade/wrapper around sp_rulers.
- *
+/*
* Authors:
* Ralf Stephan <ralf@ark.in-berlin.de>
*
@@ -24,9 +22,12 @@ namespace Gtk {
class Ruler;
}
namespace Inkscape {
- namespace UI {
- namespace Widget {
+namespace UI {
+namespace Widget {
+/**
+ * Gtkmm facade/wrapper around sp_rulers.
+ */
class Ruler : public Gtk::EventBox
{
public:
@@ -52,7 +53,9 @@ private:
Geom::Point get_event_dt();
};
-/// Horizontal ruler
+/**
+ * Horizontal ruler gtkmm wrapper.
+ */
class HRuler : public Ruler
{
public:
@@ -60,7 +63,9 @@ public:
~HRuler();
};
-/// Vertical ruler
+/**
+ * Vertical ruler gtkmm wrapper.
+ */
class VRuler : public Ruler
{
public:
@@ -73,7 +78,7 @@ public:
} // namespace Inkscape
-#endif
+#endif // SEEN_UI_WIDGET_RULER_H
/*
diff --git a/src/ui/widget/scalar-unit.h b/src/ui/widget/scalar-unit.h
index ed3728e69..05a7b95f8 100644
--- a/src/ui/widget/scalar-unit.h
+++ b/src/ui/widget/scalar-unit.h
@@ -1,8 +1,4 @@
-/**
- * \brief Scalar Unit Widget - A labelled text box, with spin buttons and
- * optional icon or suffix, for entering the values of various unit
- * types.
- *
+/*
* Authors:
* Bryce Harrington <bryce@bryceharrington.org>
* Derek P. Moore <derekm@hackunix.org>
@@ -23,6 +19,10 @@ namespace Inkscape {
namespace UI {
namespace Widget {
+/**
+ * A labelled text box, with spin buttons and optional icon or suffix, for
+ * entering the values of various unit types.
+ */
class ScalarUnit : public Scalar
{
public:
diff --git a/src/ui/widget/scalar.h b/src/ui/widget/scalar.h
index 7142ba93f..66bd07ddb 100644
--- a/src/ui/widget/scalar.h
+++ b/src/ui/widget/scalar.h
@@ -1,7 +1,4 @@
-/**
- * \brief Scalar Widget - A labelled text box, with spin buttons and optional
- * icon or suffix, for entering arbitrary number values.
- *
+/*
* Authors:
* Carl Hetherington <inkscape@carlh.net>
* Derek P. Moore <derekm@hackunix.org>
@@ -21,6 +18,10 @@ namespace Inkscape {
namespace UI {
namespace Widget {
+/**
+ * A labelled text box, with spin buttons and optional
+ * icon or suffix, for entering arbitrary number values.
+ */
class Scalar : public Labelled
{
public:
diff --git a/src/ui/widget/selected-style.h b/src/ui/widget/selected-style.h
index 0caa7fe4c..916cbe6d1 100644
--- a/src/ui/widget/selected-style.h
+++ b/src/ui/widget/selected-style.h
@@ -1,6 +1,4 @@
-/**
- * \brief Selected style indicator (fill, stroke, opacity)
- *
+/*
* Authors:
* buliabyak@gmail.com
* scislac@users.sf.net
@@ -103,6 +101,9 @@ private:
bool cr_set;
};
+/**
+ * Selected style indicator (fill, stroke, opacity).
+ */
class SelectedStyle : public Gtk::HBox
{
public:
diff --git a/src/ui/widget/spin-slider.h b/src/ui/widget/spin-slider.h
index 703c5d896..7c2ef7ca4 100644
--- a/src/ui/widget/spin-slider.h
+++ b/src/ui/widget/spin-slider.h
@@ -1,6 +1,4 @@
-/**
- * \brief Groups an HScale and a SpinButton together using the same Adjustment
- *
+/*
* Author:
* Nicholas Bishop <nicholasbishop@gmail.com>
*
@@ -22,6 +20,9 @@ namespace Inkscape {
namespace UI {
namespace Widget {
+/**
+ * Groups an HScale and a SpinButton together using the same Adjustment.
+ */
class SpinSlider : public Gtk::HBox, public AttrWidget
{
public:
@@ -55,7 +56,11 @@ private:
Inkscape::UI::Widget::SpinButton _spin;
};
-// Contains two SpinSliders for controlling number-opt-number attributes
+/**
+ * Contains two SpinSliders for controlling number-opt-number attributes.
+ *
+ * @see SpinSlider
+ */
class DualSpinSlider : public Gtk::HBox, public AttrWidget
{
public:
diff --git a/src/ui/widget/style-subject.h b/src/ui/widget/style-subject.h
index 29684ec02..47da91732 100644
--- a/src/ui/widget/style-subject.h
+++ b/src/ui/widget/style-subject.h
@@ -1,11 +1,12 @@
/**
- * \brief Abstraction for different style widget operands
- *
+ * @file
+ * Abstraction for different style widget operands.
+ */
+/*
* Copyright (C) 2007 MenTaLguY <mental@rydia.net>
*
* Released under GNU GPL. Read the file 'COPYING' for more information.
*/
-
#ifndef SEEN_INKSCAPE_UI_WIDGET_STYLE_SUBJECT_H
#define SEEN_INKSCAPE_UI_WIDGET_STYLE_SUBJECT_H
@@ -110,7 +111,7 @@ private:
}
}
-#endif
+#endif // SEEN_INKSCAPE_UI_WIDGET_STYLE_SUBJECT_H
/*
Local Variables:
diff --git a/src/ui/widget/svg-canvas.h b/src/ui/widget/svg-canvas.h
index cb8dc4013..c513bcf26 100644
--- a/src/ui/widget/svg-canvas.h
+++ b/src/ui/widget/svg-canvas.h
@@ -1,9 +1,7 @@
-#ifndef __UI_WIDGET_SVGCANVAS_H__
-#define __UI_WIDGET_SVGCANVAS_H__
+#ifndef SEEN_UI_WIDGET_SVGCANVAS_H
+#define SEEN_UI_WIDGET_SVGCANVAS_H
-/** \file
- * Gtkmm facade/wrapper around SPCanvas.
- *
+/*
* Authors:
* Ralf Stephan <ralf@ark.in-berlin.de>
*
@@ -16,9 +14,12 @@ struct SPCanvas;
struct SPDesktop;
namespace Gtk { class Widget; }
namespace Inkscape {
- namespace UI {
- namespace Widget {
+namespace UI {
+namespace Widget {
+/**
+ * Gtkmm facade/wrapper around SPCanvas.
+ */
class SVGCanvas
{
public:
@@ -41,7 +42,7 @@ protected:
} // namespace Inkscape
-#endif
+#endif // SEEN_UI_WIDGET_SVGCANVAS_H
/*
diff --git a/src/ui/widget/text.h b/src/ui/widget/text.h
index 0dcfc5cc6..bccaefa2e 100644
--- a/src/ui/widget/text.h
+++ b/src/ui/widget/text.h
@@ -1,7 +1,4 @@
-/**
- * \brief Text Widget - A labelled text box, with optional icon or
- * suffix, for entering arbitrary number values.
- *
+/*
* Authors:
* Carl Hetherington <inkscape@carlh.net>
* Maximilian Albert <maximilian.albert@gmail.com>
@@ -23,6 +20,9 @@ namespace Inkscape {
namespace UI {
namespace Widget {
+/**
+ * A labelled text box, with optional icon or suffix, for entering arbitrary number values.
+ */
class Text : public Labelled
{
public:
diff --git a/src/ui/widget/toolbox.h b/src/ui/widget/toolbox.h
index 9c4e18909..f721bef8a 100644
--- a/src/ui/widget/toolbox.h
+++ b/src/ui/widget/toolbox.h
@@ -1,6 +1,4 @@
-/**
- * \brief Toolbox Widget - A detachable toolbar for buttons and other widgets.
- *
+/*
* Author:
* Derek P. Moore <derekm@hackunix.org>
*
@@ -22,6 +20,9 @@ namespace Inkscape {
namespace UI {
namespace Widget {
+/**
+ * A detachable toolbar for buttons and other widgets.
+ */
class Toolbox : public HandleBox
{
public:
diff --git a/src/ui/widget/unit-menu.h b/src/ui/widget/unit-menu.h
index cf42231ba..cb11bbb30 100644
--- a/src/ui/widget/unit-menu.h
+++ b/src/ui/widget/unit-menu.h
@@ -1,6 +1,4 @@
-/**
- * \brief Unit Menu Widget - A drop down menu for choosing unit types.
- *
+/*
* Author:
* Bryce Harrington <bryce@bryceharrington.org>
*
@@ -21,6 +19,9 @@ namespace Inkscape {
namespace UI {
namespace Widget {
+/**
+ * A drop down menu for choosing unit types.
+ */
class UnitMenu : public ComboText
{
public:
diff --git a/src/ui/widget/zoom-status.h b/src/ui/widget/zoom-status.h
index 85c3eeee1..b9373589f 100644
--- a/src/ui/widget/zoom-status.h
+++ b/src/ui/widget/zoom-status.h
@@ -1,9 +1,6 @@
-#ifndef __UI_WIDGET_ZOOMSTATUS_H__
-#define __UI_WIDGET_ZOOMSTATUS_H__
-
-/** \file
- * Enhanced spinbutton.
- *
+#ifndef SEEN_UI_WIDGET_ZOOMSTATUS_H
+#define SEEN_UI_WIDGET_ZOOMSTATUS_H
+/*
* Authors:
* Ralf Stephan <ralf@ark.in-berlin.de>
*
@@ -22,6 +19,9 @@ namespace Inkscape {
namespace UI {
namespace Widget {
+/**
+ * Enhanced spinbutton.
+ */
class ZoomStatus : public Inkscape::UI::Widget::SpinButton
{
public:
@@ -46,7 +46,7 @@ protected:
} // namespace Inkscape
-#endif
+#endif // SEEN_UI_WIDGET_ZOOMSTATUS_H
/*