Fixing more broken and split doc comments.

(bzr r10697)

1 files changed, 15 insertions, 78 deletions

diff --git a/src/ui/widget/scalar.cpp b/src/ui/widget/scalar.cpp
index 4237d9db9..220498561 100644
--- a/src/ui/widget/scalar.cpp
+++ b/src/ui/widget/scalar.cpp
@@ -1,7 +1,4 @@
-/**
- * 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>
@@ -24,16 +21,6 @@ namespace Inkscape {
 namespace UI {
 namespace Widget {
 
-/**
- * Construct a Scalar Widget.
- *
- * \param label     Label.
- * \param suffix    Suffix, placed after the widget (defaults to "").
- * \param icon      Icon filename, placed before the label (defaults to "").
- * \param mnemonic  Mnemonic toggle; if true, an underscore (_) in the label
- *                  indicates the next character should be used for the
- *                  mnemonic accelerator key (defaults to false).
- */
 Scalar::Scalar(Glib::ustring const &label, Glib::ustring const &tooltip,
                Glib::ustring const &suffix,
                Glib::ustring const &icon,
@@ -43,17 +30,6 @@ Scalar::Scalar(Glib::ustring const &label, Glib::ustring const &tooltip,
 {
 }
 
-/**
- * Construct a Scalar Widget.
- *
- * \param label     Label.
- * \param digits    Number of decimal digits to display.
- * \param suffix    Suffix, placed after the widget (defaults to "").
- * \param icon      Icon filename, placed before the label (defaults to "").
- * \param mnemonic  Mnemonic toggle; if true, an underscore (_) in the label
- *                  indicates the next character should be used for the
- *                  mnemonic accelerator key (defaults to false).
- */
 Scalar::Scalar(Glib::ustring const &label, Glib::ustring const &tooltip,
                unsigned digits,
                Glib::ustring const &suffix,
@@ -64,18 +40,6 @@ Scalar::Scalar(Glib::ustring const &label, Glib::ustring const &tooltip,
 {
 }
 
-/**
- * Construct a Scalar Widget.
- *
- * \param label     Label.
- * \param adjust    Adjustment to use for the SpinButton.
- * \param digits    Number of decimal digits to display (defaults to 0).
- * \param suffix    Suffix, placed after the widget (defaults to "").
- * \param icon      Icon filename, placed before the label (defaults to "").
- * \param mnemonic  Mnemonic toggle; if true, an underscore (_) in the label
- *                  indicates the next character should be used for the
- *                  mnemonic accelerator key (defaults to true).
- */
 Scalar::Scalar(Glib::ustring const &label, Glib::ustring const &tooltip,
                Gtk::Adjustment &adjust,
                unsigned digits,
@@ -87,17 +51,13 @@ Scalar::Scalar(Glib::ustring const &label, Glib::ustring const &tooltip,
 {
 }
 
-/** Fetches the precision of the spin buton */
-unsigned
-Scalar::getDigits() const
+unsigned Scalar::getDigits() const
 {
     g_assert(_widget != NULL);
     return static_cast<SpinButton*>(_widget)->get_digits();
 }
 
-/** Gets the current step ingrement used by the spin button */
-double
-Scalar::getStep() const
+double Scalar::getStep() const
 {
     g_assert(_widget != NULL);
     double step, page;
@@ -105,9 +65,7 @@ Scalar::getStep() const
     return step;
 }
 
-/** Gets the current page increment used by the spin button */
-double
-Scalar::getPage() const
+double Scalar::getPage() const
 {
     g_assert(_widget != NULL);
     double step, page;
@@ -115,9 +73,7 @@ Scalar::getPage() const
     return page;
 }
 
-/** Gets the minimum range value allowed for the spin button */
-double
-Scalar::getRangeMin() const
+double Scalar::getRangeMin() const
 {
     g_assert(_widget != NULL);
     double min, max;
@@ -125,9 +81,7 @@ Scalar::getRangeMin() const
     return min;
 }
 
-/** Gets the maximum range value allowed for the spin button */
-double
-Scalar::getRangeMax() const
+double Scalar::getRangeMax() const
 {
     g_assert(_widget != NULL);
     double min, max;
@@ -135,70 +89,53 @@ Scalar::getRangeMax() const
     return max;
 }
 
-/** Get the value in the spin_button . */
-double
-Scalar::getValue() const
+double Scalar::getValue() const
 {
     g_assert(_widget != NULL);
     return static_cast<SpinButton*>(_widget)->get_value();
 }
 
-/** Get the value spin_button represented as an integer. */
-int
-Scalar::getValueAsInt() const
+int Scalar::getValueAsInt() const
 {
     g_assert(_widget != NULL);
     return static_cast<SpinButton*>(_widget)->get_value_as_int();
 }
 
 
-/** Sets the precision to be displayed by the spin button */
-void
-Scalar::setDigits(unsigned digits)
+void Scalar::setDigits(unsigned digits)
 {
     g_assert(_widget != NULL);
     static_cast<SpinButton*>(_widget)->set_digits(digits);
 }
 
-/** Sets the step and page increments for the spin button
- * @todo Remove the second parameter - deprecated
- */
-void
-Scalar::setIncrements(double step, double /*page*/)
+void Scalar::setIncrements(double step, double /*page*/)
 {
     g_assert(_widget != NULL);
     static_cast<SpinButton*>(_widget)->set_increments(step, 0);
 }
 
-/** Sets the minimum and maximum range allowed for the spin button */
-void
-Scalar::setRange(double min, double max)
+void Scalar::setRange(double min, double max)
 {
     g_assert(_widget != NULL);
     static_cast<SpinButton*>(_widget)->set_range(min, max);
 }
 
-/** Sets the value of the spin button */
-void
-Scalar::setValue(double value)
+void Scalar::setValue(double value)
 {
     g_assert(_widget != NULL);
     setProgrammatically = true; // callback is supposed to reset back, if it cares
     static_cast<SpinButton*>(_widget)->set_value(value);
 }
 
-/** Manually forces an update of the spin button */
-void
-Scalar::update() {
+void Scalar::update()
+{
     g_assert(_widget != NULL);
     static_cast<SpinButton*>(_widget)->update();
 }
 
 
 
-/** Signal raised when the spin button's value changes */
-Glib::SignalProxy0<void>
-Scalar::signal_value_changed()
+Glib::SignalProxy0<void> Scalar::signal_value_changed()
 {
     return static_cast<SpinButton*>(_widget)->signal_value_changed();
 }