Code

Added some requested documentaion.
authorglimmer07 <glimmer07@users.sourceforge.net>
Sun, 12 Jul 2009 16:59:19 +0000 (16:59 +0000)
committerglimmer07 <glimmer07@users.sourceforge.net>
Sun, 12 Jul 2009 16:59:19 +0000 (16:59 +0000)
src/selection.h

index ecb1ef45e5399780cbe4812bf52a1bb18b6517ce..8eacf0d46c61969a11f211e5c4422abe3edc8aec 100644 (file)
@@ -249,14 +249,16 @@ public:
     /**
      * @brief Returns the bounding rectangle of the selection
      *
-     * \todo how is this different from bounds()?
+     * Gives the coordinates in internal format, does not match onscreen guides.
+     * (0,0 is the upper left corner, not the lower left corner)
      */
     NRRect *boundsInDocument(NRRect *dest, SPItem::BBoxType type = SPItem::APPROXIMATE_BBOX) const;
 
     /**
      * @brief Returns the bounding rectangle of the selection
      *
-     * \todo how is this different from bounds()?
+     * Gives the coordinates in internal format, does not match onscreen guides.
+     * (0,0 is the upper left corner, not the lower left corner)
      */
     Geom::OptRect boundsInDocument(SPItem::BBoxType type = SPItem::APPROXIMATE_BBOX) const;