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/lpegroupbbox.cpp | |
| 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/lpegroupbbox.cpp')
| -rw-r--r-- | src/live_effects/lpegroupbbox.cpp | 15 |
1 files changed, 7 insertions, 8 deletions
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; |
