More documentation checkins. r=jkeiser/sicking, sr=jst, a=asa

git-svn-id: svn://10.0.0.236/trunk@126048 18797224-902f-48f8-a5cc-f745e15eee43

mozilla/content/base/src/nsHTMLValue.h

@@ -59,6 +59,12 @@ enum nsHTMLUnit {
   eHTMLUnit_Pixel      = 600    // (int) screen pixels
 };
 
+/**
+ * Class which is used to represent the value of an attribute of an
+ * HTML element.  The value has a unit which is an nsHTMLUnit;
+ * checking the unit is a must before asking for the value in any
+ * particular form.
+ */
 class nsHTMLValue {
 public:
   nsHTMLValue(nsHTMLUnit aUnit = eHTMLUnit_Null);

mozilla/content/shared/public/nsHTMLValue.h

@@ -59,6 +59,12 @@ enum nsHTMLUnit {
   eHTMLUnit_Pixel      = 600    // (int) screen pixels
 };
 
+/**
+ * Class which is used to represent the value of an attribute of an
+ * HTML element.  The value has a unit which is an nsHTMLUnit;
+ * checking the unit is a must before asking for the value in any
+ * particular form.
+ */
 class nsHTMLValue {
 public:
   nsHTMLValue(nsHTMLUnit aUnit = eHTMLUnit_Null);

mozilla/content/shared/public/nsStyleCoord.h

@@ -62,6 +62,14 @@ typedef union {
   float       mFloat;
 } nsStyleUnion;
 
+/**
+ * Class that hold a single size specification used by the style
+ * system.  The size specification consists of two parts -- a number
+ * and a unit.  The number is an integer, a floating point value, an
+ * nscoord, or undefined, and the unit is an nsStyleUnit.  Checking
+ * the unit is a must before asking for the value in any particular
+ * form.
+ */
 class nsStyleCoord {
 public:
   nsStyleCoord(nsStyleUnit aUnit = eStyleUnit_Null);
@@ -100,6 +108,11 @@ public:
 };
 
 
+/**
+ * Class that represents a set of top/right/bottom/left nsStyleCoords.
+ * This is commonly used to hold the widths of the borders, margins,
+ * or paddings of a box.
+ */
 class nsStyleSides {
 public:
   nsStyleSides(void);

mozilla/layout/style/nsStyleCoord.h

@@ -62,6 +62,14 @@ typedef union {
   float       mFloat;
 } nsStyleUnion;
 
+/**
+ * Class that hold a single size specification used by the style
+ * system.  The size specification consists of two parts -- a number
+ * and a unit.  The number is an integer, a floating point value, an
+ * nscoord, or undefined, and the unit is an nsStyleUnit.  Checking
+ * the unit is a must before asking for the value in any particular
+ * form.
+ */
 class nsStyleCoord {
 public:
   nsStyleCoord(nsStyleUnit aUnit = eStyleUnit_Null);
@@ -100,6 +108,11 @@ public:
 };
 
 
+/**
+ * Class that represents a set of top/right/bottom/left nsStyleCoords.
+ * This is commonly used to hold the widths of the borders, margins,
+ * or paddings of a box.
+ */
 class nsStyleSides {
 public:
   nsStyleSides(void);