[Kst] extragear/graphics/kst/src/libkstapp

[Duncan Hanson]

SVN commit 571501 by dhanson:

BUG:131738 revise documentation for kstgfxmousehandlerutils.cpp.

 M  +7 -7      kstgfxmousehandlerutils.h  


--- trunk/extragear/graphics/kst/src/libkstapp/kstgfxmousehandlerutils.h #571500:571501
@@ -22,19 +22,19 @@
 class QPoint;
 
 namespace KstGfxMouseHandlerUtils {
-    // from the line described by fromPoint and toPoint, returns the point on the line (and inside bounds) with the shortest distance to pos. pos and fromPoint must be inside bounds already.
+    // from the line described by fromPoint and toPoint, returns the point on the line (and inside bounds) with the shortest distance to pos. fromPoint must be inside bounds already.
     QPoint findNearestPtOnLine(const QPoint& fromPoint, const QPoint& toPoint, const QPoint& pos, const QRect &bounds);
-    // resizes the rect described by anchorPoint and movePoint to pos, keeping anchorPoint fixed. pos, anchorPoint, and movePoint must be inside bounds already.
+    // resizes the rect described by anchorPoint and movePoint to pos, keeping anchorPoint fixed. anchorPoint and movePoint must be inside bounds already.
     QRect resizeRectFromCorner(const QPoint& anchorPoint, const QPoint& movePoint, const QPoint& pos, const QRect &bounds, bool maintainAspect);
-    // resizes originalRect to pos, keeping the center fixed. pos must be insideBounds already
+    // resizes originalRect to pos, keeping the center fixed. anchorPoint must be inside bounds.
     QRect resizeRectFromCornerCentered(const QRect& originalRect, const QPoint& pos, const QRect& bounds, bool maintainAspect);
-    // resizes a rect from an edge, keeping anchorPoint fixed. movePoint = center of edge being dragged. anchorPoint = center of opposite edge. pos, anchorPoint, and movePoint must be inside bounds already.
+    // resizes a rect from an edge, keeping anchorPoint fixed. movePoint = center of edge being dragged. anchorPoint = center of opposite edge. anchorPoint and movePoint must be inside bounds already.
     QRect resizeRectFromEdge(const QRect& originalSize, const QPoint& anchorPoint, const QPoint& movePoint, const QPoint& pos, const QRect &bounds, bool maintainAspect);
-    // returns a new rectangle. pos and mouseOrigin must be inside bounds already.
+    // returns a new rectangle. mouseOrigin must be inside bounds already.
     QRect newRect(const QPoint& pos, const QPoint& mouseOrigin, const QRect& bounds, bool squareAspect);
-    // returns a new rectangle, pos and mouseOrigin must be inside bounds already.
+    // returns a new rectangle, mouseOrigin must be inside bounds already.
     QRect newRectCentered(const QPoint& pos, const QPoint& mouseOrigin, const QRect& bounds, bool squareAspect);
-    // returns a rectangle with topLeft = from, and bottomRight = to. pos and mouseOrigin must be inside bounds already.
+    // returns a rectangle with topLeft = from, and bottomRight = to. mouseOrigin must be inside bounds already.
     QRect newLine(const QPoint& pos, const QPoint& mouseOrigin, bool specialAspect, const QRect& bounds);
     // returns -1 if pos is in 1st or 3rd quadrant with origin mouseOrigin, 1 otherwise
     int quadrantSign(const QPoint& pos, const QPoint& mouseOrigin);