Reorganize comments.

2 files changed, 40 insertions, 17 deletions

diff --git a/dw/ooffloatsmgr.cc b/dw/ooffloatsmgr.cc
index c2ffc580..10e72bae 100644
--- a/dw/ooffloatsmgr.cc
+++ b/dw/ooffloatsmgr.cc
@@ -1988,15 +1988,6 @@ OOFFloatsMgr::TBInfo *OOFFloatsMgr::getOOFAwareWidget (OOFAwareWidget *widget)
    return tbInfo;
 }
 
-/**
- * Get the left border for the vertical position of *y*, for a height
- * of *h", based on floats; relative to the allocation of the calling
- * textblock.
- *
- * The border includes marging/border/padding of the calling textblock
- * but is 0 if there is no float, so a caller should also consider
- * other borders.
- */
 int OOFFloatsMgr::getLeftBorder (OOFAwareWidget *textblock, int y, int h,
                                  OOFAwareWidget *lastGB, int lastExtIndex)
 {
@@ -2006,12 +1997,6 @@ int OOFFloatsMgr::getLeftBorder (OOFAwareWidget *textblock, int y, int h,
    return b;
 }
 
-/**
- * Get the right border for the vertical position of *y*, for a height
- * of *h*, based on floats.
- *
- * See also getLeftBorder(int, int);
- */
 int OOFFloatsMgr::getRightBorder (OOFAwareWidget *textblock, int y, int h,
                                   OOFAwareWidget *lastGB, int lastExtIndex)
 {
@@ -2163,7 +2148,6 @@ int OOFFloatsMgr::getRightFloatHeight (OOFAwareWidget *textblock, int y, int h,
    return getFloatHeight (textblock, RIGHT, y, h, lastGB, lastExtIndex);
 }
 
-// Calculate height from the position *y*.
 int OOFFloatsMgr::getFloatHeight (OOFAwareWidget *textblock, Side side, int y,
                                   int h, OOFAwareWidget *lastGB,
                                   int lastExtIndex)
diff --git a/dw/outofflowmgr.hh b/dw/outofflowmgr.hh
index 9f8bf870..67b18f50 100644
--- a/dw/outofflowmgr.hh
+++ b/dw/outofflowmgr.hh
@@ -63,20 +63,59 @@ public:
    virtual void getExtremes (core::Extremes *containerExtr, int *oofMinWidth,
                              int *oofMaxWidth) = 0;
 
-
+   /**
+    * Get the left border for the vertical position of *y*, for a height
+    * of *h", based on floats; relative to the allocation of the calling
+    * textblock.
+    *
+    * The border includes marging/border/padding of the calling textblock
+    * but is 0 if there is no float, so a caller should also consider
+    * other borders.
+    */
    virtual int getLeftBorder (OOFAwareWidget *widget, int y, int h,
                               OOFAwareWidget *lastGen, int lastExtIndex) = 0;
+
+   /**
+    * Get the right border for the vertical position of *y*, for a height
+    * of *h*, based on floats.
+    *
+    * See also getLeftBorder().
+    */
    virtual int getRightBorder (OOFAwareWidget *widget, int y, int h,
                                OOFAwareWidget *lastGen, int lastExtIndex) = 0;
 
+   /**
+    * Return whether there is a float on the left side.
+    *
+    * See also getLeftBorder().
+    */
    virtual bool hasFloatLeft (OOFAwareWidget *widget, int y, int h,
                               OOFAwareWidget *lastGen, int lastExtIndex) = 0;
+
+   /**
+    * Return whether there is a float on the right side.
+    *
+    * See also hasFloatLeft(), getLeftBorder();
+    */
    virtual bool hasFloatRight (OOFAwareWidget *widget, int y, int h,
                                OOFAwareWidget *lastGen, int lastExtIndex) = 0;
 
+   /**
+    * Assuming there is a float on the left side, return the rest
+    * height of it.
+    *
+    * See also getLeftBorder().
+    */
    virtual int getLeftFloatHeight (OOFAwareWidget *widget, int y, int h,
                                    OOFAwareWidget *lastGen, int lastExtIndex)
       = 0;
+
+   /**
+    * Assuming there is a float on the right side, return the rest
+    * height of it.
+    *
+    * See also getLeftFloatHeight(), getLeftBorder().
+    */
    virtual int getRightFloatHeight (OOFAwareWidget *widget, int y, int h,
                                     OOFAwareWidget *lastGen, int lastExtIndex)
       = 0;