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

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

Revision: 12532
          http://sourceforge.net/p/foray/code/12532
Author:   victormote
Date:     2022-02-01 20:03:40 +0000 (Tue, 01 Feb 2022)
Log Message:
-----------
Ensure javadoc on all types, regardless of visibility.

Modified Paths:
--------------
    trunk/foray/foray-00-master/config/checkstyle/checkstyle-config.xml
    trunk/foray/foray-orthography/src/main/java/org/foray/orthography/util/DictionaryParser.java
    trunk/foray/foray-orthography/src/main/java/org/foray/orthography/util/SpellChecker.java
    trunk/foray/foray-pdf/src/main/java/org/foray/pdf/serial/PdfGenericDictionary.java
    trunk/foray/foray-xml/src/main/java/org/foray/xml/ForayAssignId.java

Modified: trunk/foray/foray-00-master/config/checkstyle/checkstyle-config.xml
===================================================================
--- trunk/foray/foray-00-master/config/checkstyle/checkstyle-config.xml	2022-02-01 19:45:10 UTC (rev 12531)
+++ trunk/foray/foray-00-master/config/checkstyle/checkstyle-config.xml	2022-02-01 20:03:40 UTC (rev 12532)
@@ -110,11 +110,13 @@
     <module name="MissingJavadocPackage"/>
 
     <!-- Make sure each Type has javadoc, regardless of visibility. -->
-    <module name="MissingJavadocType"/>
+    <module name="MissingJavadocType">
+      <property name="scope" value="private"/>
+    </module>
     <!-- Make sure Type javadoc is well-formed. -->
     <module name="JavadocType"/>
 
-    <!-- Make sure each Method has javadoc -->
+    <!-- Make sure each Method has javadoc, regardless of visibility. -->
     <module name="MissingJavadocMethod">
       <property name="scope" value="private"/>
       <property name="severity" value="ignore"/>
@@ -122,7 +124,7 @@
     <!-- Make sure Method javadoc is well-formed. -->
     <module name="JavadocMethod"/>
 
-    <!-- Make sure each variable has javadoc -->
+    <!-- Make sure each variable has javadoc. -->
     <module name="JavadocVariable">
       <property name="scope" value="private"/>
     </module>

Modified: trunk/foray/foray-orthography/src/main/java/org/foray/orthography/util/DictionaryParser.java
===================================================================
--- trunk/foray/foray-orthography/src/main/java/org/foray/orthography/util/DictionaryParser.java	2022-02-01 19:45:10 UTC (rev 12531)
+++ trunk/foray/foray-orthography/src/main/java/org/foray/orthography/util/DictionaryParser.java	2022-02-01 20:03:40 UTC (rev 12532)
@@ -66,6 +66,9 @@
  */
 public class DictionaryParser extends SaxParser<List<SegmentDictionary>> {
 
+    /**
+     * Container for the "axsl-dictionary" element as it is being parsed.
+     */
     private class DictionaryElement {
 
         /** The orthography for this dictionary. */

Modified: trunk/foray/foray-orthography/src/main/java/org/foray/orthography/util/SpellChecker.java
===================================================================
--- trunk/foray/foray-orthography/src/main/java/org/foray/orthography/util/SpellChecker.java	2022-02-01 19:45:10 UTC (rev 12531)
+++ trunk/foray/foray-orthography/src/main/java/org/foray/orthography/util/SpellChecker.java	2022-02-01 20:03:40 UTC (rev 12532)
@@ -73,12 +73,17 @@
 import javax.xml.parsers.ParserConfigurationException;
 
 /**
- * Parses a document, looking for spelling errors.
- * The specified natural language can change at any time, and must be tracked
+ * Parses a generic XML document, looking for spelling errors.
+ * The specified natural language can change at any time, and must be tracked.
  * General plan is to capture all of the text data in one CharSequence, then parse and compare to dictionary entries.
  */
 public class SpellChecker extends SaxParser<Object> {
 
+    /**
+     * An element parsed from the input document.
+     * This class is a SAX parser, but is designed to work with any(???) XML document, and is therefore agnostic about
+     * the elements or their content, so we capture that information in this class.
+     */
     private class Element {
 
         /** The namespace URI, if specified. */

Modified: trunk/foray/foray-pdf/src/main/java/org/foray/pdf/serial/PdfGenericDictionary.java
===================================================================
--- trunk/foray/foray-pdf/src/main/java/org/foray/pdf/serial/PdfGenericDictionary.java	2022-02-01 19:45:10 UTC (rev 12531)
+++ trunk/foray/foray-pdf/src/main/java/org/foray/pdf/serial/PdfGenericDictionary.java	2022-02-01 20:03:40 UTC (rev 12532)
@@ -34,6 +34,9 @@
 import java.util.Collections;
 import java.util.List;
 
+/**
+ * A general-purpose concrete dictionary class, mostly useful during parsing.
+ */
 class PdfGenericDictionary extends PdfDictionary {
 
     @Override

Modified: trunk/foray/foray-xml/src/main/java/org/foray/xml/ForayAssignId.java
===================================================================
--- trunk/foray/foray-xml/src/main/java/org/foray/xml/ForayAssignId.java	2022-02-01 19:45:10 UTC (rev 12531)
+++ trunk/foray/foray-xml/src/main/java/org/foray/xml/ForayAssignId.java	2022-02-01 20:03:40 UTC (rev 12532)
@@ -115,6 +115,9 @@
      * so far. */
     private Map<Element, AncestorInfo> counterMap = new HashMap<Element, AncestorInfo>();
 
+    /**
+     * Stores the information for one ancestor node.
+     */
     private class AncestorInfo {
 
         /** The number of Para-level children counted so far. */

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