Commit 1deacbc3c5450888577d6fe5e8513e9a18dbd7f5

sammy 2008-05-07T15:07:38

* Documentation updates.

diff --git a/src/FTGL/FTBBox.h b/src/FTGL/FTBBox.h
index f7a5063..858ff7a 100644
--- a/src/FTGL/FTBBox.h
+++ b/src/FTGL/FTBBox.h
@@ -119,7 +119,7 @@ class FTGL_EXPORT FTBBox
         /**
          * Move the Bounding Box by a vector.
          *
-         * @param distance The vector to move the bbox in 3D space.
+         * @param vector  The vector to move the bbox in 3D space.
          */
         FTBBox& operator += (const FTPoint vector)
         {
@@ -129,6 +129,12 @@ class FTGL_EXPORT FTBBox
             return *this;
         }
 
+        /**
+         * Combine two bounding boxes. The result is the smallest bounding
+         * box containing the two original boxes.
+         *
+         * @param bbox  The bounding box to merge with the second one.
+         */
         FTBBox& operator |= (const FTBBox& bbox)
         {
             if(bbox.lower.X() < lower.X()) lower.X(bbox.lower.X());
diff --git a/src/FTGL/FTFont.h b/src/FTGL/FTFont.h
index 338da10..b8010db 100644
--- a/src/FTGL/FTFont.h
+++ b/src/FTGL/FTFont.h
@@ -216,7 +216,7 @@ class FTGL_EXPORT FTFont
          * @param string  A char buffer.
          * @return  The corresponding bounding box.
          */
-        FTBBox BBox(const char *s);
+        FTBBox BBox(const char *string);
 
         /**
          * Get the bounding box for a string.
@@ -224,7 +224,7 @@ class FTGL_EXPORT FTFont
          * @param string  A wchar_t buffer.
          * @return  The corresponding bounding box.
          */
-        FTBBox BBox(const wchar_t *s);
+        FTBBox BBox(const wchar_t *string);
 
         /**
          * Get the bounding box for a string.
@@ -237,7 +237,7 @@ class FTGL_EXPORT FTFont
          *             until a '@\0' is encountered.
          * @return  The corresponding bounding box.
          */
-        FTBBox BBox(const char *s, const int start, const int end);
+        FTBBox BBox(const char *string, const int start, const int end);
 
         /**
          * Get the bounding box for a string.
@@ -250,7 +250,7 @@ class FTGL_EXPORT FTFont
          *             until a '@\0' is encountered.
          * @return  The corresponding bounding box.
          */
-        FTBBox BBox(const wchar_t *s, const int start, const int end);
+        FTBBox BBox(const wchar_t *string, const int start, const int end);
 
         /**
          * Get the advance width for a string.