Commit 1deacbc3c5450888577d6fe5e8513e9a18dbd7f5
2008-05-07T15:07:38
* Documentation updates.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66
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.