diff options
| author | Jon A. Cruz <jon@joncruz.org> | 2011-10-03 07:24:15 +0000 |
|---|---|---|
| committer | Jon A. Cruz <jon@joncruz.org> | 2011-10-03 07:24:15 +0000 |
| commit | 6343a24c5cd0a998e00ae05fc6abe2081be21c71 (patch) | |
| tree | a7dd4dab52017785c7fe15e79fb0b2836ff8e95a /src/live_effects | |
| parent | Another minor pass of Doxygen cleanup. (diff) | |
| download | inkscape-6343a24c5cd0a998e00ae05fc6abe2081be21c71.tar.gz inkscape-6343a24c5cd0a998e00ae05fc6abe2081be21c71.zip | |
Doxygen cleanup.
(bzr r10660)
Diffstat (limited to 'src/live_effects')
| -rw-r--r-- | src/live_effects/lpe-circle_with_radius.cpp | 5 | ||||
| -rw-r--r-- | src/live_effects/lpe-extrude.cpp | 6 | ||||
| -rw-r--r-- | src/live_effects/lpe-knot.cpp | 5 | ||||
| -rw-r--r-- | src/live_effects/lpe-perspective_path.cpp | 5 | ||||
| -rw-r--r-- | src/live_effects/lpe-powerstroke.cpp | 6 | ||||
| -rw-r--r-- | src/live_effects/lpe-recursiveskeleton.cpp | 6 | ||||
| -rw-r--r-- | src/live_effects/lpe-skeleton.cpp | 6 | ||||
| -rw-r--r-- | src/live_effects/lpe-sketch.cpp | 5 | ||||
| -rw-r--r-- | src/live_effects/lpegroupbbox.cpp | 15 |
9 files changed, 30 insertions, 29 deletions
diff --git a/src/live_effects/lpe-circle_with_radius.cpp b/src/live_effects/lpe-circle_with_radius.cpp index 4aec82377..8a32cd230 100644 --- a/src/live_effects/lpe-circle_with_radius.cpp +++ b/src/live_effects/lpe-circle_with_radius.cpp @@ -1,5 +1,6 @@ -/** @file - * @brief LPE effect that draws a circle based on two points and a radius +/** + * @file + * LPE effect that draws a circle based on two points and a radius. * - implementation */ /* Authors: diff --git a/src/live_effects/lpe-extrude.cpp b/src/live_effects/lpe-extrude.cpp index 8b5badf5f..61b61f7bf 100644 --- a/src/live_effects/lpe-extrude.cpp +++ b/src/live_effects/lpe-extrude.cpp @@ -1,6 +1,6 @@ -#define INKSCAPE_LPE_EXTRUDE_CPP -/** \file - * @brief LPE effect for extruding paths (making them "3D"). +/** + * @file + * LPE effect for extruding paths (making them "3D"). * */ /* Authors: diff --git a/src/live_effects/lpe-knot.cpp b/src/live_effects/lpe-knot.cpp index b025debb3..4c88ac315 100644 --- a/src/live_effects/lpe-knot.cpp +++ b/src/live_effects/lpe-knot.cpp @@ -1,5 +1,6 @@ -/** @file - * @brief LPE knot effect implementation +/** + * @file + * LPE knot effect implementation. */ /* Authors: * Jean-Francois Barraud <jf.barraud@gmail.com> diff --git a/src/live_effects/lpe-perspective_path.cpp b/src/live_effects/lpe-perspective_path.cpp index 58efe4ef5..9208d4aeb 100644 --- a/src/live_effects/lpe-perspective_path.cpp +++ b/src/live_effects/lpe-perspective_path.cpp @@ -1,5 +1,6 @@ -/** @file - * @brief LPE perspective path effect implementation. +/** + * @file + * LPE perspective path effect implementation. */ /* Authors: * Maximilian Albert <maximilian.albert@gmail.com> diff --git a/src/live_effects/lpe-powerstroke.cpp b/src/live_effects/lpe-powerstroke.cpp index 582ea2750..d9806b4d7 100644 --- a/src/live_effects/lpe-powerstroke.cpp +++ b/src/live_effects/lpe-powerstroke.cpp @@ -1,6 +1,6 @@ -#define INKSCAPE_LPE_POWERSTROKE_CPP -/** \file - * @brief PowerStroke LPE implementation. Creates curves with modifiable stroke width. +/** + * @file + * PowerStroke LPE implementation. Creates curves with modifiable stroke width. */ /* Authors: * Johan Engelen <j.b.c.engelen@alumnus.utwente.nl> diff --git a/src/live_effects/lpe-recursiveskeleton.cpp b/src/live_effects/lpe-recursiveskeleton.cpp index d78ad2fcb..ac8c112d6 100644 --- a/src/live_effects/lpe-recursiveskeleton.cpp +++ b/src/live_effects/lpe-recursiveskeleton.cpp @@ -1,7 +1,5 @@ -#define INKSCAPE_LPE_RECURSIVESKELETON_CPP -/** \file - * @brief - * +/** + * @file * Inspired by Hofstadter's 'Goedel Escher Bach', chapter V. */ /* Authors: diff --git a/src/live_effects/lpe-skeleton.cpp b/src/live_effects/lpe-skeleton.cpp index daf96aa13..08f31da7e 100644 --- a/src/live_effects/lpe-skeleton.cpp +++ b/src/live_effects/lpe-skeleton.cpp @@ -1,6 +1,6 @@ -#define INKSCAPE_LPE_SKELETON_CPP -/** \file - * @brief Minimal dummy LPE effect implementation, used as an example for a base +/** + * @file + * Minimal dummy LPE effect implementation, used as an example for a base * starting class when implementing new LivePathEffects. * * In vi, three global search-and-replaces will let you rename everything diff --git a/src/live_effects/lpe-sketch.cpp b/src/live_effects/lpe-sketch.cpp index b621f6eca..9cd6f1b57 100644 --- a/src/live_effects/lpe-sketch.cpp +++ b/src/live_effects/lpe-sketch.cpp @@ -1,5 +1,6 @@ -/** @file - * @brief LPE sketch effect implementation +/** + * @file + * LPE sketch effect implementation. */ /* Authors: * Jean-Francois Barraud <jf.barraud@gmail.com> diff --git a/src/live_effects/lpegroupbbox.cpp b/src/live_effects/lpegroupbbox.cpp index c241b9a4c..e2378265a 100644 --- a/src/live_effects/lpegroupbbox.cpp +++ b/src/live_effects/lpegroupbbox.cpp @@ -13,17 +13,16 @@ namespace Inkscape { namespace LivePathEffect { /** - * \brief Updates the \c boundingbox_X and \c boundingbox_Y values from the geometric bounding box of \c lpeitem. + * Updates the \c boundingbox_X and \c boundingbox_Y values from the geometric bounding box of \c lpeitem. * - * \pre lpeitem must have an existing geometric boundingbox (usually this is guaranteed when: \code SP_SHAPE(lpeitem)->curve != NULL \endcode ) - It's not possible to run LPEs on items without their original-d having a bbox. - * \param lpeitem This is not allowed to be NULL. - * \param absolute Determines whether the bbox should be calculated of the untransformed lpeitem (\c absolute = \c false) + * @pre lpeitem must have an existing geometric boundingbox (usually this is guaranteed when: \code SP_SHAPE(lpeitem)->curve != NULL \endcode ) + * It's not possible to run LPEs on items without their original-d having a bbox. + * @param lpeitem This is not allowed to be NULL. + * @param absolute Determines whether the bbox should be calculated of the untransformed lpeitem (\c absolute = \c false) * or of the transformed lpeitem (\c absolute = \c true) using sp_item_i2doc_affine. - * \post Updated values of boundingbox_X and boundingbox_Y. These intervals are set to empty intervals when the precondition is not met. + * @post Updated values of boundingbox_X and boundingbox_Y. These intervals are set to empty intervals when the precondition is not met. */ -void -GroupBBoxEffect::original_bbox(SPLPEItem *lpeitem, bool absolute) +void GroupBBoxEffect::original_bbox(SPLPEItem *lpeitem, bool absolute) { // Get item bounding box Geom::Affine transform; |
