Author: vhennebert
Date: Mon Feb 11 10:18:13 2008
New Revision: 620565
URL: http://svn.apache.org/viewvc?rev=620565&view=rev
Log:
Better javadoc for break class
Modified:
xmlgraphics/fop/trunk/src/java/org/apache/fop/layoutmgr/BreakElement.java
xmlgraphics/fop/trunk/src/java/org/apache/fop/layoutmgr/KnuthPenalty.java
Modified:
xmlgraphics/fop/trunk/src/java/org/apache/fop/layoutmgr/BreakElement.java
URL:
http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/src/java/org/apache/fop/layoutmgr/BreakElement.java?rev=620565&r1=620564&r2=620565&view=diff
==============================================================================
--- xmlgraphics/fop/trunk/src/java/org/apache/fop/layoutmgr/BreakElement.java
(original)
+++ xmlgraphics/fop/trunk/src/java/org/apache/fop/layoutmgr/BreakElement.java
Mon Feb 11 10:18:13 2008
@@ -46,10 +46,13 @@
/**
* Constructor for hard breaks.
+ *
* @param position the Position instance needed by the addAreas stage of
the LMs.
* @param penaltyWidth the penalty width
* @param penaltyValue the penalty value for the penalty element to be
constructed
- * @param breakClass the break class of this penalty (one of the break-*
constants)
+ * @param breakClass the break class of this penalty (one of [EMAIL
PROTECTED] Constants#EN_AUTO},
+ * [EMAIL PROTECTED] Constants#EN_COLUMN}, [EMAIL PROTECTED]
Constants#EN_PAGE},
+ * [EMAIL PROTECTED] Constants#EN_EVEN_PAGE}, [EMAIL PROTECTED]
Constants#EN_ODD_PAGE})
* @param context the layout context which contains the pending
conditional elements
*/
public BreakElement(Position position, int penaltyWidth, int penaltyValue,
@@ -96,14 +99,23 @@
return penaltyValue == -KnuthElement.INFINITE;
}
- /** @return the break class of this penalty (one of the break-* constants)
*/
+ /**
+ * Returns the break class of this penalty.
+ *
+ * @return one of [EMAIL PROTECTED] Constants#EN_AUTO}, [EMAIL PROTECTED]
Constants#EN_COLUMN},
+ * [EMAIL PROTECTED] Constants#EN_PAGE}, [EMAIL PROTECTED]
Constants#EN_EVEN_PAGE},
+ * [EMAIL PROTECTED] Constants#EN_ODD_PAGE}
+ */
public int getBreakClass() {
return breakClass;
}
/**
* Sets the break class.
- * @param breakClass the new break class
+ *
+ * @param breakClass one of [EMAIL PROTECTED] Constants#EN_AUTO}, [EMAIL
PROTECTED] Constants#EN_COLUMN},
+ * [EMAIL PROTECTED] Constants#EN_PAGE}, [EMAIL PROTECTED]
Constants#EN_EVEN_PAGE},
+ * [EMAIL PROTECTED] Constants#EN_ODD_PAGE}
*/
public void setBreakClass(int breakClass) {
this.breakClass = breakClass;
Modified:
xmlgraphics/fop/trunk/src/java/org/apache/fop/layoutmgr/KnuthPenalty.java
URL:
http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/src/java/org/apache/fop/layoutmgr/KnuthPenalty.java?rev=620565&r1=620564&r2=620565&view=diff
==============================================================================
--- xmlgraphics/fop/trunk/src/java/org/apache/fop/layoutmgr/KnuthPenalty.java
(original)
+++ xmlgraphics/fop/trunk/src/java/org/apache/fop/layoutmgr/KnuthPenalty.java
Mon Feb 11 10:18:13 2008
@@ -65,11 +65,13 @@
/**
* Create a new KnuthPenalty.
- *
+ *
* @param w the width of this penalty
* @param p the penalty value of this penalty
* @param f is this penalty flagged?
- * @param iBreakClass the break class of this penalty (one of the break-*
constants)
+ * @param iBreakClass the break class of this penalty (one of
+ * [EMAIL PROTECTED] Constants#EN_AUTO}, [EMAIL PROTECTED]
Constants#EN_COLUMN}, [EMAIL PROTECTED] Constants#EN_PAGE},
+ * [EMAIL PROTECTED] Constants#EN_EVEN_PAGE}, [EMAIL PROTECTED]
Constants#EN_ODD_PAGE})
* @param pos the Position stored in this penalty
* @param bAux is this penalty auxiliary?
*/
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
