Merged revisions 651853,651855-651856,651866-651867,651880,651898 via svnmerge from

https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk

........
  r651853 | adelmelle | 2008-04-26 21:06:04 +0100 (Sat, 26 Apr 2008) | 3 lines
  
  Bugzilla 44203:
  Fixed a logic error in Hyphenator.java where an UnsupportedOperationException was erroneously thrown if the supplied source had an associated InputStream.
........
  r651855 | adelmelle | 2008-04-26 21:19:59 +0100 (Sat, 26 Apr 2008) | 3 lines
  
  Basic activation of keep-* properties on Character and AbstractGraphics
  + javadoc updates
........
  r651856 | adelmelle | 2008-04-26 21:21:44 +0100 (Sat, 26 Apr 2008) | 3 lines
  
  Basic activation on some widely used properties (prepare for implementation)
  + javadoc updates
........
  r651866 | adelmelle | 2008-04-26 23:08:10 +0100 (Sat, 26 Apr 2008) | 2 lines
  
  Javadoc updates: attempt at improving interactivity and consistency
........
  r651867 | adelmelle | 2008-04-27 00:07:51 +0100 (Sun, 27 Apr 2008) | 2 lines
  
  Minor refactoring: consolidate getPSLM().notifyEndOfLayout(fobj.getId()) in AbstractLayoutManager.notifyEndOfLayout()
........
  r651880 | clay | 2008-04-27 04:27:39 +0100 (Sun, 27 Apr 2008) | 1 line
  
  Updated to include dev (0.95beta) release.
........
  r651898 | adelmelle | 2008-04-27 09:18:31 +0100 (Sun, 27 Apr 2008) | 1 line
  
  Correction of r651866
........


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

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;
     }