diff options
| author | Jon A. Cruz <jon@joncruz.org> | 2011-10-25 07:45:35 +0000 |
|---|---|---|
| committer | Jon A. Cruz <jon@joncruz.org> | 2011-10-25 07:45:35 +0000 |
| commit | 1a5d5d8a7e796035bc70d5c727d4d901dda50726 (patch) | |
| tree | e15866e9b83d8948e6f7329193bbe4b6eefaa840 /src | |
| parent | cppcheck (diff) | |
| download | inkscape-1a5d5d8a7e796035bc70d5c727d4d901dda50726.tar.gz inkscape-1a5d5d8a7e796035bc70d5c727d4d901dda50726.zip | |
Cleanup pass on documentation that was dumping garbage into doxygen output.
(bzr r10696)
Diffstat (limited to 'src')
166 files changed, 1055 insertions, 944 deletions
diff --git a/src/2geom/basic-intersection.h b/src/2geom/basic-intersection.h index 5a813ae99..8e29b4617 100644 --- a/src/2geom/basic-intersection.h +++ b/src/2geom/basic-intersection.h @@ -1,7 +1,8 @@ /** - * \file - * \brief Basic intersection routines - * + * @file + * Basic intersection routines. + */ +/* * Authors: * ? <?@?.?> * diff --git a/src/2geom/conic_section_clipper.h b/src/2geom/conic_section_clipper.h index a02cda4d3..3e4ac8429 100644 --- a/src/2geom/conic_section_clipper.h +++ b/src/2geom/conic_section_clipper.h @@ -1,7 +1,8 @@ /** - * \file - * \brief Conic section clipping with respect to a rectangle - * + * @file + * Conic section clipping with respect to a rectangle. + */ +/* * Authors: * Marco Cecchetti <mrcekets at gmail> * diff --git a/src/2geom/conic_section_clipper_cr.h b/src/2geom/conic_section_clipper_cr.h index 31f5a4269..687fa182d 100644 --- a/src/2geom/conic_section_clipper_cr.h +++ b/src/2geom/conic_section_clipper_cr.h @@ -1,7 +1,8 @@ /** - * \file - * \brief Conic section clipping with respect to a rectangle - * + * @file + * Conic section clipping with respect to a rectangle. + */ +/* * Authors: * Marco Cecchetti <mrcekets at gmail> * diff --git a/src/2geom/conic_section_clipper_impl.h b/src/2geom/conic_section_clipper_impl.h index 7db4fca9f..ba213b8d5 100644 --- a/src/2geom/conic_section_clipper_impl.h +++ b/src/2geom/conic_section_clipper_impl.h @@ -1,7 +1,8 @@ /** - * \file - * \brief Conic section clipping with respect to a rectangle - * + * @file + * Conic section clipping with respect to a rectangle. + */ +/* * Authors: * Marco Cecchetti <mrcekets at gmail> * diff --git a/src/2geom/conicsec.h b/src/2geom/conicsec.h index be9a68bfa..d9c5e7bc5 100644 --- a/src/2geom/conicsec.h +++ b/src/2geom/conicsec.h @@ -1,7 +1,8 @@ /** - * \file - * \brief Conic Section - * + * @file + * Conic Section. + */ +/* * Authors: * Nathan Hurst <njh@njhurst.com> * diff --git a/src/2geom/convex-cover.h b/src/2geom/convex-cover.h index e4b5de200..4c1b59d17 100644 --- a/src/2geom/convex-cover.h +++ b/src/2geom/convex-cover.h @@ -1,7 +1,8 @@ /** - * \file - * \brief Dynamic convex hull structure - * + * @file + * Dynamic convex hull structure. + */ +/* * Copyright 2006 Nathan Hurst <njh@mail.csse.monash.edu.au> * Copyright 2006 Michael G. Sloan <mgsloan@gmail.com> * diff --git a/src/2geom/ellipse.h b/src/2geom/ellipse.h index 297254366..2d6ba399f 100644 --- a/src/2geom/ellipse.h +++ b/src/2geom/ellipse.h @@ -1,7 +1,8 @@ /** - * \file - * \brief Ellipse Curve - * + * @file + * Ellipse Curve. + */ +/* * Authors: * Marco Cecchetti <mrcekets at gmail.com> * diff --git a/src/2geom/geom.h b/src/2geom/geom.h index 5aeded23d..b9d910e2a 100644 --- a/src/2geom/geom.h +++ b/src/2geom/geom.h @@ -1,7 +1,8 @@ /** - * \file - * \brief Various geometrical calculations - * + * @file + * Various geometrical calculations. + */ +/* * Authors: * Nathan Hurst <njh@mail.csse.monash.edu.au> * diff --git a/src/2geom/linear.h b/src/2geom/linear.h index df6dd9904..6302d810e 100644 --- a/src/2geom/linear.h +++ b/src/2geom/linear.h @@ -1,7 +1,8 @@ /** - * \file - * \brief Linear fragment function class - * + * @file + * Linear fragment function class. + */ +/* * Authors: * Nathan Hurst <njh@mail.csse.monash.edu.au> * Michael Sloan <mgsloan@gmail.com> diff --git a/src/2geom/nearest-point.h b/src/2geom/nearest-point.h index 19485242c..484c47afc 100644 --- a/src/2geom/nearest-point.h +++ b/src/2geom/nearest-point.h @@ -1,7 +1,8 @@ /** - * \file - * \brief nearest point routines for D2<SBasis> and Piecewise<D2<SBasis>> - * + * @file + * nearest point routines for D2<SBasis> and Piecewise<D2<SBasis>>. + */ +/* * Authors: * * Marco Cecchetti <mrcekets at gmail.com> diff --git a/src/2geom/piecewise.h b/src/2geom/piecewise.h index 837f33ea7..310de23b1 100644 --- a/src/2geom/piecewise.h +++ b/src/2geom/piecewise.h @@ -1,7 +1,4 @@ -/** - * \file - * \brief Piecewise function class - * +/* * Copyright 2007 Michael Sloan <mgsloan@gmail.com> * * This library is free software; you can redistribute it and/or diff --git a/src/2geom/sbasis-geometric.h b/src/2geom/sbasis-geometric.h index f7216c15a..841d75a28 100644 --- a/src/2geom/sbasis-geometric.h +++ b/src/2geom/sbasis-geometric.h @@ -1,13 +1,14 @@ -#ifndef _SBASIS_GEOMETRIC -#define _SBASIS_GEOMETRIC +#ifndef SEEN_SBASIS_GEOMETRIC_ +#define SEEN_SBASIS_GEOMETRIC_ #include <2geom/d2.h> #include <2geom/piecewise.h> #include <vector> /** - * \file - * \brief two-dimensional geometric operators. - * + * @file + * two-dimensional geometric operators. + */ +/* * Copyright 2007, JFBarraud * Copyright 2007, njh * @@ -104,7 +105,7 @@ std::vector<double> find_tangents(Point P, D2<SBasis> const &A); }; -#endif +#endif // SEEN_SBASIS_GEOMETRIC_ /* Local Variables: diff --git a/src/2geom/sbasis-math.h b/src/2geom/sbasis-math.h index e6d40a3de..c3f7518eb 100644 --- a/src/2geom/sbasis-math.h +++ b/src/2geom/sbasis-math.h @@ -1,7 +1,8 @@ /** - * \file - * \brief some std functions to work with (pw)s-basis - * + * @file + * some std functions to work with (pw)s-basis. + */ +/* * Authors: * Jean-Francois Barraud * diff --git a/src/2geom/sbasis-poly.h b/src/2geom/sbasis-poly.h index e0bef9333..70abfeea1 100644 --- a/src/2geom/sbasis-poly.h +++ b/src/2geom/sbasis-poly.h @@ -5,9 +5,10 @@ #include <2geom/sbasis.h> /** - * \file - * \brief Conversion between SBasis and Poly. Not recommended for general use due to instability. - * + * @file + * Conversion between SBasis and Poly. Not recommended for general use due to instability. + */ +/* * Authors: * ? <?@?.?> * diff --git a/src/2geom/sbasis.h b/src/2geom/sbasis.h index 7a7e33fe4..f3598ccc8 100644 --- a/src/2geom/sbasis.h +++ b/src/2geom/sbasis.h @@ -1,7 +1,8 @@ /** - * \file - * \brief Defines S-power basis function class - * + * @file + * Defines S-power basis function class. + */ +/* * Authors: * Nathan Hurst <njh@mail.csse.monash.edu.au> * Michael Sloan <mgsloan@gmail.com> diff --git a/src/2geom/shape.h b/src/2geom/shape.h index 0a7ee9709..9f7ead4aa 100644 --- a/src/2geom/shape.h +++ b/src/2geom/shape.h @@ -1,6 +1,4 @@ -/** - * \brief Shapes are special paths on which boolops can be performed - * +/* * Authors: * Michael G. Sloan <mgsloan@gmail.com> * Nathan Hurst <njh@mail.csse.monash.edu.au> @@ -63,6 +61,9 @@ enum { BOOLOP_UNION = BOOLOP_JUST_A | BOOLOP_JUST_B | BOOLOP_BOTH }; +/** + * Shapes are special paths on which boolops can be performed. + */ class Shape { Regions content; mutable bool fill; diff --git a/src/2geom/svg-path-parser.h b/src/2geom/svg-path-parser.h index 93fd23b77..1aab8bb36 100644 --- a/src/2geom/svg-path-parser.h +++ b/src/2geom/svg-path-parser.h @@ -1,7 +1,8 @@ /** - * \file - * \brief parse SVG path specifications - * + * @file + * parse SVG path specifications. + */ +/* * Copyright 2007 MenTaLguY <mental@rydia.net> * Copyright 2007 Aaron Spike <aaron@ekips.org> * diff --git a/src/2geom/svg-path.h b/src/2geom/svg-path.h index 89192fb72..89dcb4759 100644 --- a/src/2geom/svg-path.h +++ b/src/2geom/svg-path.h @@ -1,7 +1,8 @@ /** - * \file - * \brief callback interface for SVG path data - * + * @file + * callback interface for SVG path data. + */ +/* * Copyright 2007 MenTaLguY <mental@rydia.net> * * This library is free software; you can redistribute it and/or diff --git a/src/2geom/toposweep.h b/src/2geom/toposweep.h index 428115dd3..b8c1bdcf4 100644 --- a/src/2geom/toposweep.h +++ b/src/2geom/toposweep.h @@ -2,7 +2,8 @@ /** * \file * \brief TopoSweep - topology / graph representation of a PathVector, for boolean operations and related tasks - * + */ +/* * Authors: * Michael Sloan <mgsloan at gmail.com> * Nathan Hurst <njhurst at njhurst.com> diff --git a/src/bind/javabind-private.h b/src/bind/javabind-private.h index a03f0c1a2..56ff2e2ff 100644 --- a/src/bind/javabind-private.h +++ b/src/bind/javabind-private.h @@ -2,7 +2,8 @@ * @file * @brief This is a simple mechanism to bind Inkscape to Java, and thence * to all of the nice things that can be layered upon that. - * + */ +/* * Authors: * Bob Jamison * @@ -23,8 +24,8 @@ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */ -#ifndef __JAVABIND_PRIVATE_H__ -#define __JAVABIND_PRIVATE_H__ +#ifndef SEEN_JAVABIND_PRIVATE_H +#define SEEN_JAVABIND_PRIVATE_H #include <jni.h> #include "javabind.h" @@ -139,7 +140,7 @@ void setString(JNIEnv *env, jobject obj, const char *name, const String &val); } // namespace Bind } // namespace Inkscape -#endif /* __JAVABIND_PRIVATE_H__ */ +#endif // SEEN_JAVABIND_PRIVATE_H //######################################################################## //# E N D O F F I L E //######################################################################## diff --git a/src/bind/javabind.h b/src/bind/javabind.h index 894f52d5d..254548bfb 100644 --- a/src/bind/javabind.h +++ b/src/bind/javabind.h @@ -2,7 +2,8 @@ * @file * @brief This is a simple mechanism to bind Inkscape to Java, and thence * to all of the nice things that can be layered upon that. - * + */ +/* * Authors: * Bob Jamison * @@ -23,8 +24,8 @@ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */ -#ifndef __JAVABIND_H__ -#define __JAVABIND_H__ +#ifndef SEEN_JAVABIND_H +#define SEEN_JAVABIND_H #include <glibmm.h> #include <vector> @@ -397,7 +398,7 @@ protected: } // namespace Bind } // namespace Inkscape -#endif /* __JAVABIND_H__ */ +#endif // SEEN_JAVABIND_H //######################################################################## //# E N D O F F I L E //######################################################################## diff --git a/src/bind/javainc/jni.h b/src/bind/javainc/jni.h index a10aaea72..5989c043f 100644 --- a/src/bind/javainc/jni.h +++ b/src/bind/javainc/jni.h @@ -28,7 +28,7 @@ * point of our design and implementation. */ -/****************************************************************************** +/* *************************************************************************** * Java Runtime Interface * Copyright (c) 1996 Netscape Communications Corporation. All rights reserved. *****************************************************************************/ diff --git a/src/color-rgba.h b/src/color-rgba.h index 543ef5926..0d7a0c00d 100644 --- a/src/color-rgba.h +++ b/src/color-rgba.h @@ -1,7 +1,4 @@ -/** \file color-rgba.h - - A class to handle a RGBA color as one unit. - +/* Authors: bulia byak <buliabyak@gmail.com> @@ -17,20 +14,20 @@ #include "decimal-round.h" /** - \brief A class to contain a floating point RGBA color. -*/ + * A class to contain a floating point RGBA color as one unit. + */ class ColorRGBA { public: + /** - \brief A constructor to create the color from four floating - point values. - \param c0 Red - \param c1 Green - \param c2 Blue - \param c3 Alpha - - Load the values into the array of floats in this object. - */ + * A constructor to create the color from four floating point values. + * Load the values into the array of floats in this object. + * + * @param c0 Red + * @param c1 Green + * @param c2 Blue + * @param c3 Alpha + */ ColorRGBA(float c0, float c1, float c2, float c3) { _c[0] = c0; _c[1] = c1; @@ -38,8 +35,8 @@ public: } /** - \brief Create a quick ColorRGBA with all zeros - */ + * Create a quick ColorRGBA with all zeros. + */ ColorRGBA(void) { for (int i = 0; i < 4; i++) @@ -47,14 +44,14 @@ public: } /** - \brief A constructor to create the color from an unsigned - int, as found everywhere when dealing with colors - \param intcolor rgba32 "unsigned int representation (0xRRGGBBAA) - - Separate the values and load them into the array of floats in this object. - TODO : maybe get rid of the NR_RGBA32_x C-style functions and replace - the calls with the bitshifting they do - */ + * A constructor to create the color from an unsigned int, as found everywhere when dealing with colors. + * + * Separate the values and load them into the array of floats in this object. + * TODO : maybe get rid of the NR_RGBA32_x C-style functions and replace + * the calls with the bitshifting they do + * + * @param intcolor rgba32 "unsigned int representation (0xRRGGBBAA) + */ ColorRGBA(guint32 intcolor) { _c[0] = ((intcolor & 0xff000000) >> 24) / 255.0; @@ -65,11 +62,12 @@ public: } /** - \brief Create a ColorRGBA using an array of floats - \param in_array The values to be placed into the object - - Go through each entry in the array and put it into \c _c. - */ + * Create a ColorRGBA using an array of floats. + * + * Go through each entry in the array and put it into \c _c. + * + * @param in_array The values to be placed into the object + */ ColorRGBA(float in_array[4]) { for (int i = 0; i < 4; i++) @@ -77,12 +75,12 @@ public: } /** - \brief Overwrite the values in this object with another \c ColorRGBA. - \param m Values to use for the array - \return This ColorRGBA object - - Copy all the values from \c m into \c this. - */ + * Overwrite the values in this object with another \c ColorRGBA. + * Copy all the values from \c m into \c this. + * + * @param m Values to use for the array. + * @return This ColorRGBA object. + */ ColorRGBA &operator=(ColorRGBA const &m) { for (unsigned i = 0 ; i < 4 ; ++i) { _c[i] = m._c[i]; @@ -91,26 +89,26 @@ public: } /** - \brief Grab a particular value from the ColorRGBA object - \param i Which value to grab - \return The requested value. - - First checks to make sure that the value is within the array, - and then return the value if it is. - */ + * Grab a particular value from the ColorRGBA object. + * First checks to make sure that the value is within the array, + * and then return the value if it is. + * + * @param i Which value to grab. + * @return The requested value. + */ float operator[](unsigned int const i) const { g_assert( unsigned(i) < 4 ); return _c[i]; } /** - \brief Check to ensure that two \c ColorRGBA's are equal - \param other The guy to check against - \return Whether or not they are equal - - Check each value to see if they are equal. If they all are, - return TRUE. - */ + * Check to ensure that two \c ColorRGBA's are equal. + * Check each value to see if they are equal. If they all are, + * return true. + * + * @param other The guy to check against. + * @return Whether or not they are equal. + */ bool operator== (const ColorRGBA &other) const { for (int i = 0; i < 4; i++) { if (_c[i] != other[i]) @@ -124,17 +122,17 @@ public: } /** - \brief Average two \c ColorRGBAs to create another one. - \param second The second RGBA, with this being the first - \param weight How much of each should be used. Zero is all - this while one is all the second. Default is - half and half. - - This function goes through all the points in the two objects and - merges them together based on the weighting. The current objects - value are multiplied by 1.0 - weight and the second object by weight. - This means that they should always be balanced by the parameter. - */ + * Average two \c ColorRGBAs to create another one. + * This function goes through all the points in the two objects and + * merges them together based on the weighting. The current objects + * value are multiplied by 1.0 - weight and the second object by weight. + * This means that they should always be balanced by the parameter. + * + * @param second The second RGBA, with this being the first + * @param weight How much of each should be used. Zero is all + * this while one is all the second. Default is + * half and half. + */ ColorRGBA average (const ColorRGBA &second, const float weight = 0.5) const { float returnval[4]; @@ -146,12 +144,11 @@ public: } /** - \brief Give the rgba32 "unsigned int" representation of the color - - round each components*255 and combine them (RRGGBBAA). - WARNING : this reduces color precision (from float to 0->255 int per component) - but it should be expected since we request this kind of output - */ + * Give the rgba32 "unsigned int" representation of the color. + * round each components*255 and combine them (RRGGBBAA). + * WARNING : this reduces color precision (from float to 0->255 int per component) + * but it should be expected since we request this kind of output + */ unsigned int getIntValue() const { return (int(Inkscape::decimal_round(_c[0]*255, 0)) << 24) | @@ -161,12 +158,12 @@ public: } private: - /** \brief Array of values that are stored. */ + /** Array of values that are stored. */ float _c[4]; }; -#endif /* !SEEN_COLOR_RGBA_H */ +#endif // SEEN_COLOR_RGBA_H /* Local Variables: diff --git a/src/color.h b/src/color.h index 418b12c89..746ecebbf 100644 --- a/src/color.h +++ b/src/color.h @@ -1,9 +1,7 @@ #ifndef SEEN_SP_COLOR_H #define SEEN_SP_COLOR_H -/** \file - * Colors. - * +/* * Author: * Lauris Kaplinski <lauris@kaplinski.com> * bulia byak <buliabyak@users.sf.net> diff --git a/src/desktop.h b/src/desktop.h index d15fb7d69..25e4387dc 100644 --- a/src/desktop.h +++ b/src/desktop.h @@ -1,9 +1,7 @@ #ifndef SEEN_SP_DESKTOP_H #define SEEN_SP_DESKTOP_H -/** \file - * SPDesktop: an editable view. - * +/* * Author: * Lauris Kaplinski <lauris@kaplinski.com> * Frank Felfe <innerspace@iname.com> diff --git a/src/display/canvas-temporary-item-list.h b/src/display/canvas-temporary-item-list.h index 7a9f8b87a..d204c692f 100644 --- a/src/display/canvas-temporary-item-list.h +++ b/src/display/canvas-temporary-item-list.h @@ -1,9 +1,7 @@ #ifndef INKSCAPE_CANVAS_TEMPORARY_ITEM_LIST_H #define INKSCAPE_CANVAS_TEMPORARY_ITEM_LIST_H -/** \file - * Provides a class that can contain active TemporaryItem's on a desktop - * +/* * Authors: * Johan Engelen * @@ -23,6 +21,9 @@ namespace Display { class TemporaryItem; +/** + * Provides a class that can contain active TemporaryItem's on a desktop. + */ class TemporaryItemList { public: TemporaryItemList(SPDesktop *desktop); diff --git a/src/display/canvas-temporary-item.h b/src/display/canvas-temporary-item.h index b73907bad..c8917b530 100644 --- a/src/display/canvas-temporary-item.h +++ b/src/display/canvas-temporary-item.h @@ -1,9 +1,7 @@ #ifndef INKSCAPE_CANVAS_TEMPORARY_ITEM_H #define INKSCAPE_CANVAS_TEMPORARY_ITEM_H -/** \file - * Provides a class to put a canvasitem temporarily on-canvas. - * +/* * Authors: * Johan Engelen * @@ -22,6 +20,9 @@ struct SPCanvasItem; namespace Inkscape { namespace Display { +/** + * Provides a class to put a canvasitem temporarily on-canvas. + */ class TemporaryItem { public: TemporaryItem(SPCanvasItem *item, guint lifetime, bool destroy_on_deselect = false); diff --git a/src/display/curve.h b/src/display/curve.h index ec828e674..4f129b542 100644 --- a/src/display/curve.h +++ b/src/display/curve.h @@ -1,9 +1,7 @@ #ifndef SEEN_DISPLAY_CURVE_H #define SEEN_DISPLAY_CURVE_H -/** \file - * Wrapper around a Geom::PathVector objects. - * +/* * Author: * Lauris Kaplinski <lauris@kaplinski.com> * @@ -22,6 +20,9 @@ #include <boost/optional.hpp> +/** + * Wrapper around a Geom::PathVector objects. + */ class SPCurve { public: /* Constructors */ diff --git a/src/display/grayscale.h b/src/display/grayscale.h index fe0d75cad..18162e1f3 100644 --- a/src/display/grayscale.h +++ b/src/display/grayscale.h @@ -1,9 +1,7 @@ #ifndef SEEN_DISPLAY_GRAYSCALE_H #define SEEN_DISPLAY_GRAYSCALE_H -/** \file - * Provide methods to calculate grayscale values (e.g. convert rgba value to grayscale rgba value) - * +/* * Author: * Johan Engelen <goejendaagh@zonnet.nl> * @@ -14,6 +12,9 @@ #include <gdk/gdk.h> +/** + * Provide methods to calculate grayscale values (e.g. convert rgba value to grayscale rgba value). + */ namespace Grayscale { guint32 process(guint32 rgba); guint32 process(guchar r, guchar g, guchar b, guchar a); @@ -22,7 +23,7 @@ namespace Grayscale { bool activeDesktopIsGrayscale(); }; -#endif /* !SEEN_DISPLAY_GRAYSCALE_H */ +#endif // !SEEN_DISPLAY_GRAYSCALE_H /* Local Variables: diff --git a/src/display/nr-filter-utils.h b/src/display/nr-filter-utils.h index 4d2b06bd5..7e073168f 100644 --- a/src/display/nr-filter-utils.h +++ b/src/display/nr-filter-utils.h @@ -1,9 +1,11 @@ #ifndef __NR_FILTER_UTILS_H__ #define __NR_FILTER_UTILS_H__ -/** \file - * filter utils. Definition of functions needed by several filters. - * +/** + * @file + * Definition of functions needed by several filters. + */ +/* * Authors: * Jean-Rene Reinhard <jr@komite.net> * diff --git a/src/display/snap-indicator.h b/src/display/snap-indicator.h index da66d0033..30040d99c 100644 --- a/src/display/snap-indicator.h +++ b/src/display/snap-indicator.h @@ -1,9 +1,11 @@ #ifndef INKSCAPE_DISPLAY_SNAP_INDICATOR_H #define INKSCAPE_DISPLAY_SNAP_INDICATOR_H -/** \file +/** + * @file * Provides a class that shows a temporary indicator on the canvas of where the snap was, and what kind of snap - * + */ +/* * Authors: * Johan Engelen * Diederik van Lierop diff --git a/src/display/sodipodi-ctrlrect.h b/src/display/sodipodi-ctrlrect.h index a83c7bc38..05688e6b5 100644 --- a/src/display/sodipodi-ctrlrect.h +++ b/src/display/sodipodi-ctrlrect.h @@ -2,9 +2,10 @@ #define SEEN_INKSCAPE_CTRLRECT_H /** - * \file sodipodi-ctrlrect.h + * @file * Simple non-transformed rectangle, usable for rubberband. - * + */ +/* * Authors: * Lauris Kaplinski <lauris@ximian.com> * Carl Hetherington <inkscape@carlh.net> diff --git a/src/display/sp-canvas-group.h b/src/display/sp-canvas-group.h index 354d389b7..9aa99d563 100644 --- a/src/display/sp-canvas-group.h +++ b/src/display/sp-canvas-group.h @@ -1,9 +1,11 @@ #ifndef SEEN_SP_CANVAS_GROUP_H #define SEEN_SP_CANVAS_GROUP_H -/** \file - * SPCanvasGroup - * +/** + * @file + * SPCanvasGroup. + */ +/* * Authors: * Federico Mena <federico@nuclecu.unam.mx> * Raph Levien <raph@gimp.org> diff --git a/src/display/sp-canvas-item.h b/src/display/sp-canvas-item.h index 415c36566..2c1dbdcf0 100644 --- a/src/display/sp-canvas-item.h +++ b/src/display/sp-canvas-item.h @@ -1,9 +1,11 @@ #ifndef SEEN_SP_CANVAS_ITEM_H #define SEEN_SP_CANVAS_ITEM_H -/** \file +/** + * @file * SPCanvasItem. - * + */ +/* * Authors: * Federico Mena <federico@nuclecu.unam.mx> * Raph Levien <raph@gimp.org> diff --git a/src/display/sp-canvas.h b/src/display/sp-canvas.h index bffa5e4e9..f0deaa594 100644 --- a/src/display/sp-canvas.h +++ b/src/display/sp-canvas.h @@ -1,9 +1,11 @@ #ifndef SEEN_SP_CANVAS_H #define SEEN_SP_CANVAS_H -/** \file +/** + * @file * SPCanvas, SPCanvasBuf. - * + */ +/* * Authors: * Federico Mena <federico@nuclecu.unam.mx> * Raph Levien <raph@gimp.org> diff --git a/src/dom/css.h b/src/dom/css.h index f62b93588..5ea71ce95 100644 --- a/src/dom/css.h +++ b/src/dom/css.h @@ -1,4 +1,5 @@ /** + * @file * Phoebe DOM Implementation. * * This is a C++ approximation of the W3C DOM model, which follows @@ -6,7 +7,8 @@ * which are provided for reference. Most important is this one: * * http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407/idl-definitions.html - * + */ +/* * Authors: * Bob Jamison * @@ -36,8 +38,8 @@ */ -#ifndef __CSS_H__ -#define __CSS_H__ +#ifndef SEEN_CSS_H +#define SEEN_CSS_H #include "dom.h" #include "stylesheets.h" @@ -4663,7 +4665,7 @@ public: } //namespace org -#endif /* __CSS_H__ */ +#endif // SEEN_CSS_H /*######################################################################### ## E N D O F F I L E diff --git a/src/dom/cssreader.h b/src/dom/cssreader.h index 149db31ef..0a9a7c031 100644 --- a/src/dom/cssreader.h +++ b/src/dom/cssreader.h @@ -1,6 +1,7 @@ -#ifndef __CSSREADER_H__ -#define __CSSREADER_H__ +#ifndef SEEN_CSSREADER_H +#define SEEN_CSSREADER_H /** + * @file * Phoebe DOM Implementation. * * This is a C++ approximation of the W3C DOM model, which follows @@ -8,7 +9,8 @@ * which are provided for reference. Most important is this one: * * http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407/idl-definitions.html - * + */ +/* * Authors: * Bob Jamison * @@ -283,7 +285,7 @@ void getColumnAndRow(int p, int &col, int &row, int &lastNL); -#endif /* __CSSREADER_H__ */ +#endif // SEEN_CSSREADER_H //######################################################################### //# E N D O F F I L E //######################################################################### diff --git a/src/dom/dom.h b/src/dom/dom.h index 674a84186..c12c02869 100644 --- a/src/dom/dom.h +++ b/src/dom/dom.h @@ -1,6 +1,7 @@ -#ifndef __DOM_H__ -#define __DOM_H__ +#ifndef SEEN_DOM_H +#define SEEN_DOM_H /** + * @file * Phoebe DOM Implementation. * * This is a C++ approximation of the W3C DOM model, which follows @@ -12,7 +13,8 @@ * More thorough explanations of the various classes and their algorithms * can be found there. * - * + */ +/* * Authors: * Bob Jamison * @@ -2743,7 +2745,7 @@ public: } //namespace org -#endif // __DOM_H__ +#endif // SEEN_DOM_H /*######################################################################### diff --git a/src/dom/domimpl.h b/src/dom/domimpl.h index dbf81757e..4e17ce5ba 100644 --- a/src/dom/domimpl.h +++ b/src/dom/domimpl.h @@ -1,6 +1,7 @@ -#ifndef __DOMIMPL_H__ -#define __DOMIMPL_H__ +#ifndef SEEN_DOMIMPL_H +#define SEEN_DOMIMPL_H /** + * @file * Phoebe DOM Implementation. * * This is a C++ approximation of the W3C DOM model, which follows @@ -8,7 +9,8 @@ * which are provided for reference. Most important is this one: * * http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407/idl-definitions.html - * + */ +/* * Authors: * Bob Jamison * @@ -2015,7 +2017,7 @@ protected: } //namespace org -#endif // __DOMIMPL_H__ +#endif // SEEN_DOMIMPL_H /*######################################################################### diff --git a/src/dom/domptr.h b/src/dom/domptr.h index aaf1220f3..5a1299867 100644 --- a/src/dom/domptr.h +++ b/src/dom/domptr.h @@ -1,6 +1,7 @@ -#ifndef __DOMPTR_H__ -#define __DOMPTR_H__ +#ifndef SEEN_DOMPTR_H +#define SEEN_DOMPTR_H /** + * @file * Phoebe DOM Implementation. * * This is a C++ approximation of the W3C DOM model, which follows @@ -12,7 +13,8 @@ * More thorough explanations of the various classes and their algorithms * can be found there. * - * + */ +/* * Authors: * Bob Jamison * @@ -325,7 +327,7 @@ template<class T, class U> Ptr<T> } //namespace org -#endif // __DOMPTR_H__ +#endif // SEEN_DOMPTR_H /*######################################################################### diff --git a/src/dom/domstring.h b/src/dom/domstring.h index a963e9850..0002bd9b5 100644 --- a/src/dom/domstring.h +++ b/src/dom/domstring.h @@ -1,6 +1,7 @@ -#ifndef __DOMSTRING_H__ -#define __DOMSTRING_H__ +#ifndef SEEN_DOMSTRING_H +#define SEEN_DOMSTRING_H /** + * @file * Phoebe DOM Implementation. * * This is a C++ approximation of the W3C DOM model, which follows @@ -8,7 +9,8 @@ * which are provided for reference. Most important is this one: * * http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407/idl-definitions.html - * + */ +/* * Authors: * Bob Jamison * @@ -306,7 +308,7 @@ DOMString &operator +(const char *b, DOMString &a); } //namespace w3c } //namespace org -#endif // __DOMSTRING_H__ +#endif // SEEN_DOMSTRING_H //######################################################################### //## E N D O F F I L E //######################################################################### diff --git a/src/dom/events.h b/src/dom/events.h index e6a8e0d6c..c4000ec29 100644 --- a/src/dom/events.h +++ b/src/dom/events.h @@ -1,7 +1,8 @@ -#ifndef __EVENTS_H__ -#define __EVENTS_H__ +#ifndef SEEN_EVENTS_H +#define SEEN_EVENTS_H /** + * @file * Phoebe DOM Implementation. * * This is a C++ approximation of the W3C DOM model, which follows @@ -9,7 +10,8 @@ * which are provided for reference. Most important is this one: * * http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407/idl-definitions.html - * + */ +/* * Authors: * Bob Jamison * @@ -1601,7 +1603,7 @@ protected: } //namespace w3c } //namespace org -#endif /* __EVENTS_H__ */ +#endif // SEEN_EVENTS_H /*######################################################################### ## E N D O F F I L E diff --git a/src/dom/io/base64stream.h b/src/dom/io/base64stream.h index c6d0ad35d..93bb5c7e5 100644 --- a/src/dom/io/base64stream.h +++ b/src/dom/io/base64stream.h @@ -1,7 +1,8 @@ -#ifndef __DOM_IO_BASE64STREAM_H__ -#define __DOM_IO_BASE64STREAM_H__ +#ifndef SEEN_DOM_IO_BASE64STREAM_H +#define SEEN_DOM_IO_BASE64STREAM_H /** + * @file * Phoebe DOM Implementation. * * Base64-enabled input and output streams @@ -11,7 +12,8 @@ * the implementation from the user. * * http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407/idl-definitions.html - * + */ +/* * Authors: * Bob Jamison * @@ -143,4 +145,4 @@ private: } //namespace org -#endif /* __INKSCAPE_IO_BASE64STREAM_H__ */ +#endif // SEEN_DOM_IO_BASE64STREAM_H diff --git a/src/dom/io/bufferstream.h b/src/dom/io/bufferstream.h index bdf4eb2ab..9a36b30e2 100644 --- a/src/dom/io/bufferstream.h +++ b/src/dom/io/bufferstream.h @@ -1,6 +1,7 @@ -#ifndef __BUFFERSTREAM_H__ -#define __BUFFERSTREAM_H__ +#ifndef SEEN_BUFFERSTREAM_H +#define SEEN_BUFFERSTREAM_H /** + * @file * Phoebe DOM Implementation. * * This is a C++ approximation of the W3C DOM model, which follows @@ -8,7 +9,8 @@ * which are provided for reference. Most important is this one: * * http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407/idl-definitions.html - * + */ +/* * Authors: * Bob Jamison * @@ -130,4 +132,4 @@ private: -#endif /* __BUFFERSTREAM_H__ */ +#endif // SEEN_BUFFERSTREAM_H diff --git a/src/dom/io/domstream.h b/src/dom/io/domstream.h index 0c60aca7a..b2e308653 100644 --- a/src/dom/io/domstream.h +++ b/src/dom/io/domstream.h @@ -1,6 +1,7 @@ -#ifndef __DOMSTREAM_H__ -#define __DOMSTREAM_H__ +#ifndef SEEN_DOMSTREAM_H +#define SEEN_DOMSTREAM_H /** + * @file * Phoebe DOM Implementation. * * This is a C++ approximation of the W3C DOM model, which follows @@ -8,7 +9,8 @@ * which are provided for reference. Most important is this one: * * http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407/idl-definitions.html - * + */ +/* * Authors: * Bob Jamison * @@ -677,7 +679,7 @@ void pipeStream(InputStream &source, OutputStream &dest); } //namespace org -#endif /* __DOMSTREAM_H__ */ +#endif // SEEN_DOMSTREAM_H //######################################################################### //# E N D O F F I L E diff --git a/src/dom/io/gzipstream.h b/src/dom/io/gzipstream.h index ea0807f32..6e82c3531 100644 --- a/src/dom/io/gzipstream.h +++ b/src/dom/io/gzipstream.h @@ -1,12 +1,13 @@ -#ifndef __GZIPSTREAM_H__ -#define __GZIPSTREAM_H__ +#ifndef SEEN_GZIPSTREAM_H +#define SEEN_GZIPSTREAM_H /** * Zlib-enabled input and output streams * * This provides a simple mechanism for reading and * writing Gzip files. We use our own 'ZipTool' class * to accomplish this, avoiding a zlib dependency. - * + */ +/* * Authors: * Bob Jamison * @@ -122,4 +123,4 @@ private: } // namespace org -#endif /* __GZIPSTREAM_H__ */ +#endif // SEEN_GZIPSTREAM_H diff --git a/src/dom/io/stringstream.h b/src/dom/io/stringstream.h index 38aaf7235..f6ed89e65 100644 --- a/src/dom/io/stringstream.h +++ b/src/dom/io/stringstream.h @@ -1,6 +1,7 @@ -#ifndef __STRINGSTREAM_H__ -#define __STRINGSTREAM_H__ +#ifndef SEEN_STRINGSTREAM_H +#define SEEN_STRINGSTREAM_H /** + * @file * Phoebe DOM Implementation. * * This is a C++ approximation of the W3C DOM model, which follows @@ -8,7 +9,8 @@ * which are provided for reference. Most important is this one: * * http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407/idl-definitions.html - * + */ +/* * Authors: * Bob Jamison * @@ -126,4 +128,4 @@ private: -#endif /* __STRINGSTREAM_H__ */ +#endif // SEEN_STRINGSTREAM_H diff --git a/src/dom/io/uristream.h b/src/dom/io/uristream.h index a885726e4..8d60468a5 100644 --- a/src/dom/io/uristream.h +++ b/src/dom/io/uristream.h @@ -1,5 +1,5 @@ -#ifndef __URISTREAM_H__ -#define __URISTREAM_H__ +#ifndef SEEN_URISTREAM_H +#define SEEN_URISTREAM_H /** * Phoebe DOM Implementation. @@ -9,7 +9,8 @@ * which are provided for reference. Most important is this one: * * http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407/idl-definitions.html - * + */ +/* * Authors: * Bob Jamison * @@ -203,4 +204,4 @@ private: #########################################################################*/ -#endif /* __URISTREAM_H__ */ +#endif // SEEN_URISTREAM_H diff --git a/src/dom/ls.h b/src/dom/ls.h index c4bdf1120..fd224ea6b 100644 --- a/src/dom/ls.h +++ b/src/dom/ls.h @@ -1,6 +1,7 @@ -#ifndef __LS_H__ -#define __LS_H__ +#ifndef SEEN_LS_H +#define SEEN_LS_H /** + * @file * Phoebe DOM Implementation. * * This is a C++ approximation of the W3C DOM model, which follows @@ -8,7 +9,8 @@ * which are provided for reference. Most important is this one: * * http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407/idl-definitions.html - * + */ +/* * Authors: * Bob Jamison * @@ -937,7 +939,7 @@ public: } //namespace org -#endif // __LS_H__ +#endif // SEEN_LS_H /*######################################################################### ## E N D O F F I L E diff --git a/src/dom/lsimpl.h b/src/dom/lsimpl.h index b87498517..621a5577a 100644 --- a/src/dom/lsimpl.h +++ b/src/dom/lsimpl.h @@ -1,6 +1,7 @@ -#ifndef __LSIMPL_H__ -#define __LSIMPL_H__ +#ifndef SEEN_LSIMPL_H +#define SEEN_LSIMPL_H /** + * @file * Phoebe DOM Implementation. * * This is a C++ approximation of the W3C DOM model, which follows @@ -8,7 +9,8 @@ * which are provided for reference. Most important is this one: * * http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407/idl-definitions.html - * + */ +/* * Authors: * Bob Jamison * @@ -372,7 +374,7 @@ protected: -#endif /* __LSIMPL_H__ */ +#endif // SEEN_LSIMPL_H /*######################################################################### ## E N D O F F I L E diff --git a/src/dom/odf/odfdocument.h b/src/dom/odf/odfdocument.h index 0f892acb0..168df11c7 100644 --- a/src/dom/odf/odfdocument.h +++ b/src/dom/odf/odfdocument.h @@ -1,12 +1,6 @@ -#ifndef __ODF_DOCUMENT_H__ -#define __ODF_DOCUMENT_H__ -/** - * - * This class contains an ODF Document. - * Initially, we are just concerned with .odg content.xml + resources - * - * --------------------------------------------------------------------- - * +#ifndef SEEN_ODF_DOCUMENT_H +#define SEEN_ODF_DOCUMENT_H +/* * Copyright (C) 2006 Bob Jamison * * This program is free software; you can redistribute it and/or modify @@ -103,6 +97,8 @@ private: /** * + * This class contains an ODF Document. + * Initially, we are just concerned with .odg content.xml + resources */ class OdfDocument { @@ -146,7 +142,7 @@ private: -#endif /*__ODF_DOCUMENT_H__*/ +#endif // SEEN_ODF_DOCUMENT_H //######################################################################## //# E N D O F F I L E diff --git a/src/dom/smil.h b/src/dom/smil.h index c9de6ccb7..15bc361ac 100644 --- a/src/dom/smil.h +++ b/src/dom/smil.h @@ -1,6 +1,7 @@ -#ifndef __SMIL_H__ -#define __SMIL_H__ +#ifndef SEEN_SMIL_H +#define SEEN_SMIL_H /** + * @file * Phoebe DOM Implementation. * * This is a C++ approximation of the W3C DOM model, which follows @@ -8,7 +9,8 @@ * which are provided for reference. Most important is this one: * * http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407/idl-definitions.html - * + */ +/* * Authors: * Bob Jamison * @@ -2486,7 +2488,7 @@ public: } //namespace w3c } //namespace org -#endif /* __SMIL_H__ */ +#endif // SEEN_SMIL_H /*######################################################################### ## E N D O F F I L E diff --git a/src/dom/smilimpl.h b/src/dom/smilimpl.h index cb06eb5f5..d71df020a 100644 --- a/src/dom/smilimpl.h +++ b/src/dom/smilimpl.h @@ -1,5 +1,5 @@ -#ifndef __SMILIMPL_H__ -#define __SMILIMPL_H__ +#ifndef SEEN_SMILIMPL_H +#define SEEN_SMILIMPL_H /** * Phoebe DOM Implementation. * @@ -8,7 +8,8 @@ * which are provided for reference. Most important is this one: * * http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407/idl-definitions.html - * + */ +/* * Authors: * Bob Jamison * @@ -757,7 +758,7 @@ public: } //namespace w3c } //namespace org -#endif /* __SMILIMPL_H__ */ +#endif // SEEN_SMILIMPL_H /*######################################################################### ## E N D O F F I L E diff --git a/src/dom/stylesheets.h b/src/dom/stylesheets.h index 0e76d6d4e..3ba225af3 100644 --- a/src/dom/stylesheets.h +++ b/src/dom/stylesheets.h @@ -1,7 +1,8 @@ -#ifndef __STYLESHEETS_H__ -#define __STYLESHEETS_H__ +#ifndef SEEN_STYLESHEETS_H +#define SEEN_STYLESHEETS_H /** + * @file * Phoebe DOM Implementation. * * This is a C++ approximation of the W3C DOM model, which follows @@ -9,7 +10,8 @@ * which are provided for reference. Most important is this one: * * http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407/idl-definitions.html - * + */ +/* * Authors: * Bob Jamison * @@ -584,7 +586,7 @@ protected: } //namespace org -#endif /* __STYLESHEETS_H__ */ +#endif // SEEN_STYLESHEETS_H /*######################################################################### ## E N D O F F I L E #########################################################################*/ diff --git a/src/dom/svg.h b/src/dom/svg.h index 5bf943cc6..09754055d 100644 --- a/src/dom/svg.h +++ b/src/dom/svg.h @@ -1,7 +1,8 @@ -#ifndef __SVG_H__ -#define __SVG_H__ +#ifndef SEEN_SVG_H +#define SEEN_SVG_H /** + * @file * Phoebe DOM Implementation. * * This is a C++ approximation of the W3C DOM model, which follows @@ -9,7 +10,8 @@ * which are provided for reference. Most important is this one: * * http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407/idl-definitions.html - * + */ +/* * Authors: * Bob Jamison * @@ -4749,7 +4751,7 @@ public: } //namespace w3c } //namespace org -#endif // __SVG_H__ +#endif // SEEN_SVG_H /*######################################################################### ## E N D O F F I L E #########################################################################*/ diff --git a/src/dom/svg2.h b/src/dom/svg2.h index b1a42e8aa..011bafbea 100644 --- a/src/dom/svg2.h +++ b/src/dom/svg2.h @@ -1,7 +1,8 @@ -#ifndef __SVG_H__ -#define __SVG_H__ +#ifndef SEEN_SVG_H +#define SEEN_SVG_H /** + * @file * Phoebe DOM Implementation. * * This is a C++ approximation of the W3C DOM model, which follows @@ -9,7 +10,8 @@ * which are provided for reference. Most important is this one: * * http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407/idl-definitions.html - * + */ +/* * Authors: * Bob Jamison * @@ -5551,7 +5553,7 @@ public: } //namespace w3c } //namespace org -#endif // __SVG_H__ +#endif // SEEN_SVG_H /*######################################################################### ## E N D O F F I L E #########################################################################*/ diff --git a/src/dom/svgimpl.h b/src/dom/svgimpl.h index 62d6acaf3..83d56fa22 100644 --- a/src/dom/svgimpl.h +++ b/src/dom/svgimpl.h @@ -1,7 +1,8 @@ -#ifndef __SVGIMPL_H__ -#define __SVGIMPL_H__ +#ifndef SEEN_SVGIMPL_H +#define SEEN_SVGIMPL_H /** + * @file * Phoebe DOM Implementation. * * This is a C++ approximation of the W3C DOM model, which follows @@ -9,7 +10,8 @@ * which are provided for reference. Most important is this one: * * http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407/idl-definitions.html - * + */ +/* * Authors: * Bob Jamison * @@ -5527,7 +5529,7 @@ protected: } //namespace w3c } //namespace org -#endif // __SVG_H__ +#endif // SEEN_SVGIMPL_H /*######################################################################### ## E N D O F F I L E #########################################################################*/ diff --git a/src/dom/svgreader.h b/src/dom/svgreader.h index 2a0106cac..3d66ce507 100644 --- a/src/dom/svgreader.h +++ b/src/dom/svgreader.h @@ -1,7 +1,8 @@ -#ifndef __SVGREADER_H__ -#define __SVGREADER_H__ +#ifndef SEEN_SVGREADER_H +#define SEEN_SVGREADER_H /** + * @file * Phoebe DOM Implementation. * * This is a C++ approximation of the W3C DOM model, which follows @@ -9,7 +10,8 @@ * which are provided for reference. Most important is this one: * * http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407/idl-definitions.html - * + */ +/* * Authors: * Bob Jamison * @@ -179,7 +181,7 @@ private: } //namespace w3c } //namespace org -#endif /* __SVGREADER_H__ */ +#endif // SEEN_SVGREADER_H /*######################################################################### ## E N D O F F I L E #########################################################################*/ diff --git a/src/dom/svgtypes.h b/src/dom/svgtypes.h index 09ed00bb5..0c30069b8 100644 --- a/src/dom/svgtypes.h +++ b/src/dom/svgtypes.h @@ -1,7 +1,8 @@ -#ifndef __SVGTYPES_H__ -#define __SVGTYPES_H__ +#ifndef SEEN_SVGTYPES_H +#define SEEN_SVGTYPES_H /** + * @file * Phoebe DOM Implementation. * * This is a C++ approximation of the W3C DOM model, which follows @@ -9,7 +10,8 @@ * which are provided for reference. Most important is this one: * * http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407/idl-definitions.html - * + */ +/* * Authors: * Bob Jamison * @@ -6895,7 +6897,7 @@ protected: } //namespace w3c } //namespace org -#endif /* __SVGTYPES_H__ */ +#endif // SEEN_SVGTYPES_H /*######################################################################### ## E N D O F F I L E #########################################################################*/ diff --git a/src/dom/traversal.h b/src/dom/traversal.h index 6d00bac67..0cade9576 100644 --- a/src/dom/traversal.h +++ b/src/dom/traversal.h @@ -1,7 +1,7 @@ -#ifndef __TRAVERSAL_H__ -#define __TRAVERSAL_H__ - +#ifndef SEEN_TRAVERSAL_H +#define SEEN_TRAVERSAL_H /** + * @file * Phoebe DOM Implementation. * * This is a C++ approximation of the W3C DOM model, which follows @@ -9,7 +9,8 @@ * which are provided for reference. Most important is this one: * * http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407/idl-definitions.html - * + */ +/* * Authors: * Bob Jamison * @@ -590,7 +591,7 @@ public: } //namespace w3c } //namespace org -#endif /* __TRAVERSAL_H__ */ +#endif // SEEN_TRAVERSAL_H /*######################################################################### diff --git a/src/dom/ucd.h b/src/dom/ucd.h index c4d0ab4e0..112c45f20 100644 --- a/src/dom/ucd.h +++ b/src/dom/ucd.h @@ -1,4 +1,5 @@ /** + * @file * Phoebe DOM Implementation. * * This is a C++ approximation of the W3C DOM model, which follows @@ -10,7 +11,8 @@ * More thorough explanations of the various classes and their algorithms * can be found there. * - * + */ +/* * Authors: * Bob Jamison * @@ -31,11 +33,11 @@ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA * */ -#ifndef __UCD_H__ -#define __UCD_H__ +#ifndef SEEN_UCD_H +#define SEEN_UCD_H -/************************************************ +/* *********************************************** ** Unicode character classification ************************************************/ @@ -186,7 +188,7 @@ int uni_to_upper(int ch); int uni_to_title(int ch); -/************************************************ +/* *********************************************** ** Unicode blocks ************************************************/ @@ -328,6 +330,6 @@ typedef enum } UnicodeBlocks; -#endif /* __UCD_H__ */ +#endif // SEEN_UCD_H diff --git a/src/dom/uri.h b/src/dom/uri.h index 40f80b077..4d3c384c9 100644 --- a/src/dom/uri.h +++ b/src/dom/uri.h @@ -1,7 +1,8 @@ -#ifndef __URI_H__ -#define __URI_H__ +#ifndef SEEN_URI_H +#define SEEN_URI_H /** + * @file * Phoebe DOM Implementation. * * This is a C++ approximation of the W3C DOM model, which follows @@ -9,7 +10,8 @@ * which are provided for reference. Most important is this one: * * http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407/idl-definitions.html - * + */ +/* * Authors: * Bob Jamison * @@ -482,5 +484,5 @@ private: -#endif /* __URI_H__ */ +#endif // SEEN_URI_H diff --git a/src/dom/util/digest.h b/src/dom/util/digest.h index 8c193420f..fed5b7e86 100644 --- a/src/dom/util/digest.h +++ b/src/dom/util/digest.h @@ -1,8 +1,6 @@ -#ifndef __DIGEST_H__ -#define __DIGEST_H__ -/** - * Secure Hashing Tool - * +#ifndef SEEN_DIGEST_H +#define SEEN_DIGEST_H +/* * * Author: * Bob Jamison @@ -25,7 +23,7 @@ */ /** - * + * @file * This base class and its subclasses provide an easy API for providing * several different types of secure hashing functions for whatever use * a developer might need. This is not intended as a high-performance diff --git a/src/dom/util/thread.h b/src/dom/util/thread.h index dfad6d9b3..1408cd78f 100644 --- a/src/dom/util/thread.h +++ b/src/dom/util/thread.h @@ -1,5 +1,5 @@ -#ifndef __DOM_THREAD_H__ -#define __DOM_THREAD_H__ +#ifndef SEEN_DOM_THREAD_H +#define SEEN_DOM_THREAD_H /** * Phoebe DOM Implementation. * @@ -8,7 +8,8 @@ * which are provided for reference. Most important is this one: * * http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407/idl-definitions.html - * + */ +/* * Authors: * Bob Jamison * @@ -29,7 +30,7 @@ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */ -/** +/* * Thread wrapper. This provides a platform-independent thread * class for IO and testing. * @@ -147,7 +148,7 @@ private: -#endif /* __DOM_THREAD_H__ */ +#endif // SEEN_DOM_THREAD_H //######################################################################### //# E N D O F F I L E //######################################################################### diff --git a/src/dom/util/ziptool.h b/src/dom/util/ziptool.h index 6cef266cf..47e669962 100644 --- a/src/dom/util/ziptool.h +++ b/src/dom/util/ziptool.h @@ -1,5 +1,5 @@ -#ifndef __ZIPTOOL_H__ -#define __ZIPTOOL_H__ +#ifndef SEEN_ZIPTOOL_H +#define SEEN_ZIPTOOL_H /** * This is intended to be a standalone, reduced capability * implementation of Gzip and Zip functionality. Its @@ -11,7 +11,8 @@ * one-at-a-time tasks. What you get in return is the ability * to drop these files into your project and remove the dependencies * on ZLib and Info-Zip. Enjoy. - * + */ +/* * Authors: * Bob Jamison * @@ -559,7 +560,7 @@ private: -#endif /* __ZIPTOOL_H__ */ +#endif // SEEN_ZIPTOOL_H //######################################################################## diff --git a/src/dom/views-level3.h b/src/dom/views-level3.h index f62d18751..427051d06 100644 --- a/src/dom/views-level3.h +++ b/src/dom/views-level3.h @@ -1,7 +1,8 @@ -#ifndef __VIEWS_LEVEL3_H__ -#define __VIEWS_LEVEL3_H__ +#ifndef SEEN_VIEWS_LEVEL3_H +#define SEEN_VIEWS_LEVEL3_H /** + * @file * Phoebe DOM Implementation. * * This is a C++ approximation of the W3C DOM model, which follows @@ -9,7 +10,8 @@ * which are provided for reference. Most important is this one: * * http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407/idl-definitions.html - * + */ +/* * Authors: * Bob Jamison * @@ -30,7 +32,7 @@ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */ -/** +/* * Currently CSS is not at level 3, so we will probably not use this * Level 3 Views implementation. Rather, we'll regress back to Level 2. * This should not affect using the rest of DOM Core 3 @@ -1958,7 +1960,7 @@ protected: } //namespace org -#endif /* __VIEWS_LEVEL3_H__ */ +#endif // SEEN_VIEWS_LEVEL3_H /*######################################################################### ## E N D O F F I L E #########################################################################*/ diff --git a/src/dom/views.h b/src/dom/views.h index 9e87dfbe7..48afd5d16 100644 --- a/src/dom/views.h +++ b/src/dom/views.h @@ -1,7 +1,8 @@ -#ifndef __VIEWS_H__ -#define __VIEWS_H__ +#ifndef SEEN_VIEWS_H +#define SEEN_VIEWS_H /** + * @file * Phoebe DOM Implementation. * * This is a C++ approximation of the W3C DOM model, which follows @@ -9,7 +10,8 @@ * which are provided for reference. Most important is this one: * * http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407/idl-definitions.html - * + */ +/* * Authors: * Bob Jamison * @@ -207,7 +209,7 @@ private: } //namespace org -#endif /* __VIEWS_H__ */ +#endif // SEEN_VIEWS_H /*######################################################################### ## E N D O F F I L E #########################################################################*/ diff --git a/src/dom/xmlreader.h b/src/dom/xmlreader.h index 3f97d87c9..7ab6de826 100644 --- a/src/dom/xmlreader.h +++ b/src/dom/xmlreader.h @@ -1,5 +1,5 @@ -#ifndef _XMLREADER_H_ -#define _XMLREADER_H_ +#ifndef SEEN_XMLREADER_H +#define SEEN_XMLREADER_H /** * Phoebe DOM Implementation. @@ -9,7 +9,8 @@ * which are provided for reference. Most important is this one: * * http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407/idl-definitions.html - * + */ +/* * Authors: * Bob Jamison * @@ -129,4 +130,4 @@ private: } //namespace w3c } //namespace org -#endif /*_XMLREADER_H_*/ +#endif // SEEN_XMLREADER_H diff --git a/src/dom/xmlwriter.h b/src/dom/xmlwriter.h index cd787993c..f50c91bc4 100644 --- a/src/dom/xmlwriter.h +++ b/src/dom/xmlwriter.h @@ -1,7 +1,8 @@ -#ifndef __XMLWRITER_H__ -#define __XMLWRITER_H__ +#ifndef SEEN_XMLWRITER_H +#define SEEN_XMLWRITER_H /** + * @file * Phoebe DOM Implementation. * * This is a C++ approximation of the W3C DOM model, which follows @@ -9,7 +10,8 @@ * which are provided for reference. Most important is this one: * * http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407/idl-definitions.html - * + */ +/* * Authors: * Bob Jamison * @@ -85,7 +87,7 @@ protected: -#endif /* __XMLWRITER_H__ */ +#endif // SEEN_XMLWRITER_H diff --git a/src/dom/xpath.h b/src/dom/xpath.h index 60c35d76f..ce5b88f7f 100644 --- a/src/dom/xpath.h +++ b/src/dom/xpath.h @@ -1,7 +1,8 @@ -#ifndef __XPATH_H__ -#define __XPATH_H__ +#ifndef SEEN_XPATH_H +#define SEEN_XPATH_H /** + * @file * Phoebe DOM Implementation. * * This is a C++ approximation of the W3C DOM model, which follows @@ -9,7 +10,8 @@ * which are provided for reference. Most important is this one: * * http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407/idl-definitions.html - * + */ +/* * Authors: * Bob Jamison * @@ -340,7 +342,7 @@ public: -#endif /* __XPATH_H__ */ +#endif // SEEN_XPATH_H /*######################################################################### ## E N D O F F I L E #########################################################################*/ diff --git a/src/dom/xpathimpl.h b/src/dom/xpathimpl.h index c12e78205..82b5c48f8 100644 --- a/src/dom/xpathimpl.h +++ b/src/dom/xpathimpl.h @@ -1,7 +1,8 @@ -#ifndef __XPATHIMPL_H__ -#define __XPATHIMPL_H__ +#ifndef SEEN_XPATHIMPL_H +#define SEEN_XPATHIMPL_H /** + * @file * Phoebe DOM Implementation. * * This is a C++ approximation of the W3C DOM model, which follows @@ -9,7 +10,8 @@ * which are provided for reference. Most important is this one: * * http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407/idl-definitions.html - * + */ +/* * Authors: * Bob Jamison * diff --git a/src/dom/xpathparser.h b/src/dom/xpathparser.h index 1ad4b5f54..041564e21 100644 --- a/src/dom/xpathparser.h +++ b/src/dom/xpathparser.h @@ -1,7 +1,8 @@ -#ifndef __XPATHPARSER_H__ -#define __XPATHPARSER_H__ +#ifndef SEEN_XPATHPARSER_H +#define SEEN_XPATHPARSER_H /** + * @file * Phoebe DOM Implementation. * * This is a C++ approximation of the W3C DOM model, which follows @@ -9,7 +10,8 @@ * which are provided for reference. Most important is this one: * * http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407/idl-definitions.html - * + */ +/* * Authors: * Bob Jamison * @@ -794,15 +796,7 @@ private: } // namespace dom } // namespace w3c } // namespace org -#endif /* __XPATHPARSER_H__ */ +#endif // SEEN_XPATHPARSER_H //######################################################################### //# E N D O F F I L E //######################################################################### - - - - - - - - diff --git a/src/dom/xpathtoken.h b/src/dom/xpathtoken.h index 8683b2ee1..5bb87917b 100644 --- a/src/dom/xpathtoken.h +++ b/src/dom/xpathtoken.h @@ -1,7 +1,8 @@ -#ifndef __XPATHTOKEN_H__ -#define __XPATHTOKEN_H__ +#ifndef SEEN_XPATHTOKEN_H +#define SEEN_XPATHTOKEN_H /** + * @file * Phoebe DOM Implementation. * * This is a C++ approximation of the W3C DOM model, which follows @@ -9,7 +10,8 @@ * which are provided for reference. Most important is this one: * * http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407/idl-definitions.html - * + */ +/* * Authors: * Bob Jamison * @@ -667,7 +669,7 @@ private: -#endif /* __XPATHTOKEN_H__ */ +#endif // SEEN_XPATHTOKEN_H //######################################################################## //# E N D O F F I L E //######################################################################## diff --git a/src/event-context.h b/src/event-context.h index ca13fe7e8..1c9f46a46 100644 --- a/src/event-context.h +++ b/src/event-context.h @@ -1,12 +1,7 @@ #ifndef SEEN_SP_EVENT_CONTEXT_H #define SEEN_SP_EVENT_CONTEXT_H -/** \file - * SPEventContext: base class for event processors - * - * This is per desktop object, which (its derivatives) implements - * different actions bound to mouse events. - * +/* * Authors: * Lauris Kaplinski <lauris@kaplinski.com> * Frank Felfe <innerspace@iname.com> @@ -96,6 +91,9 @@ void sp_event_context_snap_delay_handler(SPEventContext *ec, gpointer const dse_ /** * Base class for Event processors. + * + * This is per desktop object, which (its derivatives) implements + * different actions bound to mouse events. */ struct SPEventContext : public GObject { void enableSelectionCue (bool enable=true); diff --git a/src/event-log.h b/src/event-log.h index 3f3c6830e..a429994c8 100644 --- a/src/event-log.h +++ b/src/event-log.h @@ -1,18 +1,4 @@ -/** - * Inkscape::EventLog - * - * A simple log for maintaining a history of commited, undone and redone events along with their - * type. It implements the UndoStackObserver and should be registered with a - * CompositeUndoStackObserver for each document. The event log is then notified on all commit, undo - * and redo events and will store a representation of them in an internal Gtk::TreeStore. - * - * Consecutive events of the same type are grouped with the first event as a parent and following - * as its children. - * - * If a Gtk::TreeView is connected to the event log, the TreeView's selection and its nodes - * expanded/collapsed state will be updated as events are commited, undone and redone. Whenever - * this happens, the event log will block the TreeView's callbacks to prevent circular updates. - * +/* * Author: * Gustav Broberg <broberg@kth.se> * @@ -36,9 +22,20 @@ namespace Inkscape { /** - * + * A simple log for maintaining a history of commited, undone and redone events along with their + * type. It implements the UndoStackObserver and should be registered with a + * CompositeUndoStackObserver for each document. The event log is then notified on all commit, undo + * and redo events and will store a representation of them in an internal Gtk::TreeStore. + * + * Consecutive events of the same type are grouped with the first event as a parent and following + * as its children. + * + * If a Gtk::TreeView is connected to the event log, the TreeView's selection and its nodes + * expanded/collapsed state will be updated as events are commited, undone and redone. Whenever + * this happens, the event log will block the TreeView's callbacks to prevent circular updates. */ -class EventLog : public UndoStackObserver { +class EventLog : public UndoStackObserver +{ public: typedef Gtk::TreeModel::iterator iterator; @@ -50,7 +47,6 @@ public: /** * Event datatype */ - struct EventModelColumns : public Gtk::TreeModelColumnRecord { Gtk::TreeModelColumn<Event *> event; @@ -64,20 +60,18 @@ public: } }; + // Implementation of Inkscape::UndoStackObserver methods + /** - * Implementation of Inkscape::UndoStackObserver methods - * \brief Modifies the log's entries and the view's selection when triggered + * Modifies the log's entries and the view's selection when triggered. */ - void notifyUndoEvent(Event *log); void notifyRedoEvent(Event *log); void notifyUndoCommitEvent(Event *log); void notifyClearUndoEvent(); void notifyClearRedoEvent(); - /** - * Accessor functions - */ + // Accessor functions Glib::RefPtr<Gtk::TreeModel> getEventListStore() const { return _event_list_store; } const EventModelColumns& getColumns() const { return _columns; } @@ -89,9 +83,7 @@ public: void blockNotifications(bool status=true) { _notifications_blocked = status; } void rememberFileSave() { _last_saved = _curr_event; } - /* - * Callback types for TreeView changes. - */ + // Callback types for TreeView changes. enum CallbackTypes { CALLB_SELECTION_CHANGE, @@ -134,9 +126,7 @@ private: // Map of connections used to temporary block/unblock callbacks in a TreeView CallbackMap *_callback_connections; - /** - * Helper functions - */ + // Helper functions const_iterator _getUndoEvent() const; //< returns the current undoable event or NULL if none const_iterator _getRedoEvent() const; //< returns the current redoable event or NULL if none diff --git a/src/extension/internal/gimpgrad.h b/src/extension/internal/gimpgrad.h index 5ab48a147..c34de840d 100644 --- a/src/extension/internal/gimpgrad.h +++ b/src/extension/internal/gimpgrad.h @@ -1,7 +1,4 @@ -/** \file - * - * Implementation class of the GIMP gradient plugin. - * +/* * Authors: * Ted Gould <ted@gould.cx> * @@ -9,7 +6,7 @@ * * Released under GNU GPL, read the file 'COPYING' for more information */ - +// TODO add include guard #include <glibmm/ustring.h> #include "extension/implementation/implementation.h" @@ -21,10 +18,12 @@ class Extension; namespace Internal { -/** \brief Implementation class of the GIMP gradient plugin. This mostly - just creates a namespace for the GIMP gradient plugin today. -*/ -class GimpGrad : public Inkscape::Extension::Implementation::Implementation { +/** + * Implementation class of the GIMP gradient plugin. + * This mostly just creates a namespace for the GIMP gradient plugin today. + */ +class GimpGrad : public Inkscape::Extension::Implementation::Implementation +{ public: bool load(Inkscape::Extension::Extension *module); void unload(Inkscape::Extension::Extension *module); @@ -34,7 +33,9 @@ public: }; -} } } /* namespace Internal; Extension; Inkscape */ +} // namespace Internal +} // namespace Extension +} // namespace Inkscape /* Local Variables: diff --git a/src/extension/internal/odf.h b/src/extension/internal/odf.h index 2a6f7799f..a4a13681a 100644 --- a/src/extension/internal/odf.h +++ b/src/extension/internal/odf.h @@ -1,14 +1,4 @@ -/** - * OpenDocument <drawing> input and output - * - * This is an an entry in the extensions mechanism to begin to enable - * the inputting and outputting of OpenDocument Format (ODF) files from - * within Inkscape. Although the initial implementations will be very lossy - * do to the differences in the models of SVG and ODF, they will hopefully - * improve greatly with time. - * - * http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407/idl-definitions.html - * +/* * Authors: * Bob Jamison * Abhishek Sharma @@ -265,6 +255,17 @@ public: +/** + * OpenDocument <drawing> input and output + * + * This is an an entry in the extensions mechanism to begin to enable + * the inputting and outputting of OpenDocument Format (ODF) files from + * within Inkscape. Although the initial implementations will be very lossy + * do to the differences in the models of SVG and ODF, they will hopefully + * improve greatly with time. + * + * http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407/idl-definitions.html + */ class OdfOutput : public Inkscape::Extension::Implementation::Implementation { diff --git a/src/extension/internal/pdfinput/pdf-input.h b/src/extension/internal/pdfinput/pdf-input.h index c2fd0b6d8..6d3fd104a 100644 --- a/src/extension/internal/pdfinput/pdf-input.h +++ b/src/extension/internal/pdfinput/pdf-input.h @@ -1,9 +1,7 @@ -#ifndef __EXTENSION_INTERNAL_PDFINPUT_H__ -#define __EXTENSION_INTERNAL_PDFINPUT_H__ +#ifndef SEEN_EXTENSION_INTERNAL_PDFINPUT_H +#define SEEN_EXTENSION_INTERNAL_PDFINPUT_H - /** \file - * PDF import using libpoppler. - * +/* * Authors: * miklos erdelyi * @@ -50,6 +48,9 @@ namespace Widget { namespace Extension { namespace Internal { +/** + * PDF import using libpoppler. + */ class PdfImportDialog : public Gtk::Dialog { public: @@ -125,11 +126,13 @@ public: }; -} } } /* namespace Inkscape, Extension, Implementation */ +} // namespace Implementation +} // namespace Extension +} // namespace Inkscape -#endif /* HAVE_POPPLER */ +#endif // HAVE_POPPLER -#endif /* __EXTENSION_INTERNAL_PDFINPUT_H__ */ +#endif // SEEN_EXTENSION_INTERNAL_PDFINPUT_H /* Local Variables: diff --git a/src/extension/internal/pdfinput/pdf-parser.h b/src/extension/internal/pdfinput/pdf-parser.h index 21effe81d..a63d669c7 100644 --- a/src/extension/internal/pdfinput/pdf-parser.h +++ b/src/extension/internal/pdfinput/pdf-parser.h @@ -1,7 +1,4 @@ - - /** \file - * PDF parsing module using libpoppler's facilities - * + /* * Derived from Gfx.h * * Copyright 1996-2003 Glyph & Cog, LLC @@ -24,6 +21,8 @@ namespace Inkscape { } } } + +// TODO clean up and remove using: using Inkscape::Extension::Internal::SvgBuilder; #include "goo/gtypes.h" @@ -145,6 +144,10 @@ private: #define pdfNumShadingTypes 5 + +/** + * PDF parsing module using libpoppler's facilities. + */ class PdfParser { public: diff --git a/src/extension/internal/pdfinput/svg-builder.h b/src/extension/internal/pdfinput/svg-builder.h index 47e5d7735..7a36be806 100644 --- a/src/extension/internal/pdfinput/svg-builder.h +++ b/src/extension/internal/pdfinput/svg-builder.h @@ -1,9 +1,7 @@ -#ifndef __EXTENSION_INTERNAL_PDFINPUT_SVGBUILDER_H__ -#define __EXTENSION_INTERNAL_PDFINPUT_SVGBUILDER_H__ +#ifndef SEEN_EXTENSION_INTERNAL_PDFINPUT_SVGBUILDER_H +#define SEEN_EXTENSION_INTERNAL_PDFINPUT_SVGBUILDER_H - /** \file - * SVG representation creator using libpoppler. - * +/* * Authors: * miklos erdelyi * @@ -58,8 +56,7 @@ namespace Internal { struct SvgTransparencyGroup; /** - * \struct SvgGraphicsState - * Holds information about the current softmask and group depth. + * Holds information about the current softmask and group depth for use of libpoppler. * Could be later used to store other graphics state parameters so that we could * emit only the differences in style settings from the parent state. */ @@ -69,7 +66,6 @@ struct SvgGraphicsState { }; /** - * \struct SvgGlyph * Holds information about glyphs added by PdfParser which haven't been added * to the document yet. */ @@ -89,10 +85,7 @@ struct SvgGlyph { }; /** - * \class SvgBuilder - * - * Builds the inner SVG representation from the calls of PdfParser - * + * Builds the inner SVG representation using libpoppler from the calls of PdfParser. */ class SvgBuilder { public: @@ -232,11 +225,13 @@ private: }; -} } } /* namespace Inkscape, Extension, Internal */ +} // namespace Internal +} // namespace Extension +} // namespace Inkscape -#endif /* HAVE_POPPLER */ +#endif // HAVE_POPPLER -#endif /* __EXTENSION_INTERNAL_PDFINPUT_SVGBUILDER_H__ */ +#endif // SEEN_EXTENSION_INTERNAL_PDFINPUT_SVGBUILDER_H /* Local Variables: diff --git a/src/extension/script/InkscapeScript.h b/src/extension/script/InkscapeScript.h index c4a59e1e2..2ebeb1b19 100644 --- a/src/extension/script/InkscapeScript.h +++ b/src/extension/script/InkscapeScript.h @@ -1,9 +1,7 @@ -#ifndef __INKSCAPE_SCRIPT_H__ -#define __INKSCAPE_SCRIPT_H__ +#ifndef SEEN_INKSCAPE_SCRIPT_H +#define SEEN_INKSCAPE_SCRIPT_H -/** - * Inkscape Scripting container - * +/* * Authors: * Bob Jamison <rjamison@titan.com> * @@ -26,7 +24,8 @@ namespace Script /** - * This class is used to run scripts, either from a file or buffer + * Inkscape Scripting container. + * This class is used to run scripts, either from a file or buffer. */ class InkscapeScript { diff --git a/src/gc-anchored.h b/src/gc-anchored.h index ee277be25..b7c0cd0e4 100644 --- a/src/gc-anchored.h +++ b/src/gc-anchored.h @@ -1,6 +1,4 @@ -/** \file - * Inkscape::GC::Anchored - base class for anchored GC-managed objects - * +/* * Authors: * MenTaLguY <mental@rydia.net> * * Copyright (C) 2004 MenTaLguY diff --git a/src/gc-soft-ptr.h b/src/gc-soft-ptr.h index f83a0808d..9e7304939 100644 --- a/src/gc-soft-ptr.h +++ b/src/gc-soft-ptr.h @@ -1,6 +1,4 @@ -/** \file - * Inkscape::GC::soft_ptr - "soft" pointers to avoid finalization cycles - * +/* * Copyright 2006 MenTaLguY <mental@rydia.net> * * This program is free software; you can redistribute it and/or @@ -21,8 +19,9 @@ namespace Inkscape { namespace GC { -/** @brief A class for pointers which can be automatically cleared to break - * finalization cycles. +/** + * A class for pointers which can be automatically cleared to break + * finalization cycles. */ template <typename T> class soft_ptr { diff --git a/src/graphlayout.h b/src/graphlayout.h index 40090ef6b..6083ad77f 100644 --- a/src/graphlayout.h +++ b/src/graphlayout.h @@ -1,6 +1,8 @@ /** - * \brief graph layout functions - * + * @file + * graph layout functions. + */ +/* * Authors: * Tim Dwyer <tgdwyer@gmail.com> * diff --git a/src/guide-snapper.h b/src/guide-snapper.h index f8b3c2cee..f51939c08 100644 --- a/src/guide-snapper.h +++ b/src/guide-snapper.h @@ -1,10 +1,6 @@ #ifndef SEEN_GUIDE_SNAPPER_H #define SEEN_GUIDE_SNAPPER_H - -/** - * \file guide-snapper.h - * \brief Snapping things to guides. - * +/* * Authors: * Lauris Kaplinski <lauris@kaplinski.com> * Frank Felfe <innerspace@iname.com> @@ -22,7 +18,9 @@ struct SPNamedView; namespace Inkscape { -/// Snap to guides +/** + * Snap to guides. + */ class GuideSnapper : public LineSnapper { public: diff --git a/src/help.h b/src/help.h index b6c82fb51..2ded43c39 100644 --- a/src/help.h +++ b/src/help.h @@ -1,9 +1,6 @@ #ifndef SEEN_HELP_H #define SEEN_HELP_H - -/** - * Help/About window - * +/* * Authors: * Lauris Kaplinski <lauris@kaplinski.com> * @@ -16,7 +13,11 @@ #include <glib/gtypes.h> #include <gtk/gtk.h> +/** + * Help/About window. + */ void sp_help_about(void); + void sp_help_open_tutorial(GtkMenuItem *menuitem, gpointer data); diff --git a/src/helper-fns.h b/src/helper-fns.h index f407364a5..3ae150fdb 100644 --- a/src/helper-fns.h +++ b/src/helper-fns.h @@ -1,9 +1,6 @@ #ifndef SEEN_HELPER_FNS_H #define SEEN_HELPER_FNS_H -/** \file - * - * Some helper functions - * +/* * Authors: * Felipe Corrêa da Silva Sanches <juca@members.fsf.org> * diff --git a/src/helper/geom-curves.h b/src/helper/geom-curves.h index 5b921e572..4586a346c 100644 --- a/src/helper/geom-curves.h +++ b/src/helper/geom-curves.h @@ -2,8 +2,10 @@ #define INKSCAPE_HELPER_GEOM_CURVES_H /** + * @file * Specific curve type functions for Inkscape, not provided by lib2geom. - * + */ +/* * Author: * Johan Engelen <goejendaagh@zonnet.nl> * diff --git a/src/helper/geom-nodetype.h b/src/helper/geom-nodetype.h index 1a0d33b9d..2d299d545 100644 --- a/src/helper/geom-nodetype.h +++ b/src/helper/geom-nodetype.h @@ -2,8 +2,10 @@ #define INKSCAPE_HELPER_GEOM_NODETYPE_H /** + * @file * Specific nodetype geometry functions for Inkscape, not provided my lib2geom. - * + */ +/* * Author: * Johan Engelen <goejendaagh@zonnet.nl> * diff --git a/src/helper/geom.h b/src/helper/geom.h index 630d67aba..ee58a416d 100644 --- a/src/helper/geom.h +++ b/src/helper/geom.h @@ -2,8 +2,10 @@ #define INKSCAPE_HELPER_GEOM_H /** + * @file * Specific geometry functions for Inkscape, not provided my lib2geom. - * + */ +/* * Author: * Johan Engelen <goejendaagh@zonnet.nl> * diff --git a/src/io/base64stream.h b/src/io/base64stream.h index 7bfe73e5f..554a92fe2 100644 --- a/src/io/base64stream.h +++ b/src/io/base64stream.h @@ -1,13 +1,15 @@ -#ifndef __INKSCAPE_IO_BASE64STREAM_H__ -#define __INKSCAPE_IO_BASE64STREAM_H__ +#ifndef SEEN_INKSCAPE_IO_BASE64STREAM_H +#define SEEN_INKSCAPE_IO_BASE64STREAM_H /** + * @file * Base64-enabled input and output streams * * This class allows easy encoding and decoding * of Base64 data with a stream interface, hiding * the implementation from the user. - * + */ +/* * Authors: * Bob Jamison <rjamison@titan.com> * @@ -119,4 +121,4 @@ private: } // namespace Inkscape -#endif /* __INKSCAPE_IO_BASE64STREAM_H__ */ +#endif // SEEN_INKSCAPE_IO_BASE64STREAM_H diff --git a/src/io/gzipstream.h b/src/io/gzipstream.h index adaf50967..4debbfca9 100644 --- a/src/io/gzipstream.h +++ b/src/io/gzipstream.h @@ -1,12 +1,14 @@ -#ifndef __INKSCAPE_IO_GZIPSTREAM_H__ -#define __INKSCAPE_IO_GZIPSTREAM_H__ +#ifndef SEEN_INKSCAPE_IO_GZIPSTREAM_H +#define SEEN_INKSCAPE_IO_GZIPSTREAM_H /** - * Zlib-enabled input and output streams + * @file + * Zlib-enabled input and output streams. * * This is a thin wrapper of libz calls, in order * to provide a simple interface to our developers * for gzip input and output. - * + */ +/* * Authors: * Bob Jamison <rjamison@titan.com> * diff --git a/src/io/inkscapestream.h b/src/io/inkscapestream.h index 9358b4d51..a766e16e0 100644 --- a/src/io/inkscapestream.h +++ b/src/io/inkscapestream.h @@ -1,8 +1,6 @@ -#ifndef __INKSCAPE_IO_INKSCAPESTREAM_H__ -#define __INKSCAPE_IO_INKSCAPESTREAM_H__ -/** - * Our base basic stream classes. - * +#ifndef SEEN_INKSCAPE_IO_INKSCAPESTREAM_H +#define SEEN_INKSCAPE_IO_INKSCAPESTREAM_H +/* * Authors: * Bob Jamison <rjamison@titan.com> * @@ -667,4 +665,4 @@ void pipeStream(InputStream &source, OutputStream &dest); } // namespace Inkscape -#endif /* __INKSCAPE_IO_INKSCAPESTREAM_H__ */ +#endif // SEEN_INKSCAPE_IO_INKSCAPESTREAM_H diff --git a/src/io/resource.h b/src/io/resource.h index be3ff21b7..36fe5f81e 100644 --- a/src/io/resource.h +++ b/src/io/resource.h @@ -1,6 +1,4 @@ -/** \file - * Inkscape::IO::Resource - simple resource API - * +/* * Copyright 2006 MenTaLguY <mental@rydia.net> * * This program is free software; you can redistribute it and/or @@ -21,6 +19,9 @@ namespace Inkscape { namespace IO { +/** + * simple resource API + */ namespace Resource { enum Type { diff --git a/src/io/uristream.h b/src/io/uristream.h index d62065976..67d2f34d7 100644 --- a/src/io/uristream.h +++ b/src/io/uristream.h @@ -1,9 +1,11 @@ -#ifndef __INKSCAPE_IO_URISTREAM_H__ -#define __INKSCAPE_IO_URISTREAM_H__ +#ifndef SEEN_INKSCAPE_IO_URISTREAM_H +#define SEEN_INKSCAPE_IO_URISTREAM_H /** + * @file * This should be the only way that we provide sources/sinks * to any input/output stream. - * + */ +/* * Authors: * Bob Jamison <rjamison@titan.com> * @@ -170,4 +172,4 @@ private: } // namespace Inkscape -#endif /* __INKSCAPE_IO_URISTREAM_H__ */ +#endif // SEEN_INKSCAPE_IO_URISTREAM_H diff --git a/src/io/xsltstream.h b/src/io/xsltstream.h index 32d9d12f8..03621c7fd 100644 --- a/src/io/xsltstream.h +++ b/src/io/xsltstream.h @@ -1,9 +1,10 @@ -#ifndef __INKSCAPE_IO_XSLTSTREAM_H__ -#define __INKSCAPE_IO_XSLTSTREAM_H__ +#ifndef SEEN_INKSCAPE_IO_XSLTSTREAM_H +#define SEEN_INKSCAPE_IO_XSLTSTREAM_H /** + * @file * Xslt-enabled input and output streams - * - * + */ +/* * Authors: * Bob Jamison <ishmalius@gmail.com> * diff --git a/src/knot-enums.h b/src/knot-enums.h index e82810242..1045e0433 100644 --- a/src/knot-enums.h +++ b/src/knot-enums.h @@ -1,9 +1,11 @@ #ifndef SEEN_KNOT_ENUMS_H #define SEEN_KNOT_ENUMS_H -/** \file +/** + * @file * Some enums used by SPKnot and by related types \& functions. - * + */ +/* * Authors: * Lauris Kaplinski <lauris@kaplinski.com> * diff --git a/src/knot-holder-entity.h b/src/knot-holder-entity.h index bd654616c..726d969c2 100644 --- a/src/knot-holder-entity.h +++ b/src/knot-holder-entity.h @@ -1,9 +1,6 @@ #ifndef SEEN_KNOT_HOLDER_ENTITY_H #define SEEN_KNOT_HOLDER_ENTITY_H - -/** \file - * KnotHolderEntity definition. - * +/* * Authors: * Mitsuru Oka <oka326@parkcity.ne.jp> * Maximilian Albert <maximilian.albert@gmail.com> @@ -33,6 +30,9 @@ typedef Geom::Point (* SPKnotHolderGetFunc) (SPItem *item); /* fixme: Think how to make callbacks most sensitive (Lauris) */ typedef void (* SPKnotHolderReleasedFunc) (SPItem *item); +/** + * KnotHolderEntity definition. + */ class KnotHolderEntity { public: KnotHolderEntity() {} diff --git a/src/libcola/defs.h b/src/libcola/defs.h index cd8084c2c..e4e4e5096 100644 --- a/src/libcola/defs.h +++ b/src/libcola/defs.h @@ -1,7 +1,7 @@ /* $Id: defs.h,v 1.5 2005/10/18 18:42:59 ellson Exp $ $Revision: 1.5 $ */ /* vim:set shiftwidth=4 ts=8: */ -/********************************************************** +/* ******************************************************** * This software is part of the graphviz package * * http://www.graphviz.org/ * * * diff --git a/src/libvpsc/block.h b/src/libvpsc/block.h index fe4a18b78..a4625b202 100644 --- a/src/libvpsc/block.h +++ b/src/libvpsc/block.h @@ -1,8 +1,4 @@ -/** - * \brief A block is a group of variables that must be moved together to improve - * the goal function without violating already active constraints. - * The variables in a block are spanned by a tree of active constraints. - * +/* * Authors: * Tim Dwyer <tgdwyer@gmail.com> * @@ -21,6 +17,11 @@ namespace vpsc { class Variable; class Constraint; +/** + * A block is a group of variables that must be moved together to improve + * the goal function without violating already active constraints. + * The variables in a block are spanned by a tree of active constraints. + */ class Block { typedef std::vector<Variable*> Variables; diff --git a/src/libvpsc/csolve_VPSC.h b/src/libvpsc/csolve_VPSC.h index 81e50d990..92179fc77 100644 --- a/src/libvpsc/csolve_VPSC.h +++ b/src/libvpsc/csolve_VPSC.h @@ -1,6 +1,8 @@ /** - * \brief Bridge for C programs to access solve_VPSC (which is in C++) - * + * @file + * Bridge for C programs to access solve_VPSC (which is in C++). + */ +/* * Authors: * Tim Dwyer <tgdwyer@gmail.com> * diff --git a/src/libvpsc/pairingheap/PairingHeap.cpp b/src/libvpsc/pairingheap/PairingHeap.cpp index 202980b70..6e003f99c 100644 --- a/src/libvpsc/pairingheap/PairingHeap.cpp +++ b/src/libvpsc/pairingheap/PairingHeap.cpp @@ -1,12 +1,14 @@ /** - * \brief Pairing heap datastructure implementation + * @file + * Pairing heap datastructure implementation. * * Based on example code in "Data structures and Algorithm Analysis in C++" * by Mark Allen Weiss, used and released under the LGPL by permission * of the author. * * No promises about correctness. Use at your own risk! - * + */ +/* * Authors: * Mark Allen Weiss * Tim Dwyer <tgdwyer@gmail.com> diff --git a/src/libvpsc/pairingheap/PairingHeap.h b/src/libvpsc/pairingheap/PairingHeap.h index 6159e96c1..62c782d5d 100644 --- a/src/libvpsc/pairingheap/PairingHeap.h +++ b/src/libvpsc/pairingheap/PairingHeap.h @@ -1,10 +1,4 @@ -/** - * \brief Pairing heap datastructure implementation - * - * Based on example code in "Data structures and Algorithm Analysis in C++" - * by Mark Allen Weiss, used and released under the LGPL by permission - * of the author. - * +/* * No promises about correctness. Use at your own risk! * * Authors: @@ -67,6 +61,13 @@ public: virtual bool isLessThan(T const &lhs, T const &rhs) const = 0; }; +/** + * Pairing heap datastructure implementation. + * + * Based on example code in "Data structures and Algorithm Analysis in C++" + * by Mark Allen Weiss, used and released under the LGPL by permission + * of the author. + */ template <class T> class PairingHeap { diff --git a/src/libvpsc/solve_VPSC.h b/src/libvpsc/solve_VPSC.h index 0f919a22a..84f646226 100644 --- a/src/libvpsc/solve_VPSC.h +++ b/src/libvpsc/solve_VPSC.h @@ -1,7 +1,9 @@ /** - * \brief Solve an instance of the "Variable Placement with Separation + * @file + * Solve an instance of the "Variable Placement with Separation * Constraints" problem. - * + */ +/* * Authors: * Tim Dwyer <tgdwyer@gmail.com> * diff --git a/src/libvpsc/variable.h b/src/libvpsc/variable.h index 25239ff20..022754a7d 100644 --- a/src/libvpsc/variable.h +++ b/src/libvpsc/variable.h @@ -1,5 +1,4 @@ -/** - * +/* * Authors: * Tim Dwyer <tgdwyer@gmail.com> * diff --git a/src/line-snapper.h b/src/line-snapper.h index bf7d714b1..578a426ce 100644 --- a/src/line-snapper.h +++ b/src/line-snapper.h @@ -1,10 +1,6 @@ #ifndef SEEN_LINE_SNAPPER_H #define SEEN_LINE_SNAPPER_H - -/** - * \file src/line-snapper.h - * \brief Superclass for snappers to horizontal and vertical lines. - * +/* * Authors: * Carl Hetherington <inkscape@carlh.net> * Diederik van Lierop <mail@diedenrezi.nl> @@ -20,6 +16,10 @@ namespace Inkscape { class SnapCandidatePoint; + +/** + * Superclass for snappers to horizontal and vertical lines. + */ class LineSnapper : public Snapper { public: diff --git a/src/object-hierarchy.h b/src/object-hierarchy.h index f6ae4f15d..d510e7e69 100644 --- a/src/object-hierarchy.h +++ b/src/object-hierarchy.h @@ -1,6 +1,4 @@ -/** \file - * Inkscape::ObjectHierarchy - tracks a hierarchy of active SPObjects - * +/* * Authors: * MenTaLguY <mental@rydia.net> * @@ -36,7 +34,6 @@ namespace Inkscape { * * @see SPObject */ - class ObjectHierarchy { public: ObjectHierarchy(SPObject *top=NULL); diff --git a/src/object-snapper.h b/src/object-snapper.h index 932b62dac..5526040f3 100644 --- a/src/object-snapper.h +++ b/src/object-snapper.h @@ -1,10 +1,6 @@ #ifndef SEEN_OBJECT_SNAPPER_H #define SEEN_OBJECT_SNAPPER_H - -/** - * \file object-snapper.h - * \brief Snapping things to objects. - * +/* * Authors: * Carl Hetherington <inkscape@carlh.net> * Diederik van Lierop <mail@diedenrezi.nl> @@ -26,6 +22,9 @@ struct SPObject; namespace Inkscape { +/** + * Snapping things to objects. + */ class ObjectSnapper : public Snapper { diff --git a/src/registrytool.h b/src/registrytool.h index e98f2df38..7bb00b8f5 100644 --- a/src/registrytool.h +++ b/src/registrytool.h @@ -1,12 +1,6 @@ -#ifndef __REGISTRYTOOL_H__ -#define __REGISTRYTOOL_H__ -/** - * Inkscape Registry Tool - * - * This simple tool is intended for allowing Inkscape to append subdirectories - * to its path. This will allow extensions and other files to be accesses - * without explicit user intervention. - * +#ifndef SEEN_REGISTRYTOOL_H +#define SEEN_REGISTRYTOOL_H +/* * Authors: * Bob Jamison * @@ -30,6 +24,13 @@ #include <string> #include <glibmm.h> +/** + * Inkscape Registry Tool + * + * This simple tool is intended for allowing Inkscape to append subdirectories + * to its path. This will allow extensions and other files to be accesses + * without explicit user intervention. + */ class RegistryTool { public: @@ -53,5 +54,5 @@ public: }; -#endif /* __REGISTRYTOOL_H__ */ +#endif // SEEN_REGISTRYTOOL_H diff --git a/src/rubberband.h b/src/rubberband.h index 0761d8066..1b71f9ae2 100644 --- a/src/rubberband.h +++ b/src/rubberband.h @@ -1,10 +1,6 @@ #ifndef SEEN_RUBBERBAND_H #define SEEN_RUBBERBAND_H - -/** - * \file src/rubberband.h - * \brief Rubberbanding selector - * +/* * Authors: * Lauris Kaplinski <lauris@kaplinski.com> * Carl Hetherington <inkscape@carlh.net> @@ -34,6 +30,9 @@ enum { namespace Inkscape { +/** + * Rubberbanding selector. + */ class Rubberband { public: diff --git a/src/selection.h b/src/selection.h index 081776427..a151be500 100644 --- a/src/selection.h +++ b/src/selection.h @@ -1,9 +1,6 @@ #ifndef SEEN_INKSCAPE_SELECTION_H #define SEEN_INKSCAPE_SELECTION_H - -/** \file - * Inkscape::Selection: per-desktop selection container - * +/* * Authors: * Lauris Kaplinski <lauris@kaplinski.com> * MenTaLguY <mental@rydia.net> @@ -43,7 +40,7 @@ class Node; namespace Inkscape { /** - * @brief The set of selected SPObjects for a given desktop. + * The set of selected SPObjects for a given desktop. * * This class represents the set of selected SPItems for a given * SPDesktop. @@ -74,49 +71,49 @@ public: ~Selection(); /** - * @brief Returns the desktop the selection is bound to + * Returns the desktop the selection is bound to * * @return the desktop the selection is bound to */ SPDesktop *desktop() { return _desktop; } /** - * @brief Returns active layer for selection (currentLayer or its parent) + * Returns active layer for selection (currentLayer or its parent). * * @return layer item the selection is bound to */ SPObject *activeContext(); /** - * @brief Add an SPObject to the set of selected objects + * Add an SPObject to the set of selected objects. * * @param obj the SPObject to add */ void add(SPObject *obj, bool persist_selection_context = false); /** - * @brief Add an XML node's SPObject to the set of selected objects + * Add an XML node's SPObject to the set of selected objects. * * @param the xml node of the item to add */ void add(XML::Node *repr) { add(_objectForXMLNode(repr)); } /** - * @brief Set the selection to a single specific object + * Set the selection to a single specific object. * * @param obj the object to select */ void set(SPObject *obj, bool persist_selection_context = false); /** - * @brief Set the selection to an XML node's SPObject + * Set the selection to an XML node's SPObject. * * @param repr the xml node of the item to select */ void set(XML::Node *repr) { set(_objectForXMLNode(repr)); } /** - * @brief Removes an item from the set of selected objects + * Removes an item from the set of selected objects. * * It is ok to call this method for an unselected item. * @@ -125,14 +122,14 @@ public: void remove(SPObject *obj); /** - * @brief Removes an item if selected, adds otherwise + * Removes an item if selected, adds otherwise. * * @param item the item to unselect */ void toggle(SPObject *obj); /** - * @brief Removes an item from the set of selected objects + * Removes an item from the set of selected objects. * * It is ok to call this method for an unselected item. * @@ -141,27 +138,27 @@ public: void remove(XML::Node *repr) { remove(_objectForXMLNode(repr)); } /** - * @brief Selects exactly the specified objects + * Selects exactly the specified objects. * * @param objs the objects to select */ void setList(GSList const *objs); /** - * @brief Adds the specified objects to selection, without deselecting first + * Adds the specified objects to selection, without deselecting first. * * @param objs the objects to select */ void addList(GSList const *objs); /** - * @brief Clears the selection and selects the specified objects + * Clears the selection and selects the specified objects. * * @param repr a list of xml nodes for the items to select */ void setReprList(GSList const *reprs); - /** \brief Add items from an STL iterator range to the selection + /** Add items from an STL iterator range to the selection. * \param from the begin iterator * \param to the end iterator */ @@ -176,102 +173,106 @@ public: } /** - * @brief Unselects all selected objects. + * Unselects all selected objects.. */ void clear(); /** - * @brief Returns true if no items are selected + * Returns true if no items are selected. */ bool isEmpty() const { return _objs == NULL; } /** - * @brief Returns true if the given object is selected + * Returns true if the given object is selected. */ bool includes(SPObject *obj) const; /** - * @brief Returns true if the given item is selected + * Returns true if the given item is selected. */ bool includes(XML::Node *repr) const { return includes(_objectForXMLNode(repr)); } /** - * @brief Returns a single selected object + * Returns a single selected object. * * @return NULL unless exactly one object is selected */ SPObject *single(); /** - * @brief Returns a single selected item + * Returns a single selected item. * * @return NULL unless exactly one object is selected */ SPItem *singleItem(); /** - * @brief Returns a single selected object's xml node + * Returns a single selected object's xml node. * * @return NULL unless exactly one object is selected */ XML::Node *singleRepr(); - /** @brief Returns the list of selected objects */ + /** Returns the list of selected objects. */ GSList const *list(); - /** @brief Returns the list of selected SPItems */ + /** Returns the list of selected SPItems. */ GSList const *itemList(); - /** @brief Returns a list of the xml nodes of all selected objects */ + /** Returns a list of the xml nodes of all selected objects. */ /// \todo only returns reprs of SPItems currently; need a separate /// method for that GSList const *reprList(); - /** @brief Returns a list of all perspectives which have a 3D box in the current selection + /** Returns a list of all perspectives which have a 3D box in the current selection. (these may also be nested in groups) */ std::list<Persp3D *> const perspList(); - /** @brief Returns a list of all 3D boxes in the current selection which are associated to @c - persp. If @c pers is @c NULL, return all selected boxes. - */ + /** + * Returns a list of all 3D boxes in the current selection which are associated to @c + * persp. If @c pers is @c NULL, return all selected boxes. + */ std::list<SPBox3D *> const box3DList(Persp3D *persp = NULL); - /** @brief Returns the number of layers in which there are selected objects */ + /** Returns the number of layers in which there are selected objects. */ guint numberOfLayers(); - /** @brief Returns the number of parents to which the selected objects belong */ + /** Returns the number of parents to which the selected objects belong. */ guint numberOfParents(); - /** @brief Returns the bounding rectangle of the selection */ + /** Returns the bounding rectangle of the selection. */ Geom::OptRect bounds(SPItem::BBoxType type) const; Geom::OptRect visualBounds() const; Geom::OptRect geometricBounds() const; - /** @brief Returns either the visual or geometric bounding rectangle of the selection, based on the - * preferences specified for the selector tool */ + + /** + * Returns either the visual or geometric bounding rectangle of the selection, based on the + * preferences specified for the selector tool + */ Geom::OptRect preferredBounds() const; /// Returns the bounding rectangle of the selectionin document coordinates. Geom::OptRect documentBounds(SPItem::BBoxType type) const; /** - * @brief Returns the rotation/skew center of the selection + * Returns the rotation/skew center of the selection. */ boost::optional<Geom::Point> center() const; /** - * @brief Gets the selection's snap points. + * Gets the selection's snap points. * @return Selection's snap points */ std::vector<Inkscape::SnapCandidatePoint> getSnapPoints(SnapPreferences const *snapprefs) const; /** - * @brief Gets the snap points of a selection that form a convex hull. + * Gets the snap points of a selection that form a convex hull. * @return Selection's convex hull points */ std::vector<Inkscape::SnapCandidatePoint> getSnapPointsConvexHull(SnapPreferences const *snapprefs) const; /** - * @brief Connects a slot to be notified of selection changes + * Connects a slot to be notified of selection changes. * * This method connects the given slot such that it will * be called upon any change in the set of selected objects. @@ -285,8 +286,7 @@ public: } /** - * @brief Connects a slot to be notified of selected - * object modifications + * Connects a slot to be notified of selected object modifications. * * This method connects the given slot such that it will * receive notifications whenever any selected item is @@ -303,36 +303,36 @@ public: } private: - /** @brief no copy */ + /** no copy. */ Selection(Selection const &); - /** @brief no assign */ + /** no assign. */ void operator=(Selection const &); - /** @brief Issues modification notification signals */ + /** Issues modification notification signals. */ static gboolean _emit_modified(Selection *selection); - /** @brief Schedules an item modification signal to be sent */ + /** Schedules an item modification signal to be sent. */ void _schedule_modified(SPObject *obj, guint flags); - /** @brief Issues modified selection signal */ + /** Issues modified selection signal. */ void _emitModified(guint flags); - /** @brief Issues changed selection signal */ + /** Issues changed selection signal. */ void _emitChanged(bool persist_selection_context = false); void _invalidateCachedLists(); - /** @brief unselect all descendants of the given item */ + /** unselect all descendants of the given item. */ void _removeObjectDescendants(SPObject *obj); - /** @brief unselect all ancestors of the given item */ + /** unselect all ancestors of the given item. */ void _removeObjectAncestors(SPObject *obj); - /** @brief clears the selection (without issuing a notification) */ + /** clears the selection (without issuing a notification). */ void _clear(); - /** @brief adds an object (without issuing a notification) */ + /** adds an object (without issuing a notification). */ void _add(SPObject *obj); - /** @brief removes an object (without issuing a notification) */ + /** removes an object (without issuing a notification). */ void _remove(SPObject *obj); - /** @brief returns the SPObject corresponding to an xml node (if any) */ + /** returns the SPObject corresponding to an xml node (if any). */ SPObject *_objectForXMLNode(XML::Node *repr) const; - /** @brief Releases an active layer object that is being removed */ + /** Releases an active layer object that is being removed. */ void _releaseContext(SPObject *obj); mutable GSList *_objs; diff --git a/src/snap-candidate.h b/src/snap-candidate.h index 43082c010..5302b49c9 100644 --- a/src/snap-candidate.h +++ b/src/snap-candidate.h @@ -2,9 +2,10 @@ #define SEEN_SNAP_CANDIDATE_H /** - * \file snap-candidate.h - * \brief some utility classes to store various kinds of snap candidates. - * + * @file + * Some utility classes to store various kinds of snap candidates. + */ +/* * Authors: * Diederik van Lierop <mail@diedenrezi.nl> * diff --git a/src/snap-enums.h b/src/snap-enums.h index d28f11314..15d35092c 100644 --- a/src/snap-enums.h +++ b/src/snap-enums.h @@ -1,10 +1,6 @@ #ifndef SNAPENUMS_H_ #define SNAPENUMS_H_ - -/** - * \file snap-enums.h - * \brief enumerations of snap source types and snap target types - * +/* * Authors: * Diederik van Lierop <mail@diedenrezi.nl> * @@ -15,6 +11,9 @@ namespace Inkscape { +/** + * enumerations of snap source types and snap target types. + */ enum SnapSourceType { SNAPSOURCE_UNDEFINED = 0, //------------------------------------------------------------------- diff --git a/src/snap-preferences.h b/src/snap-preferences.h index 9f126d791..8044d0aa7 100644 --- a/src/snap-preferences.h +++ b/src/snap-preferences.h @@ -1,10 +1,7 @@ #ifndef SNAPPREFERENCES_H_ #define SNAPPREFERENCES_H_ -/** - * \file snap-preferences.cpp - * \brief Storing of snapping preferences - * +/* * Authors: * Diederik van Lierop <mail@diedenrezi.nl> * @@ -19,6 +16,9 @@ namespace Inkscape { +/** + * Storing of snapping preferences. + */ class SnapPreferences { public: diff --git a/src/sp-gradient.h b/src/sp-gradient.h index c92d07fd3..e6d5b5e60 100644 --- a/src/sp-gradient.h +++ b/src/sp-gradient.h @@ -1,9 +1,6 @@ #ifndef SEEN_SP_GRADIENT_H #define SEEN_SP_GRADIENT_H - -/** \file - * SVG <stop> <linearGradient> and <radialGradient> implementation - * +/* * Authors: * Lauris Kaplinski <lauris@kaplinski.com> * Johan Engelen <j.b.c.engelen@ewi.utwente.nl> diff --git a/src/sp-object.h b/src/sp-object.h index a4220e720..3999dc622 100644 --- a/src/sp-object.h +++ b/src/sp-object.h @@ -1,9 +1,7 @@ #ifndef SP_OBJECT_H_SEEN #define SP_OBJECT_H_SEEN -/** \file - * Abstract base class for all nodes - * +/* * Authors: * Lauris Kaplinski <lauris@kaplinski.com> * Jon A. Cruz <jon@joncruz.org> @@ -134,7 +132,11 @@ SPObject *sp_object_unref(SPObject *object, SPObject *owner=NULL); SPObject *sp_object_href(SPObject *object, gpointer owner); SPObject *sp_object_hunref(SPObject *object, gpointer owner); -/// A refcounting tree node object. + +/** + * Abstract base class for all nodes. + * A refcounting tree node object. + */ class SPObject : public GObject { public: enum CollectionPolicy { diff --git a/src/sp-offset.h b/src/sp-offset.h index a229e0bb6..ec8c2cf29 100644 --- a/src/sp-offset.h +++ b/src/sp-offset.h @@ -1,9 +1,6 @@ -#ifndef __SP_OFFSET_H__ -#define __SP_OFFSET_H__ - -/** \file - * SPOffset class. - * +#ifndef SEEN_SP_OFFSET_H +#define SEEN_SP_OFFSET_H +/* * Authors: * Mitsuru Oka <oka326@parkcity.ne.jp> * Lauris Kaplinski <lauris@kaplinski.com> diff --git a/src/sp-spiral.h b/src/sp-spiral.h index 7b31b19d8..6da7c38a4 100644 --- a/src/sp-spiral.h +++ b/src/sp-spiral.h @@ -1,9 +1,6 @@ -#ifndef __SP_SPIRAL_H__ -#define __SP_SPIRAL_H__ - -/** \file - * SPSpiral: <sodipodi:spiral> implementation - * +#ifndef SEEN_SP_SPIRAL_H +#define SEEN_SP_SPIRAL_H +/* * Authors: * Mitsuru Oka <oka326@parkcity.ne.jp> * Lauris Kaplinski <lauris@kaplinski.com> @@ -88,4 +85,4 @@ bool sp_spiral_is_invalid (SPSpiral const *spiral); -#endif +#endif // SEEN_SP_SPIRAL_H diff --git a/src/svg-view-widget.h b/src/svg-view-widget.h index 46def687b..0c2c651ad 100644 --- a/src/svg-view-widget.h +++ b/src/svg-view-widget.h @@ -1,9 +1,6 @@ #ifndef SEEN_SP_SVG_VIEW_WIDGET_H #define SEEN_SP_SVG_VIEW_WIDGET_H - -/** \file - * SPSVGView, SPSVGSPViewWidget: Generic SVG view and widget - * +/* * Authors: * Lauris Kaplinski <lauris@kaplinski.com> * Jon A. Cruz <jon@joncruz.org> diff --git a/src/svg-view.h b/src/svg-view.h index 838a95b03..5e830eb00 100644 --- a/src/svg-view.h +++ b/src/svg-view.h @@ -1,9 +1,6 @@ -#ifndef __SP_SVG_VIEW_H__ -#define __SP_SVG_VIEW_H__ - -/** \file - * SPSVGView, SPSVGSPViewWidget: Generic SVG view and widget - * +#ifndef SEEN_SP_SVG_VIEW_H +#define SEEN_SP_SVG_VIEW_H +/* * Authors: * Lauris Kaplinski <lauris@kaplinski.com> * Ralf Stephan <ralf@ark.in-berlin.de> @@ -61,7 +58,7 @@ private: virtual void onDocumentResized (double, double); }; -#endif +#endif // SEEN_SP_SVG_VIEW_H /* Local Variables: diff --git a/src/svg/path-string.h b/src/svg/path-string.h index 1d057519f..f959b25b7 100644 --- a/src/svg/path-string.h +++ b/src/svg/path-string.h @@ -1,6 +1,4 @@ -/** - * Inkscape::SVG::PathString - builder for SVG path strings - * +/* * Copyright 2007 MenTaLguY <mental@rydia.net> * Copyright 2008 Jasper van de Gronde <th.v.d.gronde@hccnet.nl> * @@ -25,6 +23,9 @@ namespace Inkscape { namespace SVG { +/** + * Builder for SVG path strings. + */ class PathString { public: PathString(); diff --git a/src/trace/siox.h b/src/trace/siox.h index 57c78bd5a..dd7f9422f 100644 --- a/src/trace/siox.h +++ b/src/trace/siox.h @@ -1,6 +1,6 @@ -#ifndef __SIOX_H__ -#define __SIOX_H__ -/** +#ifndef SEEN_SIOX_H +#define SEEN_SIOX_H +/* * Copyright 2005, 2006 by Gerald Friedland, Kristian Jantz and Lars Knipping * * Conversion to C++ for Inkscape by Bob Jamison @@ -18,7 +18,7 @@ * limitations under the License. */ -/** +/* * Note by Bob Jamison: * After translating the siox.org Java API to C++ and receiving an * education into this wonderful code, I began again, @@ -660,10 +660,7 @@ private: } // namespace siox } // namespace org -#endif /* __SIOX_H__ */ +#endif // SEEN_SIOX_H //######################################################################## //# E N D O F F I L E //######################################################################## - - - diff --git a/src/trace/trace.h b/src/trace/trace.h index 2c9922e10..45b18385f 100644 --- a/src/trace/trace.h +++ b/src/trace/trace.h @@ -1,7 +1,4 @@ -/** - * A generic interface for plugging different - * autotracers into Inkscape. - * +/* * Authors: * Bob Jamison <rjamison@titan.com> * @@ -110,7 +107,8 @@ private: /** - * + * A generic interface for plugging different + * autotracers into Inkscape. */ class TracingEngine { 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 /* diff --git a/src/undo-stack-observer.h b/src/undo-stack-observer.h index 5bf405f7f..f4d67e841 100644 --- a/src/undo-stack-observer.h +++ b/src/undo-stack-observer.h @@ -1,8 +1,4 @@ -/** - * Undo stack observer interface - * - * Observes undo, redo, and undo log commit events. - * +/* * Authors: * David Yip <yipdw@rose-hulman.edu> * @@ -11,8 +7,8 @@ * Released under GNU GPL, read the file 'COPYING' for more information */ -#ifndef __UNDO_COMMIT_OBSERVER_H__ -#define __UNDO_COMMIT_OBSERVER_H__ +#ifndef SEEN_UNDO_COMMIT_OBSERVER_H +#define SEEN_UNDO_COMMIT_OBSERVER_H #include "gc-managed.h" @@ -74,4 +70,4 @@ public: } -#endif +#endif // SEEN_UNDO_COMMIT_OBSERVER_H @@ -1,7 +1,4 @@ -/** - * \file - * \brief Classes for representing and manipulating URIs as per RFC 2396. - * +/* * Authors: * MenTaLguY <mental@rydia.net> * Jon A. Cruz <jon@joncruz.org> @@ -21,7 +18,9 @@ namespace Inkscape { -/** \brief Represents an URI as per RFC 2396. */ +/** + * Represents an URI as per RFC 2396. + */ class URI { public: URI(URI const &uri); diff --git a/src/util/enums.h b/src/util/enums.h index 824da3f75..34138ad21 100644 --- a/src/util/enums.h +++ b/src/util/enums.h @@ -1,6 +1,4 @@ -/** - * \brief Simplified management of enumerations of svg items with UI labels - * +/* * Authors: * Nicholas Bishop <nicholasbishop@gmail.com> * Johan Engelen <j.b.c.engelen@ewi.utwente.nl> @@ -9,16 +7,6 @@ * * Released under GNU GPL. Read the file 'COPYING' for more information. */ - -/* IMPORTANT - * When initializing the EnumData struct, you cannot use _(...) to translate strings. - * Instead, one must use N_(...) and do the translation every time the string is retreived. - * - * Note that get_id_from_key and get_id_from_label return 0 if it cannot find an entry for that key string - * Note that get_label and get_key return an empty string when the requested id is not in the list. - */ - - #ifndef INKSCAPE_UTIL_ENUMS_H #define INKSCAPE_UTIL_ENUMS_H @@ -27,6 +15,12 @@ namespace Inkscape { namespace Util { +/** + * Simplified management of enumerations of svg items with UI labels. + * IMPORTANT: + * When initializing the EnumData struct, you cannot use _(...) to translate strings. + * Instead, one must use N_(...) and do the translation every time the string is retreived. + */ template<typename E> struct EnumData { @@ -37,6 +31,12 @@ struct EnumData const Glib::ustring empty_string(""); +/** + * Simplified management of enumerations of svg items with UI labels. + * + * @note that get_id_from_key and get_id_from_label return 0 if it cannot find an entry for that key string. + * @note that get_label and get_key return an empty string when the requested id is not in the list. + */ template<typename E> class EnumDataConverter { public: diff --git a/src/util/list.h b/src/util/list.h index e65aa849b..de5a458e9 100644 --- a/src/util/list.h +++ b/src/util/list.h @@ -1,6 +1,4 @@ -/** \file - * Inkscape::Util::List - managed linked list - * +/* * Authors: * MenTaLguY <mental@rydia.net> * @@ -227,7 +225,8 @@ public: MutableList const &); }; -/** @brief Creates a (non-empty) linked list. +/** + * Creates a (non-empty) linked list. * * Creates a new linked list with a copy of the given value (\a first) * in its first element; the remainder of the list will be the list @@ -241,7 +240,7 @@ public: * @param first the value for the first element of the list * @param rest the rest of the list; may be an empty list * - * @returns a new list + * @return a new list * * @see List<> * @see is_empty<> @@ -254,7 +253,8 @@ inline List<T> cons(typename Traits::Reference<T>::RValue first, return List<T>(first, rest); } -/** @brief Creates a (non-empty) linked list whose tail can be exchanged +/** + * Creates a (non-empty) linked list whose tail can be exchanged * for another. * * Creates a new linked list, but one whose tail can be exchanged for @@ -274,7 +274,7 @@ inline List<T> cons(typename Traits::Reference<T>::RValue first, * @param first the value for the first element of the list * @param rest the rest of the list; may be an empty list * - * @returns a new list + * @return a new list */ template <typename T> inline MutableList<T> cons(typename Traits::Reference<T>::RValue first, @@ -283,19 +283,21 @@ inline MutableList<T> cons(typename Traits::Reference<T>::RValue first, return MutableList<T>(first, rest); } -/** @brief Returns true if the given list is empty. +/** + * Returns true if the given list is empty. * * Returns true if the given list is empty. This is equivalent * to !list. * * @param list the list * - * @returns true if the list is empty, false otherwise. + * @return true if the list is empty, false otherwise. */ template <typename T> inline bool is_empty(List<T> const &list) { return !list._cell; } -/** @brief Returns the first value in a linked list. +/** + * Returns the first value in a linked list. * * Returns a reference to the first value in the list. This * corresponds to the value of the first argument passed to cons(). @@ -314,14 +316,15 @@ inline bool is_empty(List<T> const &list) { return !list._cell; } * * @param list the list; cannot be empty * - * @returns a reference to the first value in the list + * @return a reference to the first value in the list */ template <typename T> inline typename List<T>::reference first(List<T> const &list) { return list._cell->value; } -/** @brief Returns the remainder of a linked list after the first element. +/** + * Returns the remainder of a linked list after the first element. * * Returns the remainder of the list after the first element (its "tail"). * @@ -334,14 +337,15 @@ inline typename List<T>::reference first(List<T> const &list) { * * @param list the list; cannot be empty * - * @returns the remainder of the list + * @return the remainder of the list */ template <typename T> inline List<T> const &rest(List<T> const &list) { return reinterpret_cast<List<T> const &>(list._cell->next); } -/** @brief Returns a reference to the remainder of a linked list after +/** + * Returns a reference to the remainder of a linked list after * the first element. * * Returns a reference to the remainder of the list after the first @@ -359,14 +363,15 @@ inline List<T> const &rest(List<T> const &list) { * * @param list the list; cannot be empty * - * @returns a reference to the remainder of the list + * @return a reference to the remainder of the list */ template <typename T> inline MutableList<T> &rest(MutableList<T> const &list) { return reinterpret_cast<MutableList<T> &>(list._cell->next); } -/** @brief Sets a new tail for an existing linked list. +/** + * Sets a new tail for an existing linked list. * * Sets the tail of the given MutableList<>, corresponding to the * second argument of cons(). @@ -380,7 +385,7 @@ inline MutableList<T> &rest(MutableList<T> const &list) { * @param list the list; cannot be empty * @param rest the new tail; corresponds to the second argument of cons() * - * @returns the new tail + * @return the new tail */ template <typename T> inline MutableList<T> const &set_rest(MutableList<T> const &list, diff --git a/src/verbs.h b/src/verbs.h index 7c16ff530..d2b0acd41 100644 --- a/src/verbs.h +++ b/src/verbs.h @@ -1,9 +1,6 @@ #ifndef SEEN_SP_VERBS_H #define SEEN_SP_VERBS_H - -/** \file - * \brief Frontend to actions - * +/* * Author: * Lauris Kaplinski <lauris@kaplinski.com> * Ted Gould <ted@gould.cx> @@ -34,9 +31,11 @@ class View; } // namespace UI } // namespace Inkscape -/** \brief This anonymous enum is used to provide a list of the Verbs - which are defined staticly in the verb files. There may be - other verbs which are defined dynamically also. */ +/** + * This anonymous enum is used to provide a list of the Verbs + * which are defined staticly in the verb files. There may be + * other verbs which are defined dynamically also. + */ enum { /* Header */ SP_VERB_INVALID, /**< A dummy verb to represent doing something wrong. */ @@ -312,19 +311,20 @@ gchar *sp_action_get_title (const SPAction *action); namespace Inkscape { -/** \brief A class to represent things the user can do. In many ways - these are 'action factories' as they are used to create - individual actions that are based on a given view. -*/ +/** + * A class to represent things the user can do. In many ways + * these are 'action factories' as they are used to create + * individual actions that are based on a given view. + */ class Verb { private: - /** \brief An easy to use defition of the table of verbs by code. */ + /** An easy to use defition of the table of verbs by code. */ typedef std::map<unsigned int, Inkscape::Verb *> VerbTable; - /** \brief A table of all the dynamically created verbs. */ + /** A table of all the dynamically created verbs. */ static VerbTable _verbs; - /** \brief The table of statically created verbs which are mostly + /** The table of statically created verbs which are mostly 'base verbs'. */ static Verb * _base_verbs[SP_VERB_LAST + 1]; /* Plus one because there is an entry for SP_VERB_LAST */ @@ -343,72 +343,84 @@ private: } }; - /** \brief An easy to use definition of the table of verbs by ID. */ + /** An easy to use definition of the table of verbs by ID. */ typedef std::map<gchar const *, Verb *, ltstr> VerbIDTable; - /** \brief Quick lookup of verbs by ID */ + /** Quick lookup of verbs by ID */ static VerbIDTable _verb_ids; - /** \brief A simple typedef to make using the action table easier. */ + /** A simple typedef to make using the action table easier. */ typedef std::map<Inkscape::UI::View::View *, SPAction *> ActionTable; - /** \brief A list of all the actions that have been created for this + /** A list of all the actions that have been created for this verb. It is referenced by the view that they are created for. */ ActionTable * _actions; - /** \brief A unique textual ID for the verb. */ + /** A unique textual ID for the verb. */ gchar const * _id; - /** \brief The full name of the verb. (shown on menu entries) */ + /** The full name of the verb. (shown on menu entries) */ gchar const * _name; - /** \brief Tooltip for the verb. */ + /** Tooltip for the verb. */ gchar const * _tip; gchar * _full_tip; // includes shortcut unsigned int _shortcut; - /** \brief Name of the image that represents the verb. */ + /** Name of the image that represents the verb. */ gchar const * _image; - /** \brief Unique numerical representation of the verb. In most cases - it is a value from the anonymous enum at the top of this - file. */ + /** + * Unique numerical representation of the verb. In most cases + * it is a value from the anonymous enum at the top of this + * file. + */ unsigned int _code; - /** \brief Whether this verb is set to default to sensitive or - insensitive when new actions are created. */ + /** + * Whether this verb is set to default to sensitive or + * insensitive when new actions are created. + */ bool _default_sensitive; protected: - /** \brief Allows for preliminary setting of the \c _default_sensitive - value without effecting existing actions - \param in_val New value - - This function is mostly used at initialization where there are - not actions to effect. I can't think of another case where it - should be used. - */ + + /** + * Allows for preliminary setting of the \c _default_sensitive + * value without effecting existing actions. + * This function is mostly used at initialization where there are + * not actions to effect. I can't think of another case where it + * should be used. + * + * @param in_val New value. + */ bool set_default_sensitive (bool in_val) { return _default_sensitive = in_val; } + public: - /** \brief Accessor to get the \c _default_sensitive value */ + + /** Accessor to get the \c _default_sensitive value. */ bool get_default_sensitive (void) { return _default_sensitive; } -public: - /** \brief Accessor to get the internal variable. */ + /** Accessor to get the internal variable. */ unsigned int get_code (void) { return _code; } - /** \brief Accessor to get the internal variable. */ + + /** Accessor to get the internal variable. */ gchar const * get_id (void) { return _id; } - /** \brief Accessor to get the internal variable. */ + + /** Accessor to get the internal variable. */ gchar const * get_name (void) { return _name; } - /** \brief Accessor to get the internal variable. */ + + /** Accessor to get the internal variable. */ gchar const * get_tip (void) ; - /** \brief Accessor to get the internal variable. */ + + /** Accessor to get the internal variable. */ gchar const * get_image (void) { return _image; } - /** \brief Set the name after initialization. */ + /** Set the name after initialization. */ gchar const * set_name (gchar const * name) { _name = name; return _name; } - /** \brief Set the tooltip after initialization. */ + + /** Set the tooltip after initialization. */ gchar const * set_tip (gchar const * tip) { _tip = tip; return _tip; } protected: @@ -416,25 +428,28 @@ protected: virtual SPAction *make_action (Inkscape::UI::View::View *view); public: - /** \brief Inititalizes the Verb with the parameters - \param code Goes to \c _code - \param id Goes to \c _id - \param name Goes to \c _name - \param tip Goes to \c _tip - \param image Goes to \c _image - - This function also sets \c _actions to NULL. - - \warning NO DATA IS COPIED BY CALLING THIS FUNCTION. - - In many respects this is very bad object oriented design, but it - is done for a reason. All verbs today are of two types: 1) static - or 2) created for extension. In the static case all of the - strings are constants in the code, and thus don't really need to - be copied. In the extensions case the strings are identical to - the ones already created in the extension object, copying them - would be a waste of memory. - */ + + /** + * Inititalizes the Verb with the parameters. + * + * This function also sets \c _actions to NULL. + * + * @warning NO DATA IS COPIED BY CALLING THIS FUNCTION. + * + * In many respects this is very bad object oriented design, but it + * is done for a reason. All verbs today are of two types: 1) static + * or 2) created for extension. In the static case all of the + * strings are constants in the code, and thus don't really need to + * be copied. In the extensions case the strings are identical to + * the ones already created in the extension object, copying them + * would be a waste of memory. + * + * @param code Goes to \c _code. + * @param id Goes to \c _id. + * @param name Goes to \c _name. + * @param tip Goes to \c _tip. + * @param image Goes to \c _image. + */ Verb(const unsigned int code, gchar const * id, gchar const * name, @@ -461,16 +476,19 @@ public: private: static Verb * get_search (unsigned int code); public: - /** \brief A function to turn a code into a verb. - \param code The code to be translated - \return A pointer to a verb object or a NULL if not found. - - This is an inline function to translate the codes which are - static quickly. This should optimize into very quick code - everywhere which hard coded \c codes are used. In the case - where the \c code is not static the \c get_search function - is used. - */ + + /** + * A function to turn a code into a verb. + * + * This is an inline function to translate the codes which are + * static quickly. This should optimize into very quick code + * everywhere which hard coded \c codes are used. In the case + * where the \c code is not static the \c get_search function + * is used. + * + * @param code The code to be translated + * @return A pointer to a verb object or a NULL if not found. + */ static Verb * get (unsigned int code) { if (code <= SP_VERB_LAST) { return _base_verbs[code]; @@ -488,13 +506,16 @@ public: // Yes, multiple public, protected and private sections are bad. We'll clean that up later protected: - /** \brief Returns the size of the internal base verb array. - \return The size in elements of the internal base array. - This is an inline function intended for testing. This should normally not be used. - For testing, a subclass that returns this value can be created to verify that the - length matches the enum values, etc. - */ + /** + * Returns the size of the internal base verb array. + * + * This is an inline function intended for testing. This should normally not be used. + * For testing, a subclass that returns this value can be created to verify that the + * length matches the enum values, etc. + * + * @return The size in elements of the internal base array. + */ static int _getBaseListSize(void) {return G_N_ELEMENTS(_base_verbs);} public: diff --git a/src/widgets/paint-selector.h b/src/widgets/paint-selector.h index 25ba4aa97..69cfa602e 100644 --- a/src/widgets/paint-selector.h +++ b/src/widgets/paint-selector.h @@ -1,7 +1,6 @@ #ifndef SEEN_SP_PAINT_SELECTOR_H #define SEEN_SP_PAINT_SELECTOR_H - -/** \file +/* * Generic paint selector widget * * Authors: @@ -32,7 +31,9 @@ class SPStyle; #define SP_IS_PAINT_SELECTOR(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), SP_TYPE_PAINT_SELECTOR)) #define SP_IS_PAINT_SELECTOR_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), SP_TYPE_PAINT_SELECTOR)) -/// Generic paint selector widget +/** + * Generic paint selector widget. + */ struct SPPaintSelector { GtkVBox vbox; |