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 + * @author Arno Moonen */ public class JAXBCollection { diff --git a/core/src/main/java/org/verapdf/core/MapBackedRegistry.java b/core/src/main/java/org/verapdf/core/MapBackedRegistry.java index 961e7ffdf..45a08f5c4 100644 --- a/core/src/main/java/org/verapdf/core/MapBackedRegistry.java +++ b/core/src/main/java/org/verapdf/core/MapBackedRegistry.java @@ -49,9 +49,8 @@ public MapBackedRegistry() { /** * Creates a registry instance initialise using the passed map - * - * @param map - * a Map instance used to initialise the registry. + * + * @param map a Map<K, V> instance used to initialise the registry. */ public MapBackedRegistry(final Map map) { super(map); diff --git a/core/src/main/java/org/verapdf/core/Registry.java b/core/src/main/java/org/verapdf/core/Registry.java index ef11aef49..4da5d8215 100644 --- a/core/src/main/java/org/verapdf/core/Registry.java +++ b/core/src/main/java/org/verapdf/core/Registry.java @@ -48,7 +48,7 @@ public interface Registry extends Directory { V registerItem(final K key, final V value); /** - * Add a Map of items to the Registry + * Add a Map<K, V> of items to the Registry * * @param itemMap */ @@ -86,9 +86,8 @@ public interface Registry extends Directory { /** * Registers or updates all item in Registry caring not if the items already * exist or not. - * - * @param itemMap - * a Map of keys & values to add. + * + * @param itemMap a Map of keys & values to add. */ void putdateItems(final Map itemMap); diff --git a/core/src/main/java/org/verapdf/metadata/fixer/utils/ProcessedObjectsInspector.java b/core/src/main/java/org/verapdf/metadata/fixer/utils/ProcessedObjectsInspector.java index 1d8b1c8b0..e1fccfa2f 100644 --- a/core/src/main/java/org/verapdf/metadata/fixer/utils/ProcessedObjectsInspector.java +++ b/core/src/main/java/org/verapdf/metadata/fixer/utils/ProcessedObjectsInspector.java @@ -110,10 +110,6 @@ public static ValidationStatus validationStatus( * @param objects * metadata failed rules type * @return validation status - * @throws IOException - * @throws URISyntaxException - * @throws ParserConfigurationException - * @throws SAXException */ public static ValidationStatus validationStatus( List assertions, ValidationProfile profile, diff --git a/core/src/main/java/org/verapdf/metadata/fixer/utils/ValidationStatus.java b/core/src/main/java/org/verapdf/metadata/fixer/utils/ValidationStatus.java index 8dd260d0e..c7df447f4 100644 --- a/core/src/main/java/org/verapdf/metadata/fixer/utils/ValidationStatus.java +++ b/core/src/main/java/org/verapdf/metadata/fixer/utils/ValidationStatus.java @@ -45,9 +45,6 @@ * run different handling of document. * * @author Evgeniy Muravitskiy - * @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 { @@ -89,17 +86,16 @@ public static ValidationStatus valueOf(int index) { /** * Return combination of current status and given status according to next table: + *

+ * * - * - * - * - * + * * * * * * - * + * * * * @@ -117,8 +113,7 @@ public static ValidationStatus valueOf(int index) { * * * - * - * + * * * * @@ -136,8 +131,7 @@ public static ValidationStatus valueOf(int index) { * * * - * - * + * * * * @@ -155,8 +149,7 @@ public static ValidationStatus valueOf(int index) { * * * - * - * + * * * * @@ -174,11 +167,10 @@ public static ValidationStatus valueOf(int index) { * * * - * - * *
Table: Validation status
Current valuePassed valueResult value
INVALID_DOCUMENT
INVALID_DOCUMENTVALIDINVALID_DOCUMENT
INVALID_STRUCTURE
INVALID_DOCUMENTVALIDINVALID_STRUCTURE
INVALID_METADATA
INVALID_DOCUMENTVALIDINVALID_METADATA
VALID
INVALID_DOCUMENTVALIDVALID
* * @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:
- * 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: *

    - *
  1. Part 1: PDF/A-1 - Use of PDF 1.4
  2. - *
  3. Part 2: PDF/A-2 - Use of ISO 32000-1
  4. - *
  5. Part 3: PDF/A-3 - Use of ISO 32000-1 with support for embedded files
  6. - *
  7. Part 4: PDF/A-4 - Use of ISO 32000-2
  8. - *
      + *
    1. Part 1: PDF/A-1 - Use of PDF 1.4 + *
    2. Part 2: PDF/A-2 - Use of ISO 32000-1 + *
    3. Part 3: PDF/A-3 - Use of ISO 32000-1 with support for embedded files + *
    4. Part 4: PDF/A-4 - Use of ISO 32000-2 + *
    * 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: *
      - *
    • Level b - basic
    • - *
    • Level a - accessible
    • - *
    • Level u - unicode
    • - *
    • Level f - embedded files
    • - *
    • Level e - engineering
    • + *
    • Level b - basic + *
    • Level a - accessible + *
    • Level u - unicode + *
    • Level f - embedded files + *
    • Level e - engineering *
    - * Part 1 does not allow a conformance level u (Unicode) so there are eight + *

    Part 1 does not allow a conformance level u (Unicode) so there are eight * valid combinations of specification part and level, shown below: *

      - *
    • 1a
    • - *
    • 1b
    • - *
    • 2a
    • - *
    • 2b
    • - *
    • 2u
    • - *
    • 3a
    • - *
    • 3b
    • - *
    • 3u
    • - *
    • 4
    • - *
    • 4f
    • - *
    • 4e
    • + *
    • 1a + *
    • 1b + *
    • 2a + *
    • 2b + *
    • 2u + *
    • 3a + *
    • 3b + *
    • 3u + *
    • 4 + *
    • 4f + *
    • 4e *
    * * @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: *
      - *
    • {@link org.verapdf.pdfa.ValidatorFactory} to obtain a {@link org.verapdf.pdfa.Validator} instance.
    • + *
    • {@link org.verapdf.pdfa.validation.validators.ValidatorFactory} to configure validator instance.
    • *
    • {@link org.verapdf.pdfa.PDFAValidator} to validate a {@link java.io.InputStream} believed to be a PDF/A document.
    • *
    • {@link org.verapdf.pdfa.flavours.PDFAFlavour} to determine the flavour of PDF/A enforced by a particular validator instance.
    • *
    - *

    * * @author Carl Wilson * @version 0.7 diff --git a/core/src/main/java/org/verapdf/pdfa/validation/profiles/ErrorDetails.java b/core/src/main/java/org/verapdf/pdfa/validation/profiles/ErrorDetails.java index 21033f78c..ee796d44e 100644 --- a/core/src/main/java/org/verapdf/pdfa/validation/profiles/ErrorDetails.java +++ b/core/src/main/java/org/verapdf/pdfa/validation/profiles/ErrorDetails.java @@ -28,7 +28,7 @@ /** * Encapsulates the details of an error message, a String message and a - * 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 @@ *
  9. XML helper methods, typeNameToXml(...), to facilitate XML * serialisation to Strings, OutputStreams and Writers.
  10. *
  11. XML helper methods, typeNameFromXml(...), to facilitate XML - * deserialisation.
  12. + * deserialization. * * Note that XML serialisation and de-serialisation is achieved through JAXB * bindings. - *

    *

    * 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: *
      *
    • XMP_REQUIRE_XMPMETA - The <x:xmpmeta> XML element is required around - * <rdf:RDF>. + * <rdf:RDF>. *
    • XMP_STRICT_ALIASING - Do not reconcile alias differences, throw an exception. *
    * Note:The XMP_STRICT_ALIASING option is not yet implemented. diff --git a/xmp-core/src/main/java/org/verapdf/xmp/XMPPathFactory.java b/xmp-core/src/main/java/org/verapdf/xmp/XMPPathFactory.java index f0b44eabc..49a0f90a7 100644 --- a/xmp-core/src/main/java/org/verapdf/xmp/XMPPathFactory.java +++ b/xmp-core/src/main/java/org/verapdf/xmp/XMPPathFactory.java @@ -29,7 +29,6 @@ * You can use these functions is to compose a complete path expression, or all but the last * component. Suppose you have a property that is an array of integers within a struct. You can * access one of the array items like this: - *

    *

    * *
    @@ -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 its xml: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
     	 *    		    
  13. "t" and "f" *
  14. "on" and "off" *
  15. "yes" and "no" - *
  16. "value <> 0" and "value == 0" + *
  17. "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.

    diff --git a/xmp-core/src/main/java/org/verapdf/xmp/options/Options.java b/xmp-core/src/main/java/org/verapdf/xmp/options/Options.java index 05d1c4de8..9d6c96247 100644 --- a/xmp-core/src/main/java/org/verapdf/xmp/options/Options.java +++ b/xmp-core/src/main/java/org/verapdf/xmp/options/Options.java @@ -92,7 +92,7 @@ public boolean containsOneOf(int optionBits) /** * @param optionBit the binary bit or bits that are requested - * @return Returns if all of the requested bits are set or not. + * @return Returns if all the requested bits are set or not. */ protected boolean getOption(int optionBit) { @@ -122,7 +122,7 @@ public int getOptions() /** * @param options The options to set. - * @throws XMPException + * @throws XMPException Wraps all errors and exceptions that may occur. */ public void setOptions(int options) throws XMPException { diff --git a/xmp-core/src/main/java/org/verapdf/xmp/options/PropertyOptions.java b/xmp-core/src/main/java/org/verapdf/xmp/options/PropertyOptions.java index d15da3f1e..1d3bc6c6c 100644 --- a/xmp-core/src/main/java/org/verapdf/xmp/options/PropertyOptions.java +++ b/xmp-core/src/main/java/org/verapdf/xmp/options/PropertyOptions.java @@ -72,7 +72,7 @@ public PropertyOptions(int options) throws XMPException /** * @return Return whether the property value is a URI. It is serialized to RDF using the - * rdf:resource attribute. Not mandatory for URIs, but considered RDF-savvy. + * rdf:resource attribute. Not mandatory for URIs, but considered RDF-savvy. */ public boolean isURI() { @@ -92,8 +92,8 @@ public PropertyOptions setURI(boolean value) /** - * @return Return whether the property has qualifiers. These could be an xml:lang - * attribute, an rdf:type property, or a general qualifier. See the + * @return Return whether the property has qualifiers. These could be an xml:lang + * attribute, an rdf:type property, or a general qualifier. See the * introductory discussion of qualified properties for more information. */ public boolean getHasQualifiers() @@ -136,7 +136,7 @@ public PropertyOptions setQualifier(boolean value) } - /** @return Return whether this property has an xml:lang qualifier. */ + /** @return Return whether this property has an xml:lang qualifier. */ public boolean getHasLanguage() { return getOption(HAS_LANGUAGE); @@ -154,7 +154,7 @@ public PropertyOptions setHasLanguage(boolean value) } - /** @return Return whether this property has an rdf:type qualifier. */ + /** @return Return whether this property has an rdf:type qualifier. */ public boolean getHasType() { return getOption(HAS_TYPE); @@ -192,7 +192,7 @@ public PropertyOptions setStruct(boolean value) /** * @return Return whether this property is an array. By itself this indicates a general - * unordered array. It is serialized using an rdf:Bag container. + * unordered array. It is serialized using an rdf:Bag container. */ public boolean isArray() { @@ -213,7 +213,7 @@ public PropertyOptions setArray(boolean value) /** * @return Return whether this property is an ordered array. Appears in conjunction with - * getPropValueIsArray(). It is serialized using an rdf:Seq container. + * getPropValueIsArray(). It is serialized using an rdf:Seq container. */ public boolean isArrayOrdered() { @@ -234,7 +234,7 @@ public PropertyOptions setArrayOrdered(boolean value) /** * @return Return whether this property is an alternative array. Appears in conjunction with - * getPropValueIsArray(). It is serialized using an rdf:Alt container. + * getPropValueIsArray(). It is serialized using an rdf:Alt container. */ public boolean isArrayAlternate() { @@ -255,8 +255,8 @@ public PropertyOptions setArrayAlternate(boolean value) /** * @return Return whether this property is an alt-text array. Appears in conjunction with - * getPropArrayIsAlternate(). It is serialized using an rdf:Alt container. - * Each array element is a simple property with an xml:lang attribute. + * getPropArrayIsAlternate(). It is serialized using an rdf:Alt container. + * Each array element is a simple property with an xml:lang attribute. */ public boolean isArrayAltText() { diff --git a/xmp-core/src/main/java/org/verapdf/xmp/options/SerializeOptions.java b/xmp-core/src/main/java/org/verapdf/xmp/options/SerializeOptions.java index 7978aff3b..fb77cb7cc 100644 --- a/xmp-core/src/main/java/org/verapdf/xmp/options/SerializeOptions.java +++ b/xmp-core/src/main/java/org/verapdf/xmp/options/SerializeOptions.java @@ -35,7 +35,7 @@ public final class SerializeOptions extends Options /** Use the canonical form of RDF if set. By default the compact form is used */ public static final int USE_CANONICAL_FORMAT = 0x0080; /** - * Include a padding allowance for a thumbnail image. If no xmp:Thumbnails property + * Include a padding allowance for a thumbnail image. If no xmp:Thumbnails property * is present, the typical space for a JPEG thumbnail is used. */ public static final int INCLUDE_THUMBNAIL_PAD = 0x0100; @@ -44,7 +44,7 @@ public final class SerializeOptions extends Options * computed. An exception is thrown if the packet exceeds this length with no padding. */ public static final int EXACT_PACKET_LENGTH = 0x0200; - /** Omit the <x:xmpmeta&bt;-tag */ + /** Omit the <x:xmpmeta>-tag */ public static final int OMIT_XMPMETA_ELEMENT = 0x1000; /** Sort the struct properties and qualifier before serializing */ public static final int SORT = 0x2000; diff --git a/xmp-core/src/main/java/org/verapdf/xmp/options/package.html b/xmp-core/src/main/java/org/verapdf/xmp/options/package.html index d2e56d0fa..1b6b0bdc5 100644 --- a/xmp-core/src/main/java/org/verapdf/xmp/options/package.html +++ b/xmp-core/src/main/java/org/verapdf/xmp/options/package.html @@ -7,7 +7,7 @@

    Package containing the option classes.

    -

    These are used to configure diverse function calls of xmpcore:

    +

    These are used to configure diverse function calls of xmpcore:

    • PropertyOptions - these are used to create properties and also to retrieve information about simple, array or struct properties, as well as qualifiers
    • ParseOptions - used to configure the parsing of xmp metadata packets diff --git a/xmp-core/src/main/java/org/verapdf/xmp/properties/package.html b/xmp-core/src/main/java/org/verapdf/xmp/properties/package.html index 19e742772..acc65785d 100644 --- a/xmp-core/src/main/java/org/verapdf/xmp/properties/package.html +++ b/xmp-core/src/main/java/org/verapdf/xmp/properties/package.html @@ -8,6 +8,6 @@

      Package containing the property information classes.

      XMPProperty and XMPPropertyInfo are used to report properties when they are retrieved by get-methods or by the iterator. - XMPAliasInfo informs about a certain property-to-property alias.

      + XMPAliasInfo informs about a certain property-to-property alias.