From e1ee53b4c48a7f7781fe88a0336e77dad0df37cd Mon Sep 17 00:00:00 2001 From: Vincent Hennebert Date: Thu, 7 Nov 2013 12:29:56 +0000 Subject: [PATCH] Improved javadoc for getBaselineOffset git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/branches/Temp_InlineContainer@1539612 13f79535-47bb-0310-9956-ffa450edef68 --- src/java/org/apache/fop/layoutmgr/LayoutManager.java | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/src/java/org/apache/fop/layoutmgr/LayoutManager.java b/src/java/org/apache/fop/layoutmgr/LayoutManager.java index 107a252b0..8d1e4001c 100644 --- 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.

The behavior of this method is undefined if this FO has no descendant + * line-area, and an exception may be thrown. See {@link #hasLineAreaDescendant()}

* * @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(); -- 2.39.5