Fix JavaDoc

core/src/main/java/org/verapdf/core/Registry.java

@@ -101,14 +101,14 @@ public interface Registry<K, V> extends Directory<K, V> {
      * @param value
      *            the value used in the update
      * @return the old value of the item
-     * @throws NoSuchElementException
+     * @throws java.util.NoSuchElementException
      *             if no value is associated with the key
      */
     V updateItem(final K key, final V value);
 
     /**
      * @param itemMap
-     * @throws NoSuchElementException
+     * @throws java.util.NoSuchElementException
      *             if no value is associated with one of the keys
      */
     void updateItems(final Map<K, V> itemMap);

core/src/main/java/org/verapdf/features/tools/ErrorsHelper.java

@@ -44,10 +44,10 @@ private ErrorsHelper() {
 	}
 
 	/**
-	 * Adds an error to a {@link FeaturesCollection}
+	 * Adds an error to a {@link FeatureExtractionResult}
 	 *
 	 * @param collection
-	 *            the {@link FeaturesCollection} to add the error to
+	 *            the {@link FeatureExtractionResult} to add the error to
 	 * @param element
 	 *            element which contains error
 	 * @param errorMessageArg

core/src/main/java/org/verapdf/features/tools/FeatureTreeNode.java

@@ -70,7 +70,7 @@ public List<FeatureTreeNode> getChildren() {
 	/**
 	 * Add a child to the node
 	 *
-	 * @param child
+	 * @param nodeName
 	 *            new child node for the current node
 	 * @throws FeatureParsingException
 	 *             occurs when child adds to node with value or if the node is a
@@ -84,7 +84,7 @@ public FeatureTreeNode addChild(String nodeName) throws FeatureParsingException
 	/**
 	 * Add a child to the node
 	 *
-	 * @param child
+	 * @param nodeName
 	 *            new child node for the current node
 	 * @throws FeatureParsingException
 	 *             occurs when child adds to node with value or if the node is a

core/src/main/java/org/verapdf/metadata/fixer/entity/InfoDictionary.java

@@ -26,7 +26,7 @@
 
 /**
  * Current interface provide necessary behavior of pdf document
- * information dictionary. {@link MetadataFixerImpl}
+ * information dictionary. {@link org.verapdf.pdfa.MetadataFixer}
  * check next entries:
  * <ul>
  *     <li>Title</li>

core/src/main/java/org/verapdf/metadata/fixer/entity/Metadata.java

@@ -28,7 +28,7 @@
 
 /**
  * Current interface provide necessary behavior of pdf metadata
- * for {@link MetadataFixerImpl}
+ * for {@link org.verapdf.pdfa.MetadataFixer}
  *
  * @author Evgeniy Muravitskiy
  */

core/src/main/java/org/verapdf/metadata/fixer/entity/PDFDocument.java

@@ -27,7 +27,7 @@
 
 /**
  * Current interface provide necessary behavior of pdf document
- * for {@link MetadataFixerImpl}
+ * for {@link org.verapdf.pdfa.MetadataFixer}
  *
  * @author Evgeniy Muravitskiy
  */
@@ -59,7 +59,7 @@ public interface PDFDocument {
 	/**
 	 * Incremental save of pdf document. Document must be saved if and
 	 * only if metadata or information dictionary of document was changed.
-	 * In {@link MetadataFixerResultImpl} must set 1 of 3 states:
+	 * In {@link org.verapdf.pdfa.results.MetadataFixerResultImpl} must set 1 of 3 states:
 	 * <ul>
 	 * <li>
 	 * {@link org.verapdf.pdfa.results.MetadataFixerResult.RepairStatus#FIX_ERROR}
@@ -75,7 +75,7 @@ public interface PDFDocument {
 	 * </li>
 	 * </ul>
 	 *
-	 * @param report result of {@code MetadataFixerImpl} handling
+	 * @param status result of {@code MetadataFixerImpl} handling
 	 * @param output output stream for document save
 	 * @return 
 	 */

core/src/main/java/org/verapdf/metadata/fixer/utils/ValidationStatus.java

@@ -41,11 +41,13 @@
  * as other than metadata rules
  * </li>
  * </ul>
- * According to this status {@link MetadataFixerImpl}
+ * According to this status {@link org.verapdf.pdfa.MetadataFixer}
  * run different handling of document.
  *
  * @author Evgeniy Muravitskiy
- * @see MetadataFixerImpl#fixAndSaveDocument(OutputStream, FixerConfig)
+ * @see org.verapdf.metadata.fixer.gf.MetadataFixerImpl#fixAndSaveDocument(java.io.OutputStream, 
+ * org.verapdf.metadata.fixer.entity.PDFDocument, org.verapdf.pdfa.results.ValidationResult, boolean, 
+ * org.verapdf.metadata.fixer.utils.parser.ProcessedObjectsParser)
  * @see org.verapdf.metadata.fixer.utils.ProcessedObjectsInspector
  */
 public enum ValidationStatus {

core/src/main/java/org/verapdf/pdfa/PDFAParser.java

@@ -43,7 +43,7 @@
  */
 public interface PDFAParser extends Component {
 	/**
-	 * @return the {@link CosDocument} element that is the root object of the
+	 * @return the {@link org.verapdf.model.coslayer.CosDocument} element that is the root object of the
 	 *         validation model instance.
 	 * @throws ModelParsingException
 	 *             when there's a problem establishing the model root.

core/src/main/java/org/verapdf/pdfa/PDFAValidator.java

@@ -32,7 +32,7 @@
  *
  * Note that the interface makes no provision for configuration of a validator
  * instance. This is left to the implementer although the veraPDF library API
- * provides a {@link Validators} class. This is designed to allow
+ * provides a {@link org.verapdf.pdfa.validation.validators.ValidatorFactory} class. This is designed to allow
  * immutable validator instances, meaning there is no methods provided to change
  * the ValidationProfile, or the pre-configured settings.
  *
@@ -58,7 +58,7 @@ public interface PDFAValidator extends Component {
      *         and details of failed checks and possibly passed checks,
      *         dependent upon configuration.
      * @throws ValidationException 
-     * @throws ModelParsingException 
+     * @throws org.verapdf.core.ModelParsingException 
      * @throws IllegalArgumentException
      *             if the toValidate parameter is null PDFAValidationException
      *             if the validation process fails

core/src/main/java/org/verapdf/pdfa/VeraPDFFoundry.java

@@ -44,7 +44,7 @@
 public interface VeraPDFFoundry extends Component {
 	/**
 	 * Method that returns a PDFParser instance, parsing the passed
-	 * {@link pdfStream} parameter. The parser or parser provider will detect
+	 * {@param pdfStream} parameter. The parser or parser provider will detect
 	 * the flavour of the PDF document stream and provide an appropriate parser.
 	 *
 	 * @param pdfStream
@@ -60,7 +60,7 @@ public interface VeraPDFFoundry extends Component {
 
 	/**
 	 * Method that returns a PDFParser instance, parsing the passed
-	 * {@link pdfStream} parameter. The caller must explicitly state the flavour
+	 * {@param pdfStream} parameter. The caller must explicitly state the flavour
 	 * of the PDF document stream.
 	 *
 	 * @param pdfStream
@@ -90,7 +90,7 @@ public PDFAParser createParser(InputStream pdfStream, PDFAFlavour flavour, PDFAF
 
 	/**
 	 * Method that returns a PDFParser instance, parsing file passed as
-	 * {@link pdfFile} parameter. The caller must explicitly state the flavour
+	 * {@param pdfFile} parameter. The caller must explicitly state the flavour
 	 * of the PDF document stream.
 	 *
 	 * @param pdfFile {@link File} with PDF document to be parsed.
@@ -116,7 +116,7 @@ public PDFAParser createParser(File pdfFile, PDFAFlavour flavour, PDFAFlavour de
 
 	/**
 	 * Method that returns a PDFParser instance, parsing file passed as
-	 * {@link pdfFile} parameter. The parser or parser provider will detect
+	 * {@param pdfFile} parameter. The parser or parser provider will detect
 	 * the flavour of the PDF document stream and provide an appropriate parser.
 	 *
 	 * @param pdfFile
@@ -171,9 +171,9 @@ public PDFAParser createParser(File pdfFile)
 	 * Creates a new {@link PDFAValidator} instance that uses one of the
 	 * {@link ValidationProfile}s packaged as a core library resource. While
 	 * these profiles are not guaranteed to be up to date, they are available
-	 * when offline. A {@link ProfileDirectory} populated with the pre-loaded
+	 * when offline. A {@link org.verapdf.pdfa.validation.profiles.ProfileDirectory} populated with the pre-loaded
 	 * profiles can be obtained by calling
-	 * {@link Profiles#getVeraProfileDirectory()}.
+	 * {@link org.verapdf.pdfa.validation.profiles.Profiles#getVeraProfileDirectory()}.
 	 *
 	 * @param flavour
 	 *            the {@link PDFAFlavour} that's associated with the

core/src/main/java/org/verapdf/pdfa/results/MetadataFixerResult.java

@@ -29,7 +29,7 @@
 
 /**
  * Holds the result of an attempt to repair PDF/A metadata by a
- * {@link MetadataFixer}.
+ * {@link org.verapdf.pdfa.MetadataFixer}.
  * 
  * @author <a href="mailto:[email protected]">Carl Wilson</a>
  */

core/src/main/java/org/verapdf/pdfa/results/TestAssertion.java

@@ -43,7 +43,7 @@ public interface TestAssertion {
      */
     public int getOrdinal();
     /**
-     * @return the String id for the {@link org.verapdf.validation.profiles.Rule} that this assertion refers to
+     * @return the String id for the {@link org.verapdf.pdfa.validation.profiles.Rule} that this assertion refers to
      */
     public RuleId getRuleId();
 

core/src/main/java/org/verapdf/pdfa/validation/profiles/Profiles.java

@@ -410,7 +410,7 @@ public static Variable variableFromValues(final String name, final String object
 	 * 
 	 * @param toConvert
 	 *            a {@link ValidationProfile} to convert to an XML String
-	 * @param prettyXml
+	 * @param format
 	 *            set to Boolean.TRUE for pretty formatted XML, Boolean.FALSE
 	 *            for no space formatting
 	 * @return a String xml representation of toConvert
@@ -438,7 +438,7 @@ public static String profileToXml(final ValidationProfile toConvert, boolean for
 	 *            a {@link ValidationProfile} to convert to an XML String
 	 * @param dest
 	 *            an OutputStream used to write the generated XML to
-	 * @param prettyXml
+	 * @param format
 	 *            set to Boolean.TRUE for pretty formatted XML, Boolean.FALSE
 	 *            for no space formatting
 	 * @throws JAXBException
@@ -481,7 +481,7 @@ public static ValidationProfile profileFromXml(final InputStream source) throws
 	 *            a {@link ValidationProfile} to convert to an XML String
 	 * @param dest
 	 *            a Writer used to write the generated XML to
-	 * @param prettyXml
+	 * @param format
 	 *            set to Boolean.TRUE for pretty formatted XML, Boolean.FALSE
 	 *            for no space formatting
 	 * @throws JAXBException

core/src/main/java/org/verapdf/pdfa/validation/profiles/Reference.java

@@ -34,8 +34,7 @@
 @XmlJavaTypeAdapter(ReferenceImpl.Adapter.class)
 public interface Reference {
     /**
-     * @return a {@link Specification} that identifies the PDF/A Specification
-     *         referred to.
+     * @return a {@link String} that identifies the Specification referred to.
      */
     public String getSpecification();
 

core/src/main/java/org/verapdf/processor/FormatOption.java

@@ -35,7 +35,7 @@ public enum FormatOption {
      */
     RAW("raw"),
     /**
-     * Output in {@link MachineReadableReport} XML format
+     * Output in machine readable report XML format
      */
     MRR("mrr"),
     XML("xml"),

core/src/main/java/org/verapdf/processor/ProcessorResultImpl.java

@@ -40,7 +40,8 @@
 
 /**
  * Instance of this class contains result of
- * {@link org.verapdf.processor.ProcessorImpl#validate(InputStream, ItemDetails, Config, OutputStream)}
+ * {@link org.verapdf.processor.ItemProcessor#process(ItemDetails, java.io.InputStream)} and 
+ * {@link org.verapdf.processor.ItemProcessor#process(java.io.File)}
  * work.
  *
  * @author Sergey Shemyakov

core/src/main/java/org/verapdf/processor/RawResultHandler.java

@@ -63,7 +63,7 @@ private RawResultHandler(final Writer dest, final boolean format, final boolean
 	}
 
 	/**
-	 * @see org.verapdf.processor.BatchProcessingHandler#handleBatchStart()
+	 * @see org.verapdf.processor.BatchProcessingHandler#handleBatchStart(ProcessorConfig) ()
 	 */
 	@Override
 	public void handleBatchStart(ProcessorConfig procConfig) throws VeraPDFException {
@@ -133,7 +133,7 @@ void resultEnd(ProcessorResult result, Boolean isLogsEnabled) {
 	}
 
 	/**
-	 * @see org.verapdf.processor.BatchProcessingHandler#handleBatchEnd(org.verapdf.processor.BatchSummary)
+	 * @see org.verapdf.processor.BatchProcessingHandler#handleBatchEnd(BatchSummary)
 	 */
 	@Override
 	public void handleBatchEnd(BatchSummary summary) throws VeraPDFException {

core/src/main/java/org/verapdf/processor/reports/Reports.java

@@ -50,18 +50,8 @@ private Reports() {
 	 * @param timer
 	 *            a {@link org.verapdf.component.Components.Timer} instance
 	 *            which is stopped to measure the duration of the batch process
-	 * @param jobs
+	 * @param totalJobs
 	 *            the number of jobs in the batch
-	 * @param failedJobs
-	 *            the number o failed jobs in the batch
-	 * @param valid
-	 *            the number of valid PDF/A documents in the batch
-	 * @param inValid
-	 *            the number of invalid PDF/A documents in the batch
-	 * @param validExcep
-	 *            the number of validation jobs that threw exceptions
-	 * @param features
-	 *            the number of feature extraction jobs run
 	 * @return a new {@link BatchSummary} instance created using the passed
 	 *         values
 	 */