aboutsummaryrefslogtreecommitdiffstats
path: root/src/java/org/apache/fop/fo/pagination/bookmarks/BookmarkTitle.java
diff options
context:
space:
mode:
Diffstat (limited to 'src/java/org/apache/fop/fo/pagination/bookmarks/BookmarkTitle.java')
-rw-r--r--src/java/org/apache/fop/fo/pagination/bookmarks/BookmarkTitle.java27
1 files changed, 15 insertions, 12 deletions
diff --git a/src/java/org/apache/fop/fo/pagination/bookmarks/BookmarkTitle.java b/src/java/org/apache/fop/fo/pagination/bookmarks/BookmarkTitle.java
index c7024f2aa..c4cc73efc 100644
--- a/src/java/org/apache/fop/fo/pagination/bookmarks/BookmarkTitle.java
+++ b/src/java/org/apache/fop/fo/pagination/bookmarks/BookmarkTitle.java
@@ -21,23 +21,24 @@ package org.apache.fop.fo.pagination.bookmarks;
import org.xml.sax.Locator;
-import org.apache.fop.fo.FONode;
import org.apache.fop.fo.FObj;
+import org.apache.fop.fo.FONode;
import org.apache.fop.fo.PropertyList;
import org.apache.fop.fo.ValidationException;
/**
- * The fo:bookmark-title formatting object, first introduced in the
- * XSL 1.1 WD. Prototype version only, subject to change as XSL 1.1 WD
- * evolves.
+ * Class modelling the <a href="http://www.w3.org/TR/xsl/#fo_bookmark-title">
+ * <code>fo:bookmark-title</code></a> object, first introduced in the
+ * XSL 1.1 WD.
*/
public class BookmarkTitle extends FObj {
private String title = "";
/**
- * Create a new BookmarkTitle object.
+ * Create a new BookmarkTitle object that is a child
+ * of the given {@link FONode}.
*
- * @param parent the fo node parent
+ * @param parent the {@link FONode} parent
*/
public BookmarkTitle(FONode parent) {
super(parent);
@@ -45,14 +46,13 @@ public class BookmarkTitle extends FObj {
/**
* Add the characters to this BookmarkTitle.
- * The text data inside the BookmarkTitle XML element
+ * The text data inside the BookmarkTitle xml element
* is used for the BookmarkTitle string.
*
* @param data the character data
* @param start the start position in the data array
* @param end the end position in the character array
- * @param pList the currently valid property list
- * @param locator location in FO source file.
+ * @param locator location in fo source file.
*/
protected void addCharacters(char[] data, int start, int end,
PropertyList pList,
@@ -62,10 +62,10 @@ public class BookmarkTitle extends FObj {
/**
* {@inheritDoc}
- XSL/FOP: empty
+ * <br>XSL/FOP: empty
*/
protected void validateChildNode(Locator loc, String nsURI, String localName)
- throws ValidationException {
+ throws ValidationException {
if (FO_URI.equals(nsURI)) {
invalidChildError(loc, nsURI, localName);
}
@@ -85,7 +85,10 @@ public class BookmarkTitle extends FObj {
return "bookmark-title";
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ * @return {@link org.apache.fop.fo.Constants#FO_BOOKMARK_TITLE}
+ */
public int getNameId() {
return FO_BOOKMARK_TITLE;
}