diff options
Diffstat (limited to 'src/ui')
68 files changed, 317 insertions, 265 deletions
diff --git a/src/ui/clipboard.cpp b/src/ui/clipboard.cpp index bb89879fb..d1191cb3b 100644 --- a/src/ui/clipboard.cpp +++ b/src/ui/clipboard.cpp @@ -1,5 +1,6 @@ -/** @file - * @brief System-wide clipboard management - implementation +/** + * @file + * System-wide clipboard management - implementation. */ /* Authors: * Krzysztof Kosiński <tweenk@o2.pl> @@ -82,7 +83,7 @@ #include "snap.h" #include "persp3d.h" -/// @brief Made up mimetype to represent Gdk::Pixbuf clipboard contents +/// Made up mimetype to represent Gdk::Pixbuf clipboard contents. #define CLIPBOARD_GDK_PIXBUF_TARGET "image/x-gdk-pixbuf" #define CLIPBOARD_TEXT_TARGET "text/plain" @@ -102,7 +103,7 @@ namespace UI { /** - * @brief Default implementation of the clipboard manager + * Default implementation of the clipboard manager. */ class ClipboardManagerImpl : public ClipboardManager { public: @@ -192,7 +193,7 @@ ClipboardManagerImpl::~ClipboardManagerImpl() {} /** - * @brief Copy selection contents to the clipboard + * Copy selection contents to the clipboard. */ void ClipboardManagerImpl::copy(SPDesktop *desktop) { @@ -272,8 +273,8 @@ void ClipboardManagerImpl::copy(SPDesktop *desktop) /** - * @brief Copy a Live Path Effect path parameter to the clipboard - * @param pp The path parameter to store in the clipboard + * Copy a Live Path Effect path parameter to the clipboard. + * @param pp The path parameter to store in the clipboard. */ void ClipboardManagerImpl::copyPathParameter(Inkscape::LivePathEffect::PathParam *pp) { @@ -299,8 +300,8 @@ void ClipboardManagerImpl::copyPathParameter(Inkscape::LivePathEffect::PathParam } /** - * @brief Paste from the system clipboard into the active desktop - * @param in_place Whether to put the contents where they were when copied + * Paste from the system clipboard into the active desktop. + * @param in_place Whether to put the contents where they were when copied. */ bool ClipboardManagerImpl::paste(SPDesktop *desktop, bool in_place) { @@ -341,7 +342,7 @@ bool ClipboardManagerImpl::paste(SPDesktop *desktop, bool in_place) } /** - * @brief Returns the id of the first visible copied object + * Returns the id of the first visible copied object. */ const gchar *ClipboardManagerImpl::getFirstObjectID() { @@ -377,7 +378,7 @@ const gchar *ClipboardManagerImpl::getFirstObjectID() /** - * @brief Implements the Paste Style action + * Implements the Paste Style action. */ bool ClipboardManagerImpl::pasteStyle(SPDesktop *desktop) { @@ -425,7 +426,7 @@ bool ClipboardManagerImpl::pasteStyle(SPDesktop *desktop) /** - * @brief Resize the selection or each object in the selection to match the clipboard's size + * Resize the selection or each object in the selection to match the clipboard's size. * @param separately Whether to scale each object in the selection separately * @param apply_x Whether to scale the width of objects / selection * @param apply_y Whether to scale the height of objects / selection @@ -488,7 +489,7 @@ bool ClipboardManagerImpl::pasteSize(SPDesktop *desktop, bool separately, bool a /** - * @brief Applies a path effect from the clipboard to the selected path + * Applies a path effect from the clipboard to the selected path. */ bool ClipboardManagerImpl::pastePathEffect(SPDesktop *desktop) { @@ -532,7 +533,7 @@ bool ClipboardManagerImpl::pastePathEffect(SPDesktop *desktop) /** - * @brief Get LPE path data from the clipboard + * Get LPE path data from the clipboard. * @return The retrieved path data (contents of the d attribute), or "" if no path was found */ Glib::ustring ClipboardManagerImpl::getPathParameter(SPDesktop* desktop) @@ -555,8 +556,8 @@ Glib::ustring ClipboardManagerImpl::getPathParameter(SPDesktop* desktop) /** - * @brief Get object id of a shape or text item from the clipboard - * @return The retrieved id string (contents of the id attribute), or "" if no shape or text item was found + * Get object id of a shape or text item from the clipboard. + * @return The retrieved id string (contents of the id attribute), or "" if no shape or text item was found. */ Glib::ustring ClipboardManagerImpl::getShapeOrTextObjectId(SPDesktop *desktop) { @@ -583,7 +584,7 @@ Glib::ustring ClipboardManagerImpl::getShapeOrTextObjectId(SPDesktop *desktop) /** - * @brief Iterate over a list of items and copy them to the clipboard. + * Iterate over a list of items and copy them to the clipboard. */ void ClipboardManagerImpl::_copySelection(Inkscape::Selection *selection) { @@ -645,7 +646,7 @@ void ClipboardManagerImpl::_copySelection(Inkscape::Selection *selection) /** - * @brief Recursively copy all the definitions used by a given item to the clipboard defs + * Recursively copy all the definitions used by a given item to the clipboard defs. */ void ClipboardManagerImpl::_copyUsedDefs(SPItem *item) { @@ -734,7 +735,7 @@ void ClipboardManagerImpl::_copyUsedDefs(SPItem *item) /** - * @brief Copy a single gradient to the clipboard's defs element + * Copy a single gradient to the clipboard's defs element. */ void ClipboardManagerImpl::_copyGradient(SPGradient *gradient) { @@ -747,7 +748,7 @@ void ClipboardManagerImpl::_copyGradient(SPGradient *gradient) /** - * @brief Copy a single pattern to the clipboard document's defs element + * Copy a single pattern to the clipboard document's defs element. */ void ClipboardManagerImpl::_copyPattern(SPPattern *pattern) { @@ -768,7 +769,7 @@ void ClipboardManagerImpl::_copyPattern(SPPattern *pattern) /** - * @brief Copy a text path to the clipboard's defs element + * Copy a text path to the clipboard's defs element. */ void ClipboardManagerImpl::_copyTextPath(SPTextPath *tp) { @@ -787,7 +788,7 @@ void ClipboardManagerImpl::_copyTextPath(SPTextPath *tp) /** - * @brief Copy a single XML node from one document to another + * Copy a single XML node from one document to another. * @param node The node to be copied * @param target_doc The document to which the node is to be copied * @param parent The node in the target document which will become the parent of the copied node @@ -803,7 +804,7 @@ Inkscape::XML::Node *ClipboardManagerImpl::_copyNode(Inkscape::XML::Node *node, /** - * @brief Paste the contents of a document into the active desktop + * Paste the contents of a document into the active desktop. * @param clipdoc The document to paste * @param in_place Whether to paste the selection where it was when copied * @pre @c clipdoc is not empty and items can be added to the current layer @@ -882,9 +883,9 @@ void ClipboardManagerImpl::_pasteDocument(SPDesktop *desktop, SPDocument *clipdo /** - * @brief Paste SVG defs from the document retrieved from the clipboard into the active document - * @param clipdoc The document to paste - * @pre @c clipdoc != NULL and pasting into the active document is possible + * Paste SVG defs from the document retrieved from the clipboard into the active document. + * @param clipdoc The document to paste. + * @pre @c clipdoc != NULL and pasting into the active document is possible. */ void ClipboardManagerImpl::_pasteDefs(SPDesktop *desktop, SPDocument *clipdoc) { @@ -904,7 +905,7 @@ void ClipboardManagerImpl::_pasteDefs(SPDesktop *desktop, SPDocument *clipdoc) /** - * @brief Retrieve a bitmap image from the clipboard and paste it into the active document + * Retrieve a bitmap image from the clipboard and paste it into the active document. */ bool ClipboardManagerImpl::_pasteImage(SPDocument *doc) { @@ -943,7 +944,7 @@ bool ClipboardManagerImpl::_pasteImage(SPDocument *doc) } /** - * @brief Paste text into the selected text object or create a new one to hold it + * Paste text into the selected text object or create a new one to hold it. */ bool ClipboardManagerImpl::_pasteText(SPDesktop *desktop) { @@ -968,7 +969,7 @@ bool ClipboardManagerImpl::_pasteText(SPDesktop *desktop) /** - * @brief Attempt to parse the passed string as a hexadecimal RGB or RGBA color + * Attempt to parse the passed string as a hexadecimal RGB or RGBA color. * @param text The Glib::ustring to parse * @return New CSS style representation if the parsing was successful, NULL otherwise */ @@ -1038,7 +1039,7 @@ SPCSSAttr *ClipboardManagerImpl::_parseColor(const Glib::ustring &text) /** - * @brief Applies a pasted path effect to a given item + * Applies a pasted path effect to a given item. */ void ClipboardManagerImpl::_applyPathEffect(SPItem *item, gchar const *effectstack) { @@ -1071,7 +1072,7 @@ void ClipboardManagerImpl::_applyPathEffect(SPItem *item, gchar const *effectsta /** - * @brief Retrieve the clipboard contents as a document + * Retrieve the clipboard contents as a document. * @return Clipboard contents converted to SPDocument, or NULL if no suitable content was present */ SPDocument *ClipboardManagerImpl::_retrieveClipboard(Glib::ustring required_target) @@ -1157,7 +1158,7 @@ SPDocument *ClipboardManagerImpl::_retrieveClipboard(Glib::ustring required_targ /** - * @brief Callback called when some other application requests data from Inkscape + * Callback called when some other application requests data from Inkscape. * * Finds a suitable output extension to save the internal clipboard document, * then saves it to memory and sets the clipboard contents. @@ -1232,7 +1233,7 @@ void ClipboardManagerImpl::_onGet(Gtk::SelectionData &sel, guint /*info*/) /** - * @brief Callback when someone else takes the clipboard + * Callback when someone else takes the clipboard. * * When the clipboard owner changes, this callback clears the internal clipboard document * to reduce memory usage. @@ -1245,7 +1246,7 @@ void ClipboardManagerImpl::_onClear() /** - * @brief Creates an internal clipboard document from scratch + * Creates an internal clipboard document from scratch. */ void ClipboardManagerImpl::_createInternalClipboard() { @@ -1270,7 +1271,7 @@ void ClipboardManagerImpl::_createInternalClipboard() /** - * @brief Deletes the internal clipboard document + * Deletes the internal clipboard document. */ void ClipboardManagerImpl::_discardInternalClipboard() { @@ -1286,7 +1287,7 @@ void ClipboardManagerImpl::_discardInternalClipboard() /** - * @brief Get the scale to resize an item, based on the command and desktop state + * Get the scale to resize an item, based on the command and desktop state. */ Geom::Scale ClipboardManagerImpl::_getScale(SPDesktop *desktop, Geom::Point const &min, Geom::Point const &max, Geom::Rect const &obj_rect, bool apply_x, bool apply_y) { @@ -1315,7 +1316,7 @@ Geom::Scale ClipboardManagerImpl::_getScale(SPDesktop *desktop, Geom::Point cons /** - * @brief Find the most suitable clipboard target + * Find the most suitable clipboard target. */ Glib::ustring ClipboardManagerImpl::_getBestTarget() { @@ -1374,7 +1375,7 @@ Glib::ustring ClipboardManagerImpl::_getBestTarget() /** - * @brief Set the clipboard targets to reflect the mimetypes Inkscape can output + * Set the clipboard targets to reflect the mimetypes Inkscape can output. */ void ClipboardManagerImpl::_setClipboardTargets() { @@ -1449,7 +1450,7 @@ void ClipboardManagerImpl::_setClipboardTargets() /** - * @brief Set the string representation of a 32-bit RGBA color as the clipboard contents + * Set the string representation of a 32-bit RGBA color as the clipboard contents. */ void ClipboardManagerImpl::_setClipboardColor(guint32 color) { @@ -1460,7 +1461,7 @@ void ClipboardManagerImpl::_setClipboardColor(guint32 color) /** - * @brief Put a notification on the mesage stack + * Put a notification on the mesage stack. */ void ClipboardManagerImpl::_userWarn(SPDesktop *desktop, char const *msg) { diff --git a/src/ui/dialog/aboutbox.cpp b/src/ui/dialog/aboutbox.cpp index d1bc255b0..c8538d1fb 100644 --- a/src/ui/dialog/aboutbox.cpp +++ b/src/ui/dialog/aboutbox.cpp @@ -1,5 +1,6 @@ -/** @file - * @brief Inkscape About box - implementation +/** + * @file + * Inkscape About box - implementation. */ /* Authors: * Derek P. Moore <derekm@hackunix.org> diff --git a/src/ui/dialog/align-and-distribute.cpp b/src/ui/dialog/align-and-distribute.cpp index 36d5a20d0..573674406 100644 --- a/src/ui/dialog/align-and-distribute.cpp +++ b/src/ui/dialog/align-and-distribute.cpp @@ -1,5 +1,6 @@ -/** @file - * @brief Align and Distribute dialog - implementation +/** + * @file + * Align and Distribute dialog - implementation. */ /* Authors: * Bryce W. Harrington <bryce@bryceharrington.org> diff --git a/src/ui/dialog/calligraphic-profile-rename.cpp b/src/ui/dialog/calligraphic-profile-rename.cpp index fd7299ba2..e44b46308 100644 --- a/src/ui/dialog/calligraphic-profile-rename.cpp +++ b/src/ui/dialog/calligraphic-profile-rename.cpp @@ -1,5 +1,6 @@ -/** @file - * @brief Dialog for naming calligraphic profiles +/** + * @file + * Dialog for naming calligraphic profiles. * * @note This file is in the wrong directory because of link order issues - * it is required by widgets/toolbox.cpp, and libspwidgets.a comes after diff --git a/src/ui/dialog/color-item.cpp b/src/ui/dialog/color-item.cpp index b61925855..f245cec37 100644 --- a/src/ui/dialog/color-item.cpp +++ b/src/ui/dialog/color-item.cpp @@ -1,5 +1,6 @@ -/** @file - * @brief Inkscape color swatch UI item. +/** + * @file + * Inkscape color swatch UI item. */ /* Authors: * Jon A. Cruz diff --git a/src/ui/dialog/debug.cpp b/src/ui/dialog/debug.cpp index 1f7539fc7..7a2515789 100644 --- a/src/ui/dialog/debug.cpp +++ b/src/ui/dialog/debug.cpp @@ -1,5 +1,6 @@ -/** @file - * @brief A dialog that displays log messages +/** + * @file + * A dialog that displays log messages. */ /* Authors: * Bob Jamison @@ -27,7 +28,7 @@ namespace UI { namespace Dialog { /** - * @brief A very simple dialog for displaying Inkscape messages - implementation + * A very simple dialog for displaying Inkscape messages - implementation. */ class DebugDialogImpl : public DebugDialog, public Gtk::Dialog { diff --git a/src/ui/dialog/dialog-manager.cpp b/src/ui/dialog/dialog-manager.cpp index 0c49690cc..cba0cf508 100644 --- a/src/ui/dialog/dialog-manager.cpp +++ b/src/ui/dialog/dialog-manager.cpp @@ -1,5 +1,6 @@ -/** @file - * @brief Object for managing a set of dialogs, including their signals and +/** + * @file + * Object for managing a set of dialogs, including their signals and * construction/caching/destruction of them. */ /* Authors: diff --git a/src/ui/dialog/dialog.cpp b/src/ui/dialog/dialog.cpp index 88724a90c..3d3ea867e 100644 --- a/src/ui/dialog/dialog.cpp +++ b/src/ui/dialog/dialog.cpp @@ -1,5 +1,6 @@ -/** @file - * @brief Base class for dialogs in Inkscape - implementation +/** + * @file + * Base class for dialogs in Inkscape - implementation. */ /* Authors: * Bryce W. Harrington <bryce@bryceharrington.org> diff --git a/src/ui/dialog/dock-behavior.cpp b/src/ui/dialog/dock-behavior.cpp index 25fa1739a..cf4d36cff 100644 --- a/src/ui/dialog/dock-behavior.cpp +++ b/src/ui/dialog/dock-behavior.cpp @@ -1,5 +1,6 @@ -/** @file - * @brief A dockable dialog implementation. +/** + * @file + * A dockable dialog implementation. */ /* Author: * Gustav Broberg <broberg@kth.se> diff --git a/src/ui/dialog/document-metadata.cpp b/src/ui/dialog/document-metadata.cpp index 08479275b..0dae7bd88 100644 --- a/src/ui/dialog/document-metadata.cpp +++ b/src/ui/dialog/document-metadata.cpp @@ -1,5 +1,6 @@ -/** @file - * @brief Document metadata dialog, Gtkmm-style +/** + * @file + * Document metadata dialog, Gtkmm-style. */ /* Authors: * bulia byak <buliabyak@users.sf.net> @@ -108,9 +109,8 @@ DocumentMetadata::~DocumentMetadata() * possible cases: (0,0) means insert space in first column; (0, non-0) means * widget in columns 2-3; (non-0, 0) means label in columns 1-3; and * (non-0, non-0) means two widgets in columns 2 and 3. -**/ -inline void -attach_all (Gtk::Table &table, const Gtk::Widget *arr[], unsigned size, int start = 0) + */ +inline void attach_all(Gtk::Table &table, const Gtk::Widget *arr[], unsigned size, int start = 0) { for (unsigned i=0, r=start; i<size/sizeof(Gtk::Widget*); i+=2) { @@ -190,8 +190,7 @@ DocumentMetadata::build_metadata() /** * Update dialog widgets from desktop. */ -void -DocumentMetadata::update() +void DocumentMetadata::update() { if (_wr.isUpdating()) return; @@ -236,8 +235,7 @@ DocumentMetadata::_handleDeactivateDesktop(Inkscape::Application *, SPDesktop *d /** * Called when XML node attribute changed; updates dialog widgets. */ -static void -on_repr_attr_changed (Inkscape::XML::Node *, gchar const *, gchar const *, gchar const *, bool, gpointer data) +static void on_repr_attr_changed(Inkscape::XML::Node *, gchar const *, gchar const *, gchar const *, bool, gpointer data) { if (DocumentMetadata *dialog = static_cast<DocumentMetadata *>(data)) dialog->update(); diff --git a/src/ui/dialog/document-properties.cpp b/src/ui/dialog/document-properties.cpp index 69d634e59..d3123345b 100644 --- a/src/ui/dialog/document-properties.cpp +++ b/src/ui/dialog/document-properties.cpp @@ -1,5 +1,6 @@ -/** @file - * @brief Document properties dialog, Gtkmm-style +/** + * @file + * Document properties dialog, Gtkmm-style. */ /* Authors: * bulia byak <buliabyak@users.sf.net> @@ -165,9 +166,8 @@ DocumentProperties::~DocumentProperties() * possible cases: (0,0) means insert space in first column; (0, non-0) means * widget in columns 2-3; (non-0, 0) means label in columns 1-3; and * (non-0, non-0) means two widgets in columns 2 and 3. -**/ -inline void -attach_all(Gtk::Table &table, Gtk::Widget *const arr[], unsigned const n, int start = 0) + */ +inline void attach_all(Gtk::Table &table, Gtk::Widget *const arr[], unsigned const n, int start = 0) { for (unsigned i = 0, r = start; i < n; i += 2) { @@ -904,8 +904,7 @@ void DocumentProperties::populate_script_lists(){ /** * Called for _updating_ the dialog (e.g. when a new grid was manually added in XML) */ -void -DocumentProperties::update_gridspage() +void DocumentProperties::update_gridspage() { SPDesktop *dt = getDesktop(); SPNamedView *nv = sp_desktop_namedview(dt); @@ -946,8 +945,7 @@ DocumentProperties::update_gridspage() /** * Build grid page of dialog. */ -void -DocumentProperties::build_gridspage() +void DocumentProperties::build_gridspage() { /// \todo FIXME: gray out snapping when grid is off. /// Dissenting view: you want snapping without grid. @@ -984,8 +982,7 @@ DocumentProperties::build_gridspage() /** * Update dialog widgets from desktop. Also call updateWidget routines of the grids. */ -void -DocumentProperties::update() +void DocumentProperties::update() { if (_wr.isUpdating()) return; @@ -1118,8 +1115,7 @@ on_child_removed(Inkscape::XML::Node */*repr*/, Inkscape::XML::Node */*child*/, /** * Called when XML node attribute changed; updates dialog widgets. */ -static void -on_repr_attr_changed (Inkscape::XML::Node *, gchar const *, gchar const *, gchar const *, bool, gpointer data) +static void on_repr_attr_changed(Inkscape::XML::Node *, gchar const *, gchar const *, gchar const *, bool, gpointer data) { if (DocumentProperties *dialog = static_cast<DocumentProperties *>(data)) dialog->update(); diff --git a/src/ui/dialog/extension-editor.cpp b/src/ui/dialog/extension-editor.cpp index 527dfe23c..282f43a25 100644 --- a/src/ui/dialog/extension-editor.cpp +++ b/src/ui/dialog/extension-editor.cpp @@ -1,5 +1,6 @@ -/** @file - * @brief Extension editor dialog +/** + * @file + * Extension editor dialog. */ /* Authors: * Bryce W. Harrington <bryce@bryceharrington.org> @@ -33,15 +34,15 @@ namespace Inkscape { namespace UI { namespace Dialog { -/** \brief Create a new ExtensionEditor dialog - \return None - - This function creates a new extension editor dialog. The dialog - consists of two basic areas. The left side is a tree widget, which - is only used as a list. And the right side is a notebook of information - about the selected extension. A handler is set up so that when - a new extension is selected, the notebooks are changed appropriately. -*/ +/** + * Create a new ExtensionEditor dialog. + * + * This function creates a new extension editor dialog. The dialog + * consists of two basic areas. The left side is a tree widget, which + * is only used as a list. And the right side is a notebook of information + * about the selected extension. A handler is set up so that when + * a new extension is selected, the notebooks are changed appropriately. + */ ExtensionEditor::ExtensionEditor() : UI::Widget::Panel ("", "/dialogs/extensioneditor", SP_VERB_DIALOG_EXTENSIONEDITOR) { @@ -92,9 +93,9 @@ ExtensionEditor::ExtensionEditor() show_all_children(); } -/** \brief Destroys the extension editor dialog - \return None -*/ +/** + * Destroys the extension editor dialog. + */ ExtensionEditor::~ExtensionEditor() { } @@ -117,15 +118,14 @@ ExtensionEditor::setExtensionIter(const Gtk::TreeModel::iterator &iter) return false; } -/** \brief Called every time a new extention is selected - \return None - - This function is set up to handle the signal for a changed extension - from the tree view in the left pane. It figure out which extension - is selected and updates the widgets to have data for that extension. -*/ -void -ExtensionEditor::on_pagelist_selection_changed (void) +/** + * Called every time a new extention is selected + * + * This function is set up to handle the signal for a changed extension + * from the tree view in the left pane. It figure out which extension + * is selected and updates the widgets to have data for that extension. + */ +void ExtensionEditor::on_pagelist_selection_changed(void) { Glib::RefPtr<Gtk::TreeSelection> selection = _page_list.get_selection(); Gtk::TreeModel::iterator iter = selection->get_selected(); @@ -179,34 +179,35 @@ ExtensionEditor::on_pagelist_selection_changed (void) return; } -/** \brief A function to pass to the iterator in the Extensions Database - \param in_plug The extension to evaluate - \param in_data A pointer to the Extension Editor class - \return None - - This function is a static function with the prototype required for - the Extension Database's foreach function. It will get called for - every extension in the database, and will then turn around and - call the more object oriented function \c add_extension in the - ExtensionEditor. -*/ -void -ExtensionEditor::dbfunc (Inkscape::Extension::Extension * in_plug, gpointer in_data) +/** + * A function to pass to the iterator in the Extensions Database. + * + * This function is a static function with the prototype required for + * the Extension Database's foreach function. It will get called for + * every extension in the database, and will then turn around and + * call the more object oriented function \c add_extension in the + * ExtensionEditor. + * + * @param in_plug The extension to evaluate. + * @param in_data A pointer to the Extension Editor class. + */ +void ExtensionEditor::dbfunc(Inkscape::Extension::Extension * in_plug, gpointer in_data) { ExtensionEditor * ee = static_cast<ExtensionEditor *>(in_data); ee->add_extension(in_plug); return; } -/** \brief Adds an extension into the tree model - \param ext The extension to add - \return The iterator representing the location in the tree model - - This function takes the data out of the extension and puts it - into the tree model for the dialog. -*/ -Gtk::TreeModel::iterator -ExtensionEditor::add_extension (Inkscape::Extension::Extension * ext) +/** + * Adds an extension into the tree model. + * + * This function takes the data out of the extension and puts it + * into the tree model for the dialog. + * + * @param ext The extension to add. + * @return The iterator representing the location in the tree model. + */ +Gtk::TreeModel::iterator ExtensionEditor::add_extension(Inkscape::Extension::Extension * ext) { Gtk::TreeModel::iterator iter; diff --git a/src/ui/dialog/extensions.cpp b/src/ui/dialog/extensions.cpp index 27cd15e8c..242b79368 100644 --- a/src/ui/dialog/extensions.cpp +++ b/src/ui/dialog/extensions.cpp @@ -1,5 +1,6 @@ -/** @file - * @brief A simple dialog with information about extensions +/** + * @file + * A simple dialog with information about extensions. */ /* Authors: * Jon A. Cruz diff --git a/src/ui/dialog/filedialog.cpp b/src/ui/dialog/filedialog.cpp index 8db390cd2..c31f7cf15 100644 --- a/src/ui/dialog/filedialog.cpp +++ b/src/ui/dialog/filedialog.cpp @@ -1,5 +1,6 @@ -/** @file - * @brief Implementation of the file dialog interfaces defined in filedialog.h +/** + * @file + * Implementation of the file dialog interfaces defined in filedialog.h. */ /* Authors: * Bob Jamison diff --git a/src/ui/dialog/filedialogimpl-gtkmm.cpp b/src/ui/dialog/filedialogimpl-gtkmm.cpp index 99662f0c2..921d89c2e 100644 --- a/src/ui/dialog/filedialogimpl-gtkmm.cpp +++ b/src/ui/dialog/filedialogimpl-gtkmm.cpp @@ -1,5 +1,6 @@ -/** @file - * @brief Implementation of the file dialog interfaces defined in filedialogimpl.h +/** + * @file + * Implementation of the file dialog interfaces defined in filedialogimpl.h. */ /* Authors: * Bob Jamison diff --git a/src/ui/dialog/filedialogimpl-win32.cpp b/src/ui/dialog/filedialogimpl-win32.cpp index 777f37e8f..2d23ed943 100644 --- a/src/ui/dialog/filedialogimpl-win32.cpp +++ b/src/ui/dialog/filedialogimpl-win32.cpp @@ -1,5 +1,6 @@ -/** @file - * @brief Implementation of native file dialogs for Win32 +/** + * @file + * Implementation of native file dialogs for Win32. */ /* Authors: * Joel Holdsworth diff --git a/src/ui/dialog/fill-and-stroke.cpp b/src/ui/dialog/fill-and-stroke.cpp index 5d85b2397..91b88d3f0 100644 --- a/src/ui/dialog/fill-and-stroke.cpp +++ b/src/ui/dialog/fill-and-stroke.cpp @@ -1,5 +1,6 @@ -/** @file - * @brief Fill and Stroke dialog - implementation +/** + * @file + * Fill and Stroke dialog - implementation. * * Based on the old sp_object_properties_dialog. */ diff --git a/src/ui/dialog/filter-effects-dialog.cpp b/src/ui/dialog/filter-effects-dialog.cpp index 30803715e..22d3c7369 100644 --- a/src/ui/dialog/filter-effects-dialog.cpp +++ b/src/ui/dialog/filter-effects-dialog.cpp @@ -1,5 +1,6 @@ -/** @file - * @brief Filter Effects dialog +/** + * @file + * Filter Effects dialog. */ /* Authors: * Nicholas Bishop <nicholasbishop@gmail.org> diff --git a/src/ui/dialog/find.cpp b/src/ui/dialog/find.cpp index aa6b4081e..78bb8c66a 100644 --- a/src/ui/dialog/find.cpp +++ b/src/ui/dialog/find.cpp @@ -1,5 +1,5 @@ /** - * \brief Find dialog + * Find dialog. * * Authors: * Bryce W. Harrington <bryce@bryceharrington.org> diff --git a/src/ui/dialog/floating-behavior.cpp b/src/ui/dialog/floating-behavior.cpp index 6a086e0a1..5215ec167 100644 --- a/src/ui/dialog/floating-behavior.cpp +++ b/src/ui/dialog/floating-behavior.cpp @@ -1,5 +1,6 @@ -/** @file - * @brief Floating dialog implementation. +/** + * @file + * Floating dialog implementation. */ /* Author: * Gustav Broberg <broberg@kth.se> @@ -54,15 +55,16 @@ FloatingBehavior::FloatingBehavior(Dialog &dialog) : } #if GTK_VERSION_GE(2, 12) -/** \brief A function called when the window gets focus - - This function gets called on a focus event. It figures out how much - time is required for a transition, and the number of steps that'll take, - and sets up the _trans_timer function to do the work. If the transition - time is set to 0 ms it just calls _trans_timer once with _steps equal to - zero so that the transition happens instantaneously. This occurs on - windows as opacity changes cause flicker there. -*/ +/** + * A function called when the window gets focus. + * + * This function gets called on a focus event. It figures out how much + * time is required for a transition, and the number of steps that'll take, + * and sets up the _trans_timer function to do the work. If the transition + * time is set to 0 ms it just calls _trans_timer once with _steps equal to + * zero so that the transition happens instantaneously. This occurs on + * windows as opacity changes cause flicker there. + */ void FloatingBehavior::_focus_event (void) { Inkscape::Preferences *prefs = Inkscape::Preferences::get(); @@ -89,13 +91,14 @@ void FloatingBehavior::_focus_event (void) return; } -/** \brief Move the opacity of a window towards our goal - - This is a timer function that is set up by _focus_event to slightly - move the opacity of the window along in an animated fashion. It moves - the opacity half way to the goal until it runs out of steps, and then - it just forces the goal. -*/ +/** + * Move the opacity of a window towards our goal. + * + * This is a timer function that is set up by _focus_event to slightly + * move the opacity of the window along in an animated fashion. It moves + * the opacity half way to the goal until it runs out of steps, and then + * it just forces the goal. + */ bool FloatingBehavior::_trans_timer (void) { // printf("Go go gadget timer: %d\n", _steps); if (_steps == 0) { diff --git a/src/ui/dialog/guides.cpp b/src/ui/dialog/guides.cpp index 542fed5bb..e353178ed 100644 --- a/src/ui/dialog/guides.cpp +++ b/src/ui/dialog/guides.cpp @@ -1,5 +1,6 @@ -/** @file - * @brief Simple guideline dialog +/** + * @file + * Simple guideline dialog. */ /* Authors: * Lauris Kaplinski <lauris@kaplinski.com> diff --git a/src/ui/dialog/icon-preview.cpp b/src/ui/dialog/icon-preview.cpp index 9865c0cdb..0157cd267 100644 --- a/src/ui/dialog/icon-preview.cpp +++ b/src/ui/dialog/icon-preview.cpp @@ -1,5 +1,6 @@ -/** @file - * @brief A simple dialog for previewing icon representation. +/** + * @file + * A simple dialog for previewing icon representation. */ /* Authors: * Jon A. Cruz diff --git a/src/ui/dialog/inkscape-preferences.cpp b/src/ui/dialog/inkscape-preferences.cpp index ae27f0720..448126091 100644 --- a/src/ui/dialog/inkscape-preferences.cpp +++ b/src/ui/dialog/inkscape-preferences.cpp @@ -1,5 +1,6 @@ -/** @file - * @brief Inkscape Preferences dialog - implementation +/** + * @file + * Inkscape Preferences dialog - implementation. */ /* Authors: * Carl Hetherington diff --git a/src/ui/dialog/input.cpp b/src/ui/dialog/input.cpp index 6869aa97b..e80f581c1 100644 --- a/src/ui/dialog/input.cpp +++ b/src/ui/dialog/input.cpp @@ -1,5 +1,6 @@ -/** @file - * @brief Input devices dialog (new) - implementation +/** + * @file + * Input devices dialog (new) - implementation. */ /* Author: * Jon A. Cruz diff --git a/src/ui/dialog/layer-properties.cpp b/src/ui/dialog/layer-properties.cpp index bf15bcd76..eeef12b88 100644 --- a/src/ui/dialog/layer-properties.cpp +++ b/src/ui/dialog/layer-properties.cpp @@ -1,5 +1,6 @@ -/** @file - * @brief Dialog for renaming layers +/** + * @file + * Dialog for renaming layers. */ /* Author: * Bryce W. Harrington <bryce@bryceharrington.com> diff --git a/src/ui/dialog/livepatheffect-editor.cpp b/src/ui/dialog/livepatheffect-editor.cpp index 40b7f26ac..2227a8c5a 100644 --- a/src/ui/dialog/livepatheffect-editor.cpp +++ b/src/ui/dialog/livepatheffect-editor.cpp @@ -1,5 +1,6 @@ -/** @file - * @brief Live Path Effect editing dialog - implementation +/** + * @file + * Live Path Effect editing dialog - implementation. */ /* Authors: * Johan Engelen <j.b.c.engelen@utwente.nl> diff --git a/src/ui/dialog/memory.cpp b/src/ui/dialog/memory.cpp index 7f5c5cefa..8229929e5 100644 --- a/src/ui/dialog/memory.cpp +++ b/src/ui/dialog/memory.cpp @@ -1,5 +1,6 @@ -/** @file - * @brief Memory statistics dialog +/** + * @file + * Memory statistics dialog. */ /* Authors: * MenTaLguY <mental@rydia.net> diff --git a/src/ui/dialog/messages.cpp b/src/ui/dialog/messages.cpp index 654117704..022e6ac2c 100644 --- a/src/ui/dialog/messages.cpp +++ b/src/ui/dialog/messages.cpp @@ -1,5 +1,6 @@ -/** @file - * @brief Messages dialog - implementation +/** + * @file + * Messages dialog - implementation. */ /* Authors: * Bob Jamison diff --git a/src/ui/dialog/ocaldialogs.cpp b/src/ui/dialog/ocaldialogs.cpp index 2ae7d6989..3f9414866 100644 --- a/src/ui/dialog/ocaldialogs.cpp +++ b/src/ui/dialog/ocaldialogs.cpp @@ -1,5 +1,6 @@ -/** @file - * @brief Open Clip Art Library integration dialogs - implementation +/** + * @file + * Open Clip Art Library integration dialogs - implementation. */ /* Authors: * Bruno Dilly diff --git a/src/ui/dialog/print-colors-preview-dialog.cpp b/src/ui/dialog/print-colors-preview-dialog.cpp index 1f999f692..ef5c1b6f6 100644 --- a/src/ui/dialog/print-colors-preview-dialog.cpp +++ b/src/ui/dialog/print-colors-preview-dialog.cpp @@ -1,5 +1,6 @@ -/** @file - * @brief Print Colors Preview dialog - implementation +/** + * @file + * Print Colors Preview dialog - implementation. */ /* Authors: * Felipe C. da S. Sanches <juca@members.fsf.org> diff --git a/src/ui/dialog/print.cpp b/src/ui/dialog/print.cpp index a56cbfd9d..8da31b813 100644 --- a/src/ui/dialog/print.cpp +++ b/src/ui/dialog/print.cpp @@ -1,5 +1,6 @@ -/** @file - * @brief Print dialog +/** + * @file + * Print dialog. */ /* Authors: * Kees Cook <kees@outflux.net> diff --git a/src/ui/dialog/scriptdialog.cpp b/src/ui/dialog/scriptdialog.cpp index c7f828067..ef65dce97 100644 --- a/src/ui/dialog/scriptdialog.cpp +++ b/src/ui/dialog/scriptdialog.cpp @@ -1,5 +1,6 @@ -/** @file - * @brief Dialog for executing and monitoring script execution +/** + * @file + * Dialog for executing and monitoring script execution. */ /* Author: * Bob Jamison diff --git a/src/ui/dialog/svg-fonts-dialog.cpp b/src/ui/dialog/svg-fonts-dialog.cpp index fbca0bf10..2c116f137 100644 --- a/src/ui/dialog/svg-fonts-dialog.cpp +++ b/src/ui/dialog/svg-fonts-dialog.cpp @@ -1,5 +1,6 @@ -/** @file - * @brief SVG Fonts dialog - implementation +/** + * @file + * SVG Fonts dialog - implementation. */ /* Authors: * Felipe C. da S. Sanches <juca@members.fsf.org> diff --git a/src/ui/dialog/swatches.cpp b/src/ui/dialog/swatches.cpp index 910d63873..2edd24eec 100644 --- a/src/ui/dialog/swatches.cpp +++ b/src/ui/dialog/swatches.cpp @@ -1,6 +1,6 @@ - -/** @file - * @brief Color swatches dialog +/** + * @file + * Color swatches dialog. */ /* Authors: * Jon A. Cruz diff --git a/src/ui/dialog/tracedialog.cpp b/src/ui/dialog/tracedialog.cpp index 3f2cc451b..597c9a217 100644 --- a/src/ui/dialog/tracedialog.cpp +++ b/src/ui/dialog/tracedialog.cpp @@ -1,5 +1,6 @@ -/** @file - * @brief Bitmap tracing settings dialog - implementation +/** + * @file + * Bitmap tracing settings dialog - implementation. */ /* Authors: * Bob Jamison <rjamison@titan.com> diff --git a/src/ui/dialog/transformation.cpp b/src/ui/dialog/transformation.cpp index be60fac20..570120bcd 100644 --- a/src/ui/dialog/transformation.cpp +++ b/src/ui/dialog/transformation.cpp @@ -1,5 +1,6 @@ -/** @file - * \brief Transform dialog - implementation +/** + * @file + * Transform dialog - implementation. */ /* Authors: * Bryce W. Harrington <bryce@bryceharrington.org> diff --git a/src/ui/dialog/undo-history.cpp b/src/ui/dialog/undo-history.cpp index 4c3446a51..74de33b27 100644 --- a/src/ui/dialog/undo-history.cpp +++ b/src/ui/dialog/undo-history.cpp @@ -1,5 +1,6 @@ -/** @file - * @brief Undo History dialog - implementation +/** + * @file + * Undo History dialog - implementation. */ /* Author: * Gustav Broberg <broberg@kth.se> diff --git a/src/ui/tool/control-point-selection.cpp b/src/ui/tool/control-point-selection.cpp index fbcb337a5..1a1aee47c 100644 --- a/src/ui/tool/control-point-selection.cpp +++ b/src/ui/tool/control-point-selection.cpp @@ -1,5 +1,6 @@ -/** @file - * Node selection - implementation +/** + * @file + * Node selection - implementation. */ /* Authors: * Krzysztof Kosiński <tweenk.pl@gmail.com> @@ -23,7 +24,7 @@ namespace UI { /** * @class ControlPointSelection - * @brief Group of selected control points. + * Group of selected control points. * * Some operations can be performed on all selected points regardless of their type, therefore * this class is also a Manipulator. It handles the transformations of points using @@ -446,8 +447,10 @@ bool ControlPointSelection::_keyboardMove(GdkEventKey const &event, Geom::Point return true; } -/** @brief Computes the distance to the farthest corner of the bounding box. - * Used to determine what it means to "rotate by one pixel". */ +/** + * Computes the distance to the farthest corner of the bounding box. + * Used to determine what it means to "rotate by one pixel". + */ double ControlPointSelection::_rotationRadius(Geom::Point const &rc) { if (empty()) return 1.0; // some safe value @@ -460,7 +463,8 @@ double ControlPointSelection::_rotationRadius(Geom::Point const &rc) return maxlen; } -/** Rotates the selected points in the given direction according to the modifier state +/** + * Rotates the selected points in the given direction according to the modifier state * from the supplied event. * @param event Key event to take modifier state from * @param dir Direction of rotation (math convention: 1 = counterclockwise, -1 = clockwise) diff --git a/src/ui/tool/control-point.cpp b/src/ui/tool/control-point.cpp index bece1324b..81cb53f6f 100644 --- a/src/ui/tool/control-point.cpp +++ b/src/ui/tool/control-point.cpp @@ -1,5 +1,6 @@ -/** @file - * Desktop-bound visual control object - implementation +/** + * @file + * Desktop-bound visual control object - implementation. */ /* Authors: * Krzysztof Kosiński <tweenk.pl@gmail.com> @@ -29,7 +30,7 @@ namespace UI { /** * @class ControlPoint - * @brief Draggable point, the workhorse of on-canvas editing. + * Draggable point, the workhorse of on-canvas editing. * * Control points (formerly known as knots) are graphical representations of some significant * point in the drawing. The drawing can be changed by dragging the point and the things that are @@ -537,7 +538,7 @@ void ControlPoint::transferGrab(ControlPoint *prev_point, GdkEventMotion *event) } /** - * @brief Change the state of the knot + * Change the state of the knot. * Alters the appearance of the knot to match one of the states: normal, mouseover * or clicked. */ diff --git a/src/ui/tool/multi-path-manipulator.cpp b/src/ui/tool/multi-path-manipulator.cpp index 082ac194b..27418d302 100644 --- a/src/ui/tool/multi-path-manipulator.cpp +++ b/src/ui/tool/multi-path-manipulator.cpp @@ -1,5 +1,6 @@ -/** @file - * Multi path manipulator - implementation +/** + * @file + * Multi path manipulator - implementation. */ /* Authors: * Krzysztof Kosiński <tweenk.pl@gmail.com> @@ -149,9 +150,11 @@ void MultiPathManipulator::cleanup() } } -/** @brief Change the set of items to edit. +/** + * Change the set of items to edit. * - * This method attempts to preserve as much of the state as possible. */ + * This method attempts to preserve as much of the state as possible. + */ void MultiPathManipulator::setItems(std::set<ShapeRecord> const &s) { std::set<ShapeRecord> shapes(s); @@ -507,20 +510,24 @@ void MultiPathManipulator::showPathDirection(bool show) _show_path_direction = show; } -/** @brief Set live outline update status +/** + * Set live outline update status. * When set to true, outline will be updated continuously when dragging * or transforming nodes. Otherwise it will only update when changes are committed - * to XML. */ + * to XML. + */ void MultiPathManipulator::setLiveOutline(bool set) { invokeForAll(&PathManipulator::setLiveOutline, set); _live_outline = set; } -/** @brief Set live object update status +/** + * Set live object update status. * When set to true, objects will be updated continuously when dragging * or transforming nodes. Otherwise they will only update when changes are committed - * to XML. */ + * to XML. + */ void MultiPathManipulator::setLiveObjects(bool set) { invokeForAll(&PathManipulator::setLiveObjects, set); diff --git a/src/ui/tool/node-tool.cpp b/src/ui/tool/node-tool.cpp index 6385fce0a..33020982e 100644 --- a/src/ui/tool/node-tool.cpp +++ b/src/ui/tool/node-tool.cpp @@ -1,5 +1,6 @@ -/** @file - * @brief New node tool - implementation +/** + * @file + * New node tool - implementation. */ /* Authors: * Krzysztof Kosiński <tweenk@gmail.com> diff --git a/src/ui/tool/node.cpp b/src/ui/tool/node.cpp index e254fb9b2..d268a9f14 100644 --- a/src/ui/tool/node.cpp +++ b/src/ui/tool/node.cpp @@ -1,5 +1,6 @@ -/** @file - * Editable node - implementation +/** + * @file + * Editable node - implementation. */ /* Authors: * Krzysztof Kosiński <tweenk.pl@gmail.com> @@ -70,13 +71,11 @@ static Geom::Point direction(Geom::Point const &first, Geom::Point const &second } /** - * @class Handle - * @brief Control point of a cubic Bezier curve in a path. + * Control point of a cubic Bezier curve in a path. * * Handle keeps the node type invariant only for the opposite handle of the same node. * Keeping the invariant on node moves is left to the %Node class. */ - Geom::Point Handle::_saved_other_pos(0, 0); double Handle::_saved_length = 0.0; bool Handle::_drag_out = false; @@ -467,12 +466,10 @@ Glib::ustring Handle::_getDragTip(GdkEventMotion */*event*/) } /** - * @class Node - * @brief Curve endpoint in an editable path. + * Curve endpoint in an editable path. * * The method move() keeps node type invariants during translations. */ - Node::Node(NodeSharedData const &data, Geom::Point const &initial_pos) : SelectableControlPoint(data.desktop, initial_pos, Gtk::ANCHOR_CENTER, SP_CTRL_SHAPE_DIAMOND, 9.0, *data.selection, &node_colors, data.node_group) @@ -1121,8 +1118,10 @@ Inkscape::SnapCandidatePoint Node::snapCandidatePoint() return SnapCandidatePoint(position(), _snapSourceType(), _snapTargetType()); } -/** @brief Gets the handle that faces the given adjacent node. - * Will abort with error if the given node is not adjacent. */ +/** + * Gets the handle that faces the given adjacent node. + * Will abort with error if the given node is not adjacent. + */ Handle *Node::handleToward(Node *to) { if (_next() == to) { @@ -1134,8 +1133,10 @@ Handle *Node::handleToward(Node *to) g_error("Node::handleToward(): second node is not adjacent!"); } -/** @brief Gets the node in the direction of the given handle. - * Will abort with error if the handle doesn't belong to this node. */ +/** + * Gets the node in the direction of the given handle. + * Will abort with error if the handle doesn't belong to this node. + */ Node *Node::nodeToward(Handle *dir) { if (front() == dir) { @@ -1147,8 +1148,10 @@ Node *Node::nodeToward(Handle *dir) g_error("Node::nodeToward(): handle is not a child of this node!"); } -/** @brief Gets the handle that goes in the direction opposite to the given adjacent node. - * Will abort with error if the given node is not adjacent. */ +/** + * Gets the handle that goes in the direction opposite to the given adjacent node. + * Will abort with error if the given node is not adjacent. + */ Handle *Node::handleAwayFrom(Node *to) { if (_next() == to) { @@ -1160,8 +1163,10 @@ Handle *Node::handleAwayFrom(Node *to) g_error("Node::handleAwayFrom(): second node is not adjacent!"); } -/** @brief Gets the node in the direction opposite to the given handle. - * Will abort with error if the handle doesn't belong to this node. */ +/** + * Gets the node in the direction opposite to the given handle. + * Will abort with error if the handle doesn't belong to this node. + */ Node *Node::nodeAwayFrom(Handle *h) { if (front() == h) { @@ -1262,14 +1267,12 @@ SPCtrlShapeType Node::_node_type_to_shape(NodeType type) /** - * @class NodeList - * @brief An editable list of nodes representing a subpath. + * An editable list of nodes representing a subpath. * * It can optionally be cyclic to represent a closed path. * The list has iterators that act like plain node iterators, but can also be used * to obtain shared pointers to nodes. */ - NodeList::NodeList(SubpathList &splist) : _list(splist) , _closed(false) @@ -1430,7 +1433,7 @@ NodeList &NodeList::get(iterator const &i) { /** * @class SubpathList - * @brief Editable path composed of one or more subpaths + * Editable path composed of one or more subpaths. */ } // namespace UI diff --git a/src/ui/tool/path-manipulator.cpp b/src/ui/tool/path-manipulator.cpp index 1310219a1..4be8df397 100644 --- a/src/ui/tool/path-manipulator.cpp +++ b/src/ui/tool/path-manipulator.cpp @@ -1,5 +1,6 @@ -/** @file - * Path manipulator - implementation +/** + * @file + * Path manipulator - implementation. */ /* Authors: * Krzysztof Kosiński <tweenk.pl@gmail.com> @@ -534,13 +535,15 @@ void PathManipulator::deleteNodes(bool keep_shape) } } -/** @brief Delete nodes between the two iterators. +/** + * Delete nodes between the two iterators. * The given range can cross the beginning of the subpath in closed subpaths. * @param start Beginning of the range to delete * @param end End of the range * @param keep_shape Whether to fit the handles at surrounding nodes to approximate * the shape before deletion - * @return Number of deleted nodes */ + * @return Number of deleted nodes + */ unsigned PathManipulator::_deleteStretch(NodeList::iterator start, NodeList::iterator end, bool keep_shape) { unsigned const samples_per_segment = 10; diff --git a/src/ui/widget/button.cpp b/src/ui/widget/button.cpp index 19c69ba44..fe4aa90ce 100644 --- a/src/ui/widget/button.cpp +++ b/src/ui/widget/button.cpp @@ -1,5 +1,5 @@ /** - * \brief Button and CheckButton widgets + * Button and CheckButton widgets. * * Author: * buliabyak@gmail.com diff --git a/src/ui/widget/color-picker.cpp b/src/ui/widget/color-picker.cpp index 650ed10f6..bd7a666d2 100644 --- a/src/ui/widget/color-picker.cpp +++ b/src/ui/widget/color-picker.cpp @@ -1,5 +1,6 @@ -/** \file - * \brief Color picker button & window +/** + * @file + * Color picker button & window. * * Authors: * Lauris Kaplinski <lauris@kaplinski.com> diff --git a/src/ui/widget/dock-item.cpp b/src/ui/widget/dock-item.cpp index 87f4d0840..9c6758bc0 100644 --- a/src/ui/widget/dock-item.cpp +++ b/src/ui/widget/dock-item.cpp @@ -1,5 +1,5 @@ /** - * \brief A custom Inkscape wrapper around gdl_dock_item + * A custom Inkscape wrapper around gdl_dock_item. * * Author: * Gustav Broberg <broberg@kth.se> diff --git a/src/ui/widget/dock.cpp b/src/ui/widget/dock.cpp index 02e1f2b41..627b01e27 100644 --- a/src/ui/widget/dock.cpp +++ b/src/ui/widget/dock.cpp @@ -1,5 +1,6 @@ -/** @file - * @brief A desktop dock pane to dock dialogs. +/** + * @file + * A desktop dock pane to dock dialogs. */ /* Author: * Gustav Broberg <broberg@kth.se> diff --git a/src/ui/widget/entry.cpp b/src/ui/widget/entry.cpp index 7b19ac861..ce7552fd6 100644 --- a/src/ui/widget/entry.cpp +++ b/src/ui/widget/entry.cpp @@ -1,6 +1,7 @@ -/** \file +/** + * @file * - * \brief Helperclass for Gtk::Entry widgets + * Helperclass for Gtk::Entry widgets. * * Authors: * Johan Engelen <goejendaagh@zonnet.nl> diff --git a/src/ui/widget/handlebox.cpp b/src/ui/widget/handlebox.cpp index b82b715bb..f5b716975 100644 --- a/src/ui/widget/handlebox.cpp +++ b/src/ui/widget/handlebox.cpp @@ -1,5 +1,5 @@ /** - * \brief HandleBox Widget - Adds a detachment handle to another widget. + * 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 diff --git a/src/ui/widget/icon-widget.cpp b/src/ui/widget/icon-widget.cpp index 64415f421..c3780b616 100644 --- a/src/ui/widget/icon-widget.cpp +++ b/src/ui/widget/icon-widget.cpp @@ -1,5 +1,5 @@ /** - * \brief Icon Widget + * Icon Widget. * * Author: * Bryce Harrington <bryce@bryceharrington.org> diff --git a/src/ui/widget/labelled.cpp b/src/ui/widget/labelled.cpp index c55b57616..a62d1a470 100644 --- a/src/ui/widget/labelled.cpp +++ b/src/ui/widget/labelled.cpp @@ -1,5 +1,5 @@ /** - * \brief Labelled Widget - Adds a label with optional icon or suffix to + * Labelled Widget - Adds a label with optional icon or suffix to * another widget. * * Authors: diff --git a/src/ui/widget/notebook-page.cpp b/src/ui/widget/notebook-page.cpp index 47035ce2f..eea8aefba 100644 --- a/src/ui/widget/notebook-page.cpp +++ b/src/ui/widget/notebook-page.cpp @@ -1,5 +1,5 @@ /** - * \brief Notebook page widget + * Notebook page widget. * * Author: * Bryce Harrington <bryce@bryceharrington.org> diff --git a/src/ui/widget/panel.cpp b/src/ui/widget/panel.cpp index 3e0c27587..aaa8e2a70 100644 --- a/src/ui/widget/panel.cpp +++ b/src/ui/widget/panel.cpp @@ -1,5 +1,5 @@ /** - * \brief Panel widget + * Panel widget. * * Authors: * Bryce Harrington <bryce@bryceharrington.org> diff --git a/src/ui/widget/point.cpp b/src/ui/widget/point.cpp index ca7f7a501..7a4b4459a 100644 --- a/src/ui/widget/point.cpp +++ b/src/ui/widget/point.cpp @@ -1,5 +1,5 @@ /** - * \brief Point Widget - A labelled text box, with spin buttons and optional + * Point Widget - A labelled text box, with spin buttons and optional * icon or suffix, for entering arbitrary coordinate values. * * Authors: diff --git a/src/ui/widget/preferences-widget.cpp b/src/ui/widget/preferences-widget.cpp index 68faa3c66..b88123ab1 100644 --- a/src/ui/widget/preferences-widget.cpp +++ b/src/ui/widget/preferences-widget.cpp @@ -1,5 +1,5 @@ /** - * \brief Inkscape Preferences dialog + * Inkscape Preferences dialog. * * Authors: * Marco Scholten diff --git a/src/ui/widget/random.cpp b/src/ui/widget/random.cpp index 3dcf09cb5..e2fb30812 100644 --- a/src/ui/widget/random.cpp +++ b/src/ui/widget/random.cpp @@ -1,5 +1,5 @@ /** - * \brief Scalar Widget - A labelled text box, with spin buttons and optional + * Scalar Widget - A labelled text box, with spin buttons and optional * icon or suffix, for entering arbitrary number values. It adds an extra * number called "startseed", that is not UI edittable, but should be put in SVG. * This does NOT generate a random number, but provides merely the saving of diff --git a/src/ui/widget/rendering-options.cpp b/src/ui/widget/rendering-options.cpp index 48e257af7..1ceaa784e 100644 --- a/src/ui/widget/rendering-options.cpp +++ b/src/ui/widget/rendering-options.cpp @@ -1,5 +1,5 @@ /** - * \brief Rendering options widget + * Rendering options widget. * * Author: * Kees Cook <kees@outflux.net> diff --git a/src/ui/widget/rotateable.cpp b/src/ui/widget/rotateable.cpp index 23d5363ef..6a65d6ab3 100644 --- a/src/ui/widget/rotateable.cpp +++ b/src/ui/widget/rotateable.cpp @@ -1,5 +1,5 @@ /** - * \brief widget adjustable by dragging it to rotate away from a zero-change axis + * widget adjustable by dragging it to rotate away from a zero-change axis. * * Authors: * buliabyak@gmail.com diff --git a/src/ui/widget/scalar-unit.cpp b/src/ui/widget/scalar-unit.cpp index 1c0fdff68..47e9b23b2 100644 --- a/src/ui/widget/scalar-unit.cpp +++ b/src/ui/widget/scalar-unit.cpp @@ -1,5 +1,5 @@ /** - * \brief Scalar Unit Widget - A labelled text box, with spin buttons and + * Scalar Unit Widget - A labelled text box, with spin buttons and * optional icon or suffix, for entering the values of various unit * types. * diff --git a/src/ui/widget/scalar.cpp b/src/ui/widget/scalar.cpp index 6ada379fb..4237d9db9 100644 --- a/src/ui/widget/scalar.cpp +++ b/src/ui/widget/scalar.cpp @@ -1,5 +1,5 @@ /** - * \brief Scalar Widget - A labelled text box, with spin buttons and optional + * Scalar Widget - A labelled text box, with spin buttons and optional * icon or suffix, for entering arbitrary number values. * * Authors: diff --git a/src/ui/widget/selected-style.cpp b/src/ui/widget/selected-style.cpp index 0aa65b1a9..516da5761 100644 --- a/src/ui/widget/selected-style.cpp +++ b/src/ui/widget/selected-style.cpp @@ -1,5 +1,5 @@ /** - * \brief Selected style indicator (fill, stroke, opacity) + * Selected style indicator (fill, stroke, opacity). * * Author: * buliabyak@gmail.com diff --git a/src/ui/widget/spin-slider.cpp b/src/ui/widget/spin-slider.cpp index 259b057aa..4a3b0dd77 100644 --- a/src/ui/widget/spin-slider.cpp +++ b/src/ui/widget/spin-slider.cpp @@ -1,5 +1,5 @@ /** - * \brief Groups an HScale and a SpinButton together using the same Adjustment + * Groups an HScale and a SpinButton together using the same Adjustment. * * Author: * Nicholas Bishop <nicholasbishop@gmail.com> diff --git a/src/ui/widget/spinbutton.cpp b/src/ui/widget/spinbutton.cpp index 32090f96c..78b00bebc 100644 --- a/src/ui/widget/spinbutton.cpp +++ b/src/ui/widget/spinbutton.cpp @@ -1,5 +1,5 @@ /** - * \brief SpinButton widget, that allows entry of both '.' and ',' for the decimal, even when in numeric mode. + * SpinButton widget, that allows entry of both '.' and ',' for the decimal, even when in numeric mode. */ /* * Author: diff --git a/src/ui/widget/style-subject.cpp b/src/ui/widget/style-subject.cpp index f3a8478ea..4a1b83175 100644 --- a/src/ui/widget/style-subject.cpp +++ b/src/ui/widget/style-subject.cpp @@ -1,5 +1,5 @@ /** - * \brief Abstraction for different style widget operands + * Abstraction for different style widget operands. * * Copyright (C) 2007 MenTaLguY <mental@rydia.net> * Abhishek Sharma diff --git a/src/ui/widget/style-swatch.cpp b/src/ui/widget/style-swatch.cpp index 47f6292e3..41366f749 100644 --- a/src/ui/widget/style-swatch.cpp +++ b/src/ui/widget/style-swatch.cpp @@ -1,5 +1,6 @@ -/** @file - * @brief Static style swatch (fill, stroke, opacity) +/** + * @file + * Static style swatch (fill, stroke, opacity). */ /* Authors: * buliabyak@gmail.com @@ -43,7 +44,7 @@ namespace UI { namespace Widget { /** - * @brief Watches whether the tool uses the current style + * Watches whether the tool uses the current style. */ class StyleSwatch::ToolObserver : public Inkscape::Preferences::Observer { public: @@ -57,7 +58,7 @@ private: }; /** - * @brief Watches for changes in the observed style pref + * Watches for changes in the observed style pref. */ class StyleSwatch::StyleObserver : public Inkscape::Preferences::Observer { public: diff --git a/src/ui/widget/text.cpp b/src/ui/widget/text.cpp index 581491f0e..a5540e428 100644 --- a/src/ui/widget/text.cpp +++ b/src/ui/widget/text.cpp @@ -1,5 +1,5 @@ /** - * \brief Text Widget - A labelled text box, with spin buttons and optional + * Text Widget - A labelled text box, with spin buttons and optional * icon or suffix, for entering arbitrary number values. * * Authors: diff --git a/src/ui/widget/toolbox.cpp b/src/ui/widget/toolbox.cpp index 5e5f43263..41a13f4e9 100644 --- a/src/ui/widget/toolbox.cpp +++ b/src/ui/widget/toolbox.cpp @@ -1,5 +1,5 @@ /** - * \brief Toolbox Widget - A detachable toolbar for buttons and other widgets. + * Toolbox Widget - A detachable toolbar for buttons and other widgets. * * Author: * Derek P. Moore <derekm@hackunix.org> diff --git a/src/ui/widget/unit-menu.cpp b/src/ui/widget/unit-menu.cpp index 362f5d90f..bb0b65576 100644 --- a/src/ui/widget/unit-menu.cpp +++ b/src/ui/widget/unit-menu.cpp @@ -1,5 +1,5 @@ /** - * \brief Unit Menu Widget - A drop down menu for choosing unit types. + * Unit Menu Widget - A drop down menu for choosing unit types. * * Author: * Bryce Harrington <bryce@bryceharrington.org> |