diff --git a/core/src/main/java/org/verapdf/core/JAXBCollection.java b/core/src/main/java/org/verapdf/core/JAXBCollection.java
index 8d6adeec9..5a59e0e7c 100644
--- a/core/src/main/java/org/verapdf/core/JAXBCollection.java
+++ b/core/src/main/java/org/verapdf/core/JAXBCollection.java
@@ -51,9 +51,9 @@
/**
* Generic collection wrapper class.
*
- * Makes it easier to (un)marshall a collectiono of a single type.
+ * Makes it easier to (un)marshall a collection of a single type.
*
- * @author Arno Moonen
+ *
* Part 1 does not allow a conformance level u (Unicode) so there are eight
* valid combinations of specification part and level, shown below:
* Map
Map<K, V>
instance used to initialise the registry.
*/
public MapBackedRegistry(final Map
- *
*
* @param status passed status argument
+ *
* @return result status
*/
public ValidationStatus getStatus(ValidationStatus status) {
diff --git a/core/src/main/java/org/verapdf/pdfa/PDFAValidator.java b/core/src/main/java/org/verapdf/pdfa/PDFAValidator.java
index f6fd272f0..10b5c851b 100644
--- a/core/src/main/java/org/verapdf/pdfa/PDFAValidator.java
+++ b/core/src/main/java/org/verapdf/pdfa/PDFAValidator.java
@@ -56,14 +56,10 @@ public interface PDFAValidator extends Component {
*
* @param toValidate
* a {@link java.io.InputStream} to be validated
- * @return a {@link ValidationResult} containing the result of valdiation
+ * @return a {@link ValidationResult} containing the result of validation
* and details of failed checks and possibly passed checks,
* dependent upon configuration.
- * @throws ValidationException
- * @throws org.verapdf.core.ModelParsingException
- * @throws IllegalArgumentException
- * if the toValidate parameter is null PDFAValidationException
- * if the validation process fails
+ * @throws ValidationException
*/
public ValidationResult validate(PDFAParser toValidate) throws ValidationException;
diff --git a/core/src/main/java/org/verapdf/pdfa/flavours/PDFAFlavour.java b/core/src/main/java/org/verapdf/pdfa/flavours/PDFAFlavour.java
index 2e102a607..1d18fd378 100644
--- a/core/src/main/java/org/verapdf/pdfa/flavours/PDFAFlavour.java
+++ b/core/src/main/java/org/verapdf/pdfa/flavours/PDFAFlavour.java
@@ -28,43 +28,40 @@
import java.util.Set;
/**
- * Enums used as id for PDF/A flavours where a flavour uniquely identifies a
- * specific PDF/A Standard part and associated conformance level.
- *
- * The PDF/A Specification:
*
- * Current value
* Passed value
* Result value
*
+ *
* INVALID_DOCUMENT
*
*
- *
- * INVALID_DOCUMENT
@@ -117,8 +113,7 @@ public static ValidationStatus valueOf(int index) {
* VALID
* INVALID_DOCUMENT
*
+ *
* INVALID_STRUCTURE
*
*
- *
- * INVALID_DOCUMENT
@@ -136,8 +131,7 @@ public static ValidationStatus valueOf(int index) {
* VALID
* INVALID_STRUCTURE
*
+ *
* INVALID_METADATA
*
*
- *
- * INVALID_DOCUMENT
@@ -155,8 +149,7 @@ public static ValidationStatus valueOf(int index) {
* VALID
* INVALID_METADATA
*
+ *
* VALID
*
*
- *
- *
* INVALID_DOCUMENT
@@ -174,11 +167,10 @@ public static ValidationStatus valueOf(int index) {
* VALID
* VALID
*
- * ISO 19005 - Document Management - Electronic document format for long-term
- * preservation (PDF/A)
+ * Enums used as id for PDF/A flavours where a flavour uniquely identifies a specific PDF/A Standard part and
+ * associated conformance level. The PDF/A Specification:
+ * ISO 19005 - Document Management - Electronic document format for long-term preservation (PDF/A)
* comprises 4 parts:
*
- *
+ *
* Note that "Use of ISO 32000-1" indicates that PDF/A parts 2 and 3 are based
* upon PDF 1.7. ISO 32000-1 is the code for the PDF 1.7 ISO standard. The
* specification parts specify different conformance levels:
*
- *
- * Part 1 does not allow a conformance level u (Unicode) so there are eight
+ *
- *
*
* @author Carl Wilson
@@ -332,9 +329,8 @@ public String toString() {
}
/**
- * Enum type that identifies the different PDF/A Conformance Levels A
- * (accessible), B (basic), U (unicode), F (embedded files) & E (engineering).
- *
+ * Enum type that identifies the different PDF/A Conformance Levels A (accessible), B (basic), U (unicode),
+ * F (embedded files) & E (engineering).
*/
public enum Level {
/** Special identifier for the none case */
diff --git a/core/src/main/java/org/verapdf/pdfa/package-info.java b/core/src/main/java/org/verapdf/pdfa/package-info.java
index d9ab37ccc..42f54139f 100644
--- a/core/src/main/java/org/verapdf/pdfa/package-info.java
+++ b/core/src/main/java/org/verapdf/pdfa/package-info.java
@@ -24,11 +24,10 @@
* Developers wishing to integrate veraPDF PDF/A validation into
* their own Java applications should only need to use:
*
- *
- *
List
of arguments to substitute into the error message
+ * List<String>
of arguments to substitute into the error message
*
* @author Carl Wilson
*
diff --git a/core/src/main/java/org/verapdf/pdfa/validation/profiles/Profiles.java b/core/src/main/java/org/verapdf/pdfa/validation/profiles/Profiles.java
index 189c5b319..834a748d6 100644
--- a/core/src/main/java/org/verapdf/pdfa/validation/profiles/Profiles.java
+++ b/core/src/main/java/org/verapdf/pdfa/validation/profiles/Profiles.java
@@ -47,15 +47,13 @@
* typeNameToXml(...)
, to facilitate XML
* serialisation to Strings, OutputStreams and Writers.typeNameFromXml(...)
, to facilitate XML
- * deserialisation.* TODO: Defensive Checks for all parameters. - *
- * + * * @author Carl Wilson */ public final class Profiles { @@ -407,21 +405,16 @@ public static Variable variableFromValues(final String name, final String object /** * Convert a {@link ValidationProfile} instance into an XML String. - * - * @param toConvert - * a {@link ValidationProfile} to convert to an XML String - * @param format - * set to Boolean.TRUE for pretty formatted XML, Boolean.FALSE - * for no space formatting + * + * @param toConvert a {@link ValidationProfile} to convert to an XML String + * @param format set to Boolean.TRUE for pretty formatted XML, Boolean.FALSE + * for no space formatting + * * @return a String xml representation of toConvert - * @throws JAXBException - * thrown by JAXB marshaller if there's an error converting the - * object - * @throws IOException - * thrown when's there's a problem closing the underlying - * StringWriter - * @throws IllegalArgumentException - * if toConvert is null + * + * @throws JAXBException thrown by JAXB marshaller if there's an error converting the + * object + * @throws IllegalArgumentException if toConvert is null */ public static String profileToXml(final ValidationProfile toConvert, boolean format, boolean fragment) throws JAXBException { diff --git a/core/src/main/java/org/verapdf/processor/BatchProcessingHandler.java b/core/src/main/java/org/verapdf/processor/BatchProcessingHandler.java index 0ed1f7b1a..a3be1cd4a 100644 --- a/core/src/main/java/org/verapdf/processor/BatchProcessingHandler.java +++ b/core/src/main/java/org/verapdf/processor/BatchProcessingHandler.java @@ -53,14 +53,13 @@ public interface BatchProcessingHandler extends Closeable { public void handleBatchStart(ProcessorConfig config) throws VeraPDFException; /** - * This method is called by the {@link BatchProcessor} after each item in - * the batch is processed allowing the implementor to take specific action - * for each item processed. - * - * @param result - * the {@link ProcessorResult} for the last item processed. - * @throws VeraPDFException - * if there's a problem with the particular result. + * This method is called by the {@link BatchProcessor} after each item in the batch is processed allowing the + * implementor to take specific action for each item processed. + * + * @param result the {@link ProcessorResult} for the last item processed. + * @param isLogsEnabled flag if logs are enabled or not + * + * @throws VeraPDFException if there's a problem with the particular result. */ public void handleResult(ProcessorResult result, Boolean isLogsEnabled) throws VeraPDFException; diff --git a/core/src/main/java/org/verapdf/report/XmpHandler.java b/core/src/main/java/org/verapdf/report/XmpHandler.java index 421932b04..23de3724e 100644 --- a/core/src/main/java/org/verapdf/report/XmpHandler.java +++ b/core/src/main/java/org/verapdf/report/XmpHandler.java @@ -47,7 +47,6 @@ * * Regarding the FeatureReporting mechanism, it's crying out for a generics * based approach but that can come over the re-design. - * * * @author Carl Wilson */ diff --git a/xmp-core/src/main/java/org/verapdf/xmp/XMPMetaFactory.java b/xmp-core/src/main/java/org/verapdf/xmp/XMPMetaFactory.java index abb248be7..10618cc3a 100644 --- a/xmp-core/src/main/java/org/verapdf/xmp/XMPMetaFactory.java +++ b/xmp-core/src/main/java/org/verapdf/xmp/XMPMetaFactory.java @@ -87,7 +87,7 @@ public static XMPMeta parse(InputStream in) throws XMPException * The available options are: *<rdf:RDF>
.
* *
* *@@ -76,7 +75,7 @@ private XMPPathFactory() * 0 and below means last array item and renders as[last()]
. * * @return Returns the composed path basing on fullPath. This will be of the form - * ns:arrayName[i], where "ns" is the prefix for schemaNS and + *ns:arrayName[i]
, where "ns" is the prefix for schemaNS and * "i" is the decimal representation of itemIndex. * @throws XMPException Throws exeption if index zero is used. */ @@ -107,7 +106,7 @@ else if (itemIndex == XMPConst.ARRAY_LAST_ITEM) * @param fieldName The name of the field. Must be a simple XML name, must not be *null
or the empty string. * @return Returns the composed path. This will be of the form - * ns:structName/fNS:fieldName, where "ns" is the prefix for + *ns:structName/fNS:fieldName
, where "ns" is the prefix for * schemaNS and "fNS" is the prefix for fieldNS. * @throws XMPException Thrown if the path to create is not valid. */ @@ -135,7 +134,7 @@ public static String composeStructFieldPath(String fieldNS, * @param qualName The name of the qualifier. Must be a simple XML name, must not be *null
or the empty string. * @return Returns the composed path. This will be of the form - * ns:propName/?qNS:qualName, where "ns" is the prefix for + *ns:propName/?qNS:qualName
, where "ns" is the prefix for * schemaNS and "qNS" is the prefix for qualNS. * @throws XMPException Thrown if the path to create is not valid. */ @@ -161,7 +160,7 @@ public static String composeQualifierPath( * path syntax allows two forms of "content addressing" that may * be used to select an item in an array of alternatives. The form used in * ComposeLangSelector lets you select an item in an alt-text array based on - * the value of its xml:lang qualifier. The other form of content + * the value of itsxml:lang
qualifier. The other form of content * addressing is shown in ComposeFieldSelector. \note ComposeLangSelector * does not supplant SetLocalizedText or GetLocalizedText. They should * generally be used, as they provide extra logic to choose the appropriate @@ -175,7 +174,7 @@ public static String composeQualifierPath( * @param langName * The RFC 3066 code for the desired language. * @return Returns the composed path. This will be of the form - * ns:arrayName[@xml:lang='langName'], where + *ns:arrayName[@xml:lang='langName']
, where * "ns" is the prefix for schemaNS. */ public static String composeLangSelector(String arrayName, @@ -214,7 +213,7 @@ public static String composeLangSelector(String arrayName, * itself simple. * @param fieldValue The desired value of the field. * @return Returns the composed path. This will be of the form - * ns:arrayName[fNS:fieldName='fieldValue'], where "ns" is the + *ns:arrayName[fNS:fieldName='fieldValue']
, where "ns" is the * prefix for schemaNS and "fNS" is the prefix for fieldNS. * @throws XMPException Thrown if the path to create is not valid. */ diff --git a/xmp-core/src/main/java/org/verapdf/xmp/XMPUtils.java b/xmp-core/src/main/java/org/verapdf/xmp/XMPUtils.java index 3b1663f60..414d0622f 100644 --- a/xmp-core/src/main/java/org/verapdf/xmp/XMPUtils.java +++ b/xmp-core/src/main/java/org/verapdf/xmp/XMPUtils.java @@ -255,7 +255,7 @@ public static void appendProperties(XMPMeta source, XMPMeta dest, boolean doAllP *"t" and "f" * "on" and "off" * "yes" and "no" - * "value <> 0" and "value == 0" + * "value <> 0" and "value == 0" * * @throws XMPException If an empty string is passed. */ diff --git a/xmp-core/src/main/java/org/verapdf/xmp/impl/ByteBuffer.java b/xmp-core/src/main/java/org/verapdf/xmp/impl/ByteBuffer.java index 96862a661..91b5185e2 100644 --- a/xmp-core/src/main/java/org/verapdf/xmp/impl/ByteBuffer.java +++ b/xmp-core/src/main/java/org/verapdf/xmp/impl/ByteBuffer.java @@ -184,7 +184,7 @@ public void append(byte b) * * @param bytes a byte array * @param offset an offset with - * @param len + * @param len a buffer length */ public void append(byte[] bytes, int offset, int len) { diff --git a/xmp-core/src/main/java/org/verapdf/xmp/impl/xpath/package.html b/xmp-core/src/main/java/org/verapdf/xmp/impl/xpath/package.html index e444a8711..244b5c152 100644 --- a/xmp-core/src/main/java/org/verapdf/xmp/impl/xpath/package.html +++ b/xmp-core/src/main/java/org/verapdf/xmp/impl/xpath/package.html @@ -7,6 +7,6 @@ Package containing the XMPPath handling.
-An XMPPath a simplified form of an XPath, used only to create or retrieve properties in an XMPMeta object.
+
An XMPPath a simplified form of an XPath, used only to create or retrieve properties in an XMPMeta object.