Changeset 115 for trunk/nv/position.hh

Timestamp:

06/11/13 20:22:57 (12 years ago)

Author:

shark

Message:

• Documenting added functions.

File:

• trunk/nv/position.hh (modified) (1 diff)

trunk/nv/position.hh

@@ -161 +161 @@
                  */
                 bool is_valid() const { return x2 >= x1 && y2 >= y1; }
+
+                /**
+                 *Enlarges the rectangle by a given amount.  Each side is adjusted by the given amount, e.g. expanding by 1 increases the width and height by 2 each.
+                 *
+                 *@param value The amount to adjust each sides by.
+                 */
                 void expand( value_type value ) { position p(value,value); ul -= p; lr += p; }
+
+                /**
+                 *Reduces the rectangle by a given amount.  Each side is adjusted by the given amount, e.g. shrinking by 1 decreases the width and height by 2 each.
+                 *
+                 *@param value The amount to adjust each side by.
+                 */
                 void shrink( value_type value ) { position p(value,value); ul += p; lr -= p; }
+
+                /**
+                 *Gets a rectangle that is an expanded version of this rectangle.
+                 *
+                 *@param value The amount to adjust each side by.
+                 *@returns An expanded rectangle.
+                 *@see expand
+                 */
                 rectangle expanded( int value ) { position p(value,value); return rectangle(ul-p, lr+p); }
+
+                /**
+                 *Gets a rectangle that is a shrunk version of this rectangle.
+                 *
+                 *@param value The amount to adjust each side by.
+                 *@returns A shrunk rectangle.
+                 *@see shrink
+                 */
                 rectangle shrinked( int value ) { position p(value,value); return rectangle(ul+p, lr-p); }