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

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

Revision: 12513
          http://sourceforge.net/p/foray/code/12513
Author:   victormote
Date:     2022-01-31 14:13:27 +0000 (Mon, 31 Jan 2022)
Log Message:
-----------
Add checkstyle checks previously covered by other checks.

Modified Paths:
--------------
    trunk/foray/foray-00-master/config/checkstyle/checkstyle-config.xml
    trunk/foray/foray-areatree/src/main/java/org/foray/area/TextAreaCharacters.java
    trunk/foray/foray-areatree/src/main/java/org/foray/area/TextAreaWords.java
    trunk/foray/foray-areatree/src/main/java/org/foray/area/link/LinkFactory.java
    trunk/foray/foray-areatree/src/main/java/org/foray/area/metadata/DocumentMetadata4a.java
    trunk/foray/foray-common/src/main/java/org/foray/common/primitive/ArrayUtils.java
    trunk/foray/foray-common/src/test/java/org/foray/common/data/AbstractByteSequenceTests.java
    trunk/foray/foray-common/src/test/java/org/foray/common/data/TernaryNodesTests.java
    trunk/foray/foray-common/src/test/java/org/foray/common/data/TernaryTreeIteratorTests.java
    trunk/foray/foray-fotree/src/main/java/org/foray/fotree/FoTree4a.java
    trunk/foray/foray-linebreak/src/main/java/org/foray/linebreak/LineBreaker4a.java
    trunk/foray/foray-pdf/src/main/java/org/foray/pdf/interact/PdfDestinationNamed4a.java
    trunk/foray/foray-pdf/src/main/java/org/foray/pdf/interact/PdfNamedDestinationsTree4a.java
    trunk/foray/foray-pdf/src/main/java/org/foray/pdf/serial/PdfTrailer.java
    trunk/foray/foray-pdf/src/main/java/org/foray/pdf/type/PdfDictionary.java
    trunk/foray/foray-pdf/src/main/java/org/foray/pdf/type/PdfName.java
    trunk/foray/foray-pdf/src/main/java/org/foray/pdf/type/PdfNumeric.java

Modified: trunk/foray/foray-00-master/config/checkstyle/checkstyle-config.xml
===================================================================
--- trunk/foray/foray-00-master/config/checkstyle/checkstyle-config.xml	2022-01-30 19:23:05 UTC (rev 12512)
+++ trunk/foray/foray-00-master/config/checkstyle/checkstyle-config.xml	2022-01-31 14:13:27 UTC (rev 12513)
@@ -24,7 +24,7 @@
     <property name="headerFile" value="${foray.root}/foray-00-master/config/checkstyle/checkstyle-header-java.txt"/>
   </module>
 
-  <!-- Make sure each package has javadoc package.html -->
+  <!-- Make sure each package has javadoc package-info.java. -->
   <module name="JavadocPackage"/>
 
   <module name="LineLength">
@@ -106,7 +106,12 @@
     </module>
     <module name="StringLiteralEquality"/>
 
-    <!-- Make sure each Type has javadoc, regardless of visibility -->
+    <!-- Make sure each package-info.java has javadoc comment. -->
+    <module name="MissingJavadocPackage"/>
+
+    <!-- Make sure each Type has javadoc, regardless of visibility. -->
+    <module name="MissingJavadocType"/>
+    <!-- Make sure Type javadoc is well-formed. -->
     <module name="JavadocType"/>
 
     <!-- Make sure each method has javadoc -->

Modified: trunk/foray/foray-areatree/src/main/java/org/foray/area/TextAreaCharacters.java
===================================================================
--- trunk/foray/foray-areatree/src/main/java/org/foray/area/TextAreaCharacters.java	2022-01-30 19:23:05 UTC (rev 12512)
+++ trunk/foray/foray-areatree/src/main/java/org/foray/area/TextAreaCharacters.java	2022-01-31 14:13:27 UTC (rev 12513)
@@ -36,6 +36,10 @@
 
 import java.io.Serializable;
 
+/**
+ * A {@link TextArea} that wraps a sequence of characters.
+ * @see TextAreaWords which instead wraps a sequence of words and interword content.
+ */
 public final class TextAreaCharacters extends TextArea {
 
     /** The link to the FO tree. */

Modified: trunk/foray/foray-areatree/src/main/java/org/foray/area/TextAreaWords.java
===================================================================
--- trunk/foray/foray-areatree/src/main/java/org/foray/area/TextAreaWords.java	2022-01-30 19:23:05 UTC (rev 12512)
+++ trunk/foray/foray-areatree/src/main/java/org/foray/area/TextAreaWords.java	2022-01-31 14:13:27 UTC (rev 12513)
@@ -33,6 +33,10 @@
 import org.axsl.fotree.fo.FoTextWords;
 import org.axsl.fotree.text.FoTokenFlow;
 
+/**
+ * A {@link TextArea} that wraps a sequence of words and interword content.
+ * @see TextAreaCharacters which instead wraps a sequence of characters.
+ */
 public class TextAreaWords extends TextArea {
 
     /** The link to the FO tree. */

Modified: trunk/foray/foray-areatree/src/main/java/org/foray/area/link/LinkFactory.java
===================================================================
--- trunk/foray/foray-areatree/src/main/java/org/foray/area/link/LinkFactory.java	2022-01-30 19:23:05 UTC (rev 12512)
+++ trunk/foray/foray-areatree/src/main/java/org/foray/area/link/LinkFactory.java	2022-01-31 14:13:27 UTC (rev 12513)
@@ -87,6 +87,9 @@
 import org.axsl.fotree.fo.Wrapper;
 import org.axsl.fotree.foreign.SvgElement;
 
+/**
+ * Implementation of {@link FoVisitor} that knows how to create the link objects to the FO tree.
+ */
 public class LinkFactory implements FoVisitor<Link<? extends Fo>> {
 
     @Override

Modified: trunk/foray/foray-areatree/src/main/java/org/foray/area/metadata/DocumentMetadata4a.java
===================================================================
--- trunk/foray/foray-areatree/src/main/java/org/foray/area/metadata/DocumentMetadata4a.java	2022-01-30 19:23:05 UTC (rev 12512)
+++ trunk/foray/foray-areatree/src/main/java/org/foray/area/metadata/DocumentMetadata4a.java	2022-01-31 14:13:27 UTC (rev 12513)
@@ -42,6 +42,9 @@
 import java.util.Collections;
 import java.util.List;
 
+/**
+ * The document-level metadata.
+ */
 public class DocumentMetadata4a extends AreaNode4a implements DocumentMetadataG5 {
 
     /** The parent area tree. */

Modified: trunk/foray/foray-common/src/main/java/org/foray/common/primitive/ArrayUtils.java
===================================================================
--- trunk/foray/foray-common/src/main/java/org/foray/common/primitive/ArrayUtils.java	2022-01-30 19:23:05 UTC (rev 12512)
+++ trunk/foray/foray-common/src/main/java/org/foray/common/primitive/ArrayUtils.java	2022-01-31 14:13:27 UTC (rev 12513)
@@ -28,6 +28,9 @@
 
 package org.foray.common.primitive;
 
+/**
+ * Array-related utilities.
+ */
 public final class ArrayUtils {
 
     private ArrayUtils() { }

Modified: trunk/foray/foray-common/src/test/java/org/foray/common/data/AbstractByteSequenceTests.java
===================================================================
--- trunk/foray/foray-common/src/test/java/org/foray/common/data/AbstractByteSequenceTests.java	2022-01-30 19:23:05 UTC (rev 12512)
+++ trunk/foray/foray-common/src/test/java/org/foray/common/data/AbstractByteSequenceTests.java	2022-01-31 14:13:27 UTC (rev 12513)
@@ -34,6 +34,9 @@
 import org.junit.Assert;
 import org.junit.Test;
 
+/**
+ * JUnit tests of {@link AbstractByteSequence}.
+ */
 public class AbstractByteSequenceTests {
 
     /** A test sequence. */

Modified: trunk/foray/foray-common/src/test/java/org/foray/common/data/TernaryNodesTests.java
===================================================================
--- trunk/foray/foray-common/src/test/java/org/foray/common/data/TernaryNodesTests.java	2022-01-30 19:23:05 UTC (rev 12512)
+++ trunk/foray/foray-common/src/test/java/org/foray/common/data/TernaryNodesTests.java	2022-01-31 14:13:27 UTC (rev 12513)
@@ -31,6 +31,9 @@
 import org.junit.Assert;
 import org.junit.Test;
 
+/**
+ * JUnit tests of {@link TernaryNodes}.
+ */
 public class TernaryNodesTests extends TernaryTreeTestsHelper {
 
     /**

Modified: trunk/foray/foray-common/src/test/java/org/foray/common/data/TernaryTreeIteratorTests.java
===================================================================
--- trunk/foray/foray-common/src/test/java/org/foray/common/data/TernaryTreeIteratorTests.java	2022-01-30 19:23:05 UTC (rev 12512)
+++ trunk/foray/foray-common/src/test/java/org/foray/common/data/TernaryTreeIteratorTests.java	2022-01-31 14:13:27 UTC (rev 12513)
@@ -35,6 +35,9 @@
 import java.util.Iterator;
 import java.util.List;
 
+/**
+ * JUnit tests of the return value of {@link TernaryTree#getIterator()}.
+ */
 public class TernaryTreeIteratorTests {
 
     /**

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-01-30 19:23:05 UTC (rev 12512)
+++ trunk/foray/foray-fotree/src/main/java/org/foray/fotree/FoTree4a.java	2022-01-31 14:13:27 UTC (rev 12513)
@@ -46,6 +46,9 @@
 
 import java.net.URL;
 
+/**
+ * An XSL-FO document tree.
+ */
 public class FoTree4a implements FoTree {
 
     /** The parent server. */

Modified: trunk/foray/foray-linebreak/src/main/java/org/foray/linebreak/LineBreaker4a.java
===================================================================
--- trunk/foray/foray-linebreak/src/main/java/org/foray/linebreak/LineBreaker4a.java	2022-01-30 19:23:05 UTC (rev 12512)
+++ trunk/foray/foray-linebreak/src/main/java/org/foray/linebreak/LineBreaker4a.java	2022-01-31 14:13:27 UTC (rev 12513)
@@ -30,6 +30,9 @@
 
 import org.axsl.linebreak.LineBreaker;
 
+/**
+ * Abstract superclass for line-breakers.
+ */
 public abstract class LineBreaker4a implements LineBreaker {
 
     /** Magic number used in demerit computation to help normalize adjustment ratios and penalties. */

Modified: trunk/foray/foray-pdf/src/main/java/org/foray/pdf/interact/PdfDestinationNamed4a.java
===================================================================
--- trunk/foray/foray-pdf/src/main/java/org/foray/pdf/interact/PdfDestinationNamed4a.java	2022-01-30 19:23:05 UTC (rev 12512)
+++ trunk/foray/foray-pdf/src/main/java/org/foray/pdf/interact/PdfDestinationNamed4a.java	2022-01-31 14:13:27 UTC (rev 12513)
@@ -35,6 +35,10 @@
 import org.axsl.pdf.PdfDestinationNamed;
 import org.axsl.utility.sequence.ByteSequencePlus;
 
+/**
+ * A PDF named destination.
+ * @see "PDF Reference 6th Edition (PDF Version 1.7), Section 8.2.1."
+ */
 public class PdfDestinationNamed4a extends PdfObject implements PdfDestinationNamed {
 
     /** The registered name of this destination. */

Modified: trunk/foray/foray-pdf/src/main/java/org/foray/pdf/interact/PdfNamedDestinationsTree4a.java
===================================================================
--- trunk/foray/foray-pdf/src/main/java/org/foray/pdf/interact/PdfNamedDestinationsTree4a.java	2022-01-30 19:23:05 UTC (rev 12512)
+++ trunk/foray/foray-pdf/src/main/java/org/foray/pdf/interact/PdfNamedDestinationsTree4a.java	2022-01-31 14:13:27 UTC (rev 12513)
@@ -31,6 +31,10 @@
 import org.foray.pdf.document.PdfDocument4a;
 import org.foray.pdf.structure.PdfNameTree;
 
+/**
+ * PDF Name tree containing named destinations.
+ * The reference to this tree is stored in the Name Dictionary.
+ */
 public class PdfNamedDestinationsTree4a extends PdfNameTree<PdfDestinationNamed4a> {
 
     protected String valueToPDF(final PdfDestinationNamed4a value, final PdfDocument4a doc) {

Modified: trunk/foray/foray-pdf/src/main/java/org/foray/pdf/serial/PdfTrailer.java
===================================================================
--- trunk/foray/foray-pdf/src/main/java/org/foray/pdf/serial/PdfTrailer.java	2022-01-30 19:23:05 UTC (rev 12512)
+++ trunk/foray/foray-pdf/src/main/java/org/foray/pdf/serial/PdfTrailer.java	2022-01-31 14:13:27 UTC (rev 12513)
@@ -33,6 +33,9 @@
 import java.util.Arrays;
 import java.util.List;
 
+/**
+ * The trailer dictionary, used for serialization only.
+ */
 public class PdfTrailer extends PdfDictionary {
 
     /** The default order when writing dictionaries of this class. */

Modified: trunk/foray/foray-pdf/src/main/java/org/foray/pdf/type/PdfDictionary.java
===================================================================
--- trunk/foray/foray-pdf/src/main/java/org/foray/pdf/type/PdfDictionary.java	2022-01-30 19:23:05 UTC (rev 12512)
+++ trunk/foray/foray-pdf/src/main/java/org/foray/pdf/type/PdfDictionary.java	2022-01-31 14:13:27 UTC (rev 12513)
@@ -47,6 +47,10 @@
 import java.util.Map;
 import java.util.Set;
 
+/**
+ * A PDF Dictionary object.
+ * @see "PDF Reference, 6th Edition (PDF Version 1.7), Section 3.2.6."
+ */
 public abstract class PdfDictionary extends PdfObject {
 
     /** Internal map of the dictionary. */

Modified: trunk/foray/foray-pdf/src/main/java/org/foray/pdf/type/PdfName.java
===================================================================
--- trunk/foray/foray-pdf/src/main/java/org/foray/pdf/type/PdfName.java	2022-01-30 19:23:05 UTC (rev 12512)
+++ trunk/foray/foray-pdf/src/main/java/org/foray/pdf/type/PdfName.java	2022-01-31 14:13:27 UTC (rev 12513)
@@ -37,6 +37,10 @@
 
 import org.axsl.utility.sequence.ByteSequencePlus;
 
+/**
+ * A PDF Name object.
+ * @see "PDF Reference, 6th Edition (PDF Version 1.7), Section 3.2.4."
+ */
 public class PdfName extends PdfObject {
 
     /** The value of this name. */

Modified: trunk/foray/foray-pdf/src/main/java/org/foray/pdf/type/PdfNumeric.java
===================================================================
--- trunk/foray/foray-pdf/src/main/java/org/foray/pdf/type/PdfNumeric.java	2022-01-30 19:23:05 UTC (rev 12512)
+++ trunk/foray/foray-pdf/src/main/java/org/foray/pdf/type/PdfNumeric.java	2022-01-31 14:13:27 UTC (rev 12513)
@@ -28,6 +28,10 @@
 
 package org.foray.pdf.type;
 
+/**
+ * A PDF Numeric object.
+ * @see "PDF Reference, 6th Edition (PDF Version 1.7), Section 3.2.2."
+ */
 public abstract class PdfNumeric extends PdfObject {
 
 }

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