[FOray-commit] SF.net SVN: foray:[12530] trunk/foray

[<vic...@us...>]

Revision: 12530
          http://sourceforge.net/p/foray/code/12530
Author:   victormote
Date:     2022-02-01 19:25:58 +0000 (Tue, 01 Feb 2022)
Log Message:
-----------
Add missing javadoc.

Modified Paths:
--------------
    trunk/foray/foray-common/src/main/java/org/foray/common/data/ByteSequenceTokenizerConfig.java
    trunk/foray/foray-common/src/main/java/org/foray/common/data/TernaryNode.java
    trunk/foray/foray-common/src/main/java/org/foray/common/para/ParaBranch4aIterator.java
    trunk/foray/foray-fotree/src/main/java/org/foray/fotree/FoTree4a.java
    trunk/foray/foray-fotree/src/main/java/org/foray/fotree/FoTreeServer4a.java
    trunk/foray/foray-pdf/src/main/java/org/foray/pdf/document/PdfNameDictionary.java

Modified: trunk/foray/foray-common/src/main/java/org/foray/common/data/ByteSequenceTokenizerConfig.java
===================================================================
--- trunk/foray/foray-common/src/main/java/org/foray/common/data/ByteSequenceTokenizerConfig.java	2022-02-01 19:07:05 UTC (rev 12529)
+++ trunk/foray/foray-common/src/main/java/org/foray/common/data/ByteSequenceTokenizerConfig.java	2022-02-01 19:25:58 UTC (rev 12530)
@@ -114,18 +114,34 @@
         }
     }
 
+    /**
+     * Returns the list of returnable delimiters.
+     * @return The list of returnable delimiters.
+     */
     public List<ByteArray> getReturnableDelimiters() {
         return this.returnableDelimiters;
     }
 
+    /**
+     * Returns the list of non-returnable delimiters.
+     * @return The list of non-returnable delimiters.
+     */
     public ByteArray getNonReturnableDelimiters() {
         return this.nonReturnableDelimiters;
     }
 
+    /**
+     * Returns the list of escape codes.
+     * @return The list of escape codes.
+     */
     public ByteArray getEscapeCodes() {
         return this.escapeCodes;
     }
 
+    /**
+     * Returns the list of returnable delimiter balancers.
+     * @return The list of returnable delimiter balancers.
+     */
     public List<ByteArray> getReturnableDelimiterBalancers() {
         return this.returnableDelimiterBalancers;
     }

Modified: trunk/foray/foray-common/src/main/java/org/foray/common/data/TernaryNode.java
===================================================================
--- trunk/foray/foray-common/src/main/java/org/foray/common/data/TernaryNode.java	2022-02-01 19:07:05 UTC (rev 12529)
+++ trunk/foray/foray-common/src/main/java/org/foray/common/data/TernaryNode.java	2022-02-01 19:25:58 UTC (rev 12530)
@@ -183,6 +183,11 @@
        return -1;
     }
 
+    /**
+     * Returns the key for this node.
+     * @param tree The ancestor tree.
+     * @return The key for this node.
+     */
     public CharSequence getKey(final TernaryTree tree) {
         return tree.getKey(this.index, this.rawKey);
     }

Modified: trunk/foray/foray-common/src/main/java/org/foray/common/para/ParaBranch4aIterator.java
===================================================================
--- trunk/foray/foray-common/src/main/java/org/foray/common/para/ParaBranch4aIterator.java	2022-02-01 19:07:05 UTC (rev 12529)
+++ trunk/foray/foray-common/src/main/java/org/foray/common/para/ParaBranch4aIterator.java	2022-02-01 19:25:58 UTC (rev 12530)
@@ -66,6 +66,10 @@
      * stored is conceptually the "next" index to be iterated. */
     private IntArrayBuilder branchIndexes = new IntArrayBuilder();
 
+    /**
+     * Constructor.
+     * @param branch The branch to be iterated.
+     */
     public ParaBranch4aIterator(final ParaBranch branch) {
         this.branchStack.push(branch);
         this.paraLeafSize = branch.qtyParaLeaves();

Modified: trunk/foray/foray-fotree/src/main/java/org/foray/fotree/FoTree4a.java
===================================================================
--- trunk/foray/foray-fotree/src/main/java/org/foray/fotree/FoTree4a.java	2022-02-01 19:07:05 UTC (rev 12529)
+++ trunk/foray/foray-fotree/src/main/java/org/foray/fotree/FoTree4a.java	2022-02-01 19:25:58 UTC (rev 12530)
@@ -101,6 +101,10 @@
         return this.root != null;
     }
 
+    /**
+     * Setter for the root element of this tree.
+     * @param root The new root element.
+     */
     public void setRootFo(final Root4a root) {
         this.root = root;
     }
@@ -155,6 +159,10 @@
         this.graphicSearchPath = graphicSearchPath;
     }
 
+    /**
+     * Returns the graphic search path for this FO tree.
+     * @return The graphic search path.
+     */
     public URL[] getGraphicSearchPath() {
         return this.graphicSearchPath;
     }
@@ -164,6 +172,10 @@
         this.cachingGraphics = cachingGraphics;
     }
 
+    /**
+     * Indicates whether this FO tree wants graphic objects to be cached for reuse.
+     * @return True if and only if graphic objects should be cached for reuse.
+     */
     public boolean isCachingGraphics() {
         return this.cachingGraphics;
     }
@@ -177,6 +189,10 @@
         return this.lastSequentialIndex;
     }
 
+    /**
+     * Returns the parent FO tree server for this tree.
+     * @return The parent FO tree server.
+     */
     public FoTreeServer4a getTreeServer() {
         return this.treeServer;
     }
@@ -229,6 +245,10 @@
         return getTreeServer().getAxslNamespace();
     }
 
+    /**
+     * Returns the logger that should be used by this tree and its descendants.
+     * @return The logger.
+     */
     public Logger getLogger() {
         return this.treeBuilder.getLogger();
     }

Modified: trunk/foray/foray-fotree/src/main/java/org/foray/fotree/FoTreeServer4a.java
===================================================================
--- trunk/foray/foray-fotree/src/main/java/org/foray/fotree/FoTreeServer4a.java	2022-02-01 19:07:05 UTC (rev 12529)
+++ trunk/foray/foray-fotree/src/main/java/org/foray/fotree/FoTreeServer4a.java	2022-02-01 19:25:58 UTC (rev 12530)
@@ -308,10 +308,18 @@
         return this.fontServer;
     }
 
+    /**
+     * Returns the graphic server.
+     * @return The graphic server.
+     */
     public GraphicServer getGraphicServer() {
         return this.graphicServer;
     }
 
+    /**
+     * Returns the orthography server.
+     * @return The orthography server.
+     */
     public FoOrthographyServer getOrthographyServer() {
         return this.orthographyServer;
     }

Modified: trunk/foray/foray-pdf/src/main/java/org/foray/pdf/document/PdfNameDictionary.java
===================================================================
--- trunk/foray/foray-pdf/src/main/java/org/foray/pdf/document/PdfNameDictionary.java	2022-02-01 19:07:05 UTC (rev 12529)
+++ trunk/foray/foray-pdf/src/main/java/org/foray/pdf/document/PdfNameDictionary.java	2022-02-01 19:25:58 UTC (rev 12530)
@@ -137,6 +137,10 @@
         return this.embeddedFiles;
     }
 
+    /**
+     * Indicates whether any of this dictionary's children have any content.
+     * @return True if and only if all of this dictionary's children are empty.
+     */
     public boolean isEmpty() {
         return this.dests.isEmpty()
                 && this.embeddedFiles.isEmpty();

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.