Improved javadoc for getBaselineOffset

git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/branches/Temp_InlineContainer@1539612 13f79535-47bb-0310-9956-ffa450edef68

diff --git a/src/java/org/apache/fop/layoutmgr/LayoutManager.java b/src/java/org/apache/fop/layoutmgr/LayoutManager.java
index 107a252b02c6859e812e9e251ec80b2ba5e33545..8d1e4001cef6a00815e1d83c10ca377991cfe46d 100644 (file)
--- a/src/java/org/apache/fop/layoutmgr/LayoutManager.java
+++ b/src/java/org/apache/fop/layoutmgr/LayoutManager.java
@@ -178,7 +178,7 @@ public interface LayoutManager extends PercentBaseContext {
     List getChangedKnuthElements(List oldList, int alignment);
 
     /**
-     * Whether the FO handled by this layout manager had a descendant (including itself)
+     * Whether the FO handled by this layout manager has a descendant (including itself)
      * that will generate a line-area.
      *
      * @return {@code true} if a descendant line-area will be generated, {@code false} otherwise
@@ -187,10 +187,12 @@ public interface LayoutManager extends PercentBaseContext {
 
     /**
      * Returns the position of the dominant-baseline of this FO's first descendant
-     * line-area, if any.
+     * line-area. <p>The behavior of this method is undefined if this FO has no descendant
+     * line-area, and an exception may be thrown. See {@link #hasLineAreaDescendant()}</p>
      *
      * @return this FO's space-before plus the distance from the before-edge of its
      * allocation-rectangle to the dominant-baseline of the first line-area descendant
+     * @see #hasLineAreaDescendant()
      */
     int getBaselineOffset();