Author: msahyoun
Date: Sat Jun 21 10:05:03 2014
New Revision: 1604331
URL: http://svn.apache.org/r1604331
Log:
PDFBOX-2155 Fix JavaDocs warnings
Modified:
pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/XMPMetadata.java
pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/schema/DublinCoreSchema.java
pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/schema/XMPMediaManagementSchema.java
pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/schema/XMPSchema.java
pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/type/AbstractField.java
pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/type/Attribute.java
pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/type/ComplexPropertyContainer.java
pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/type/LayerType.java
pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/type/PropertiesDescription.java
pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/type/ResourceEventType.java
pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/type/ResourceRefType.java
pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/type/ThumbnailType.java
pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/type/TypeMapping.java
pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/type/VersionType.java
pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/xml/DomHelper.java
Modified:
pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/XMPMetadata.java
URL:
http://svn.apache.org/viewvc/pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/XMPMetadata.java?rev=1604331&r1=1604330&r2=1604331&view=diff
==============================================================================
--- pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/XMPMetadata.java
(original)
+++ pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/XMPMetadata.java
Sat Jun 21 10:05:03 2014
@@ -461,7 +461,7 @@ public class XMPMetadata
/***
* create and add Photoshop Schema to this metadata. This method return
the created schema to enter information
*
- * @return
+ * @return schema added in order to work on it
*/
public PhotoshopSchema createAndAddPhotoshopSchema()
{
Modified:
pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/schema/DublinCoreSchema.java
URL:
http://svn.apache.org/viewvc/pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/schema/DublinCoreSchema.java?rev=1604331&r1=1604330&r2=1604331&view=diff
==============================================================================
---
pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/schema/DublinCoreSchema.java
(original)
+++
pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/schema/DublinCoreSchema.java
Sat Jun 21 10:05:03 2014
@@ -399,8 +399,8 @@ public class DublinCoreSchema extends XM
/**
* set default title
*
- * @param lang
* @param value
+ * Value to set
*/
public void setTitle(String value)
{
Modified:
pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/schema/XMPMediaManagementSchema.java
URL:
http://svn.apache.org/viewvc/pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/schema/XMPMediaManagementSchema.java?rev=1604331&r1=1604330&r2=1604331&view=diff
==============================================================================
---
pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/schema/XMPMediaManagementSchema.java
(original)
+++
pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/schema/XMPMediaManagementSchema.java
Sat Jun 21 10:05:03 2014
@@ -156,7 +156,7 @@ public class XMPMediaManagementSchema ex
/**
* Set Manager value
*
- * @param url
+ * @param value
* Manager value to set
*/
public void setManager(String value)
@@ -256,7 +256,7 @@ public class XMPMediaManagementSchema ex
/**
* Set ManageUI value
*
- * @param url
+ * @param value
* ManageUI value to set
*/
public void setManageUI(String value)
@@ -306,7 +306,7 @@ public class XMPMediaManagementSchema ex
/**
* Set ManagerVariant value
*
- * @param url
+ * @param value
* ManagerVariant value to set
*/
public void setManagerVariant(String value)
@@ -356,7 +356,7 @@ public class XMPMediaManagementSchema ex
/**
* Set InstanceId value
*
- * @param url
+ * @param value
* InstanceId value to set
*/
public void setInstanceID(String value)
@@ -418,7 +418,7 @@ public class XMPMediaManagementSchema ex
/**
* set ManageFrom Property
*
- * @param tt
+ * @param resourceRef
* ManageFrom Property to set
*/
public void setManagedFromProperty(ResourceRefType resourceRef)
@@ -505,7 +505,7 @@ public class XMPMediaManagementSchema ex
/**
* Set renditionClass Value
*
- * @param url
+ * @param value
* renditionClass Value to set
*/
public void setRenditionClass(String value)
@@ -605,7 +605,7 @@ public class XMPMediaManagementSchema ex
/**
* Set VersionId value
*
- * @param url
+ * @param value
* VersionId value to set
*/
public void setVersionID(String value)
Modified:
pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/schema/XMPSchema.java
URL:
http://svn.apache.org/viewvc/pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/schema/XMPSchema.java?rev=1604331&r1=1604330&r2=1604331&view=diff
==============================================================================
---
pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/schema/XMPSchema.java
(original)
+++
pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/schema/XMPSchema.java
Sat Jun 21 10:05:03 2014
@@ -59,10 +59,12 @@ public class XMPSchema extends AbstractS
*
* @param metadata
* The parent XMP metadata that this schema will be part of.
- * @param namespaceName
- * The name of the namespace, ie pdf,dc,...
* @param namespaceURI
* The URI of the namespace, ie "http://ns.adobe.com/pdf/1.3/";
+ * @param prefix
+ * The prefix to be used
+ * @param name
+ * The name of the namespace, ie pdf,dc,...
*
*/
public XMPSchema(XMPMetadata metadata, String namespaceURI, String prefix,
String name)
@@ -289,7 +291,7 @@ public class XMPSchema extends AbstractS
/**
* Get a TextProperty Type from its name
*
- * @param qualifiedName
+ * @param name
* The full qualified name of the property wanted
* @return The Text Type property wanted
*/
@@ -314,7 +316,7 @@ public class XMPSchema extends AbstractS
/**
* Get the value of a simple text property.
*
- * @param qualifiedName
+ * @param name
* The name of the property to get, it must include the
namespace prefix. ie "pdf:Keywords".
*
* @return The value of the text property or the null if there is no value.
@@ -666,7 +668,7 @@ public class XMPSchema extends AbstractS
/**
* Remove all matching entries with the given value from the bag.
*
- * @param qualifiedBagName
+ * @param bagName
* The name of the bag, it must include the namespace prefix.
ie "pdf:Keywords".
* @param bagValue
* The value to remove from the bagList.
@@ -722,7 +724,7 @@ public class XMPSchema extends AbstractS
* Get all the values of the bag property. This will return a list of
java.lang.String objects, this is a read-only
* list.
*
- * @param qualifiedBagName
+ * @param bagName
* The name of the bag property to get without namespace prefix.
*
* @return All values of the bag property in a list.
@@ -756,7 +758,7 @@ public class XMPSchema extends AbstractS
/**
* Generic method to remove a field from an array with an Elementable
Object
*
- * @param qualifiedArrayName
+ * @param arrayName
* the full qualified name of the property concerned
* @param fieldValue
* the elementable field value
@@ -802,7 +804,7 @@ public class XMPSchema extends AbstractS
/**
* Add a new value to a sequence property.
*
- * @param qualifiedSeqName
+ * @param simpleSeqName
* The name of the sequence property without the namespace
prefix
* @param seqValue
* The value to add to the sequence.
@@ -850,7 +852,7 @@ public class XMPSchema extends AbstractS
/**
* Add a new value to a sequence property.
*
- * @param qualifiedSeqName
+ * @param seqName
* The name of the sequence property, it must include the
namespace prefix. ie "pdf:Keywords"
* @param seqValue
* The value to add to the sequence.
@@ -874,7 +876,7 @@ public class XMPSchema extends AbstractS
/**
* Get all the values in a sequence property.
*
- * @param qualifiedSeqName
+ * @param seqName
* The name of the sequence property without namespace prefix.
*
* @return A read-only list of java.lang.String objects or null if the
property does not exist.
@@ -895,7 +897,7 @@ public class XMPSchema extends AbstractS
/**
* Remove a date sequence value from the list.
*
- * @param qualifiedSeqName
+ * @param seqName
* The name of the sequence property, it must include the
namespace prefix. ie "pdf:Keywords"
* @param date
* The date to remove from the sequence property.
@@ -945,7 +947,7 @@ public class XMPSchema extends AbstractS
/**
* Add a date sequence value to the list.
*
- * @param qualifiedSeqName
+ * @param seqName
* The name of the sequence property, it must include the
namespace prefix. ie "pdf:Keywords"
* @param date
* The date to add to the sequence property.
@@ -961,7 +963,7 @@ public class XMPSchema extends AbstractS
/**
* Get all the date values in a sequence property.
*
- * @param qualifiedSeqName
+ * @param seqName
* The name of the sequence property, it must include the
namespace prefix. ie "pdf:Keywords".
*
* @return A read-only list of java.util.Calendar objects or null if the
property does not exist.
@@ -1048,7 +1050,7 @@ public class XMPSchema extends AbstractS
/**
* Set the value of a multi-lingual property.
*
- * @param qualifiedName
+ * @param name
* The name of the property, it must include the namespace
prefix. ie "pdf:Keywords"
* @param language
* The language code of the value. If null then "x-default" is
assumed.
@@ -1118,9 +1120,9 @@ public class XMPSchema extends AbstractS
/**
* Get the value of a multi-lingual property.
*
- * @param qualifiedName
+ * @param name
* The name of the property, without the namespace prefix.
- * @param language
+ * @param expectedLanguage
* The language code of the value. If null then "x-default" is
assumed.
*
* @return The value of the language property.
@@ -1162,7 +1164,7 @@ public class XMPSchema extends AbstractS
/**
* Get a list of all languages that are currently defined for a specific
property.
*
- * @param qualifiedName
+ * @param name
* The name of the property, it must include the namespace
prefix. ie "pdf:Keywords"
*
* @return A list of all languages, this will return an non-null empty
list if none have been defined.
@@ -1294,7 +1296,7 @@ public class XMPSchema extends AbstractS
/**
* Get an AbstractField list corresponding to the content of an array
Return null if the property is unknown
*
- * @param nam
+ * @param name
* the property name whitout namespace;
* @return List of property contained in the complex property
* @throws BadFieldValueException
Modified:
pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/type/AbstractField.java
URL:
http://svn.apache.org/viewvc/pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/type/AbstractField.java?rev=1604331&r1=1604330&r2=1604331&view=diff
==============================================================================
---
pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/type/AbstractField.java
(original)
+++
pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/type/AbstractField.java
Sat Jun 21 10:05:03 2014
@@ -48,10 +48,6 @@ public abstract class AbstractField
*
* @param metadata
* The metadata to attach to this field
- * @param namespaceURI
- * the namespace URI
- * @param prefix
- * the prefix to set for this field
* @param propertyName
* the local name to set for this field
*/
Modified:
pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/type/Attribute.java
URL:
http://svn.apache.org/viewvc/pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/type/Attribute.java?rev=1604331&r1=1604330&r2=1604331&view=diff
==============================================================================
---
pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/type/Attribute.java
(original)
+++
pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/type/Attribute.java
Sat Jun 21 10:05:03 2014
@@ -41,8 +41,6 @@ public class Attribute
*
* @param nsURI
* namespaceURI of this attribute (could be null)
- * @param prefix
- * prefix of this attribute
* @param localName
* localName of this attribute
* @param value
Modified:
pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/type/ComplexPropertyContainer.java
URL:
http://svn.apache.org/viewvc/pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/type/ComplexPropertyContainer.java?rev=1604331&r1=1604330&r2=1604331&view=diff
==============================================================================
---
pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/type/ComplexPropertyContainer.java
(original)
+++
pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/type/ComplexPropertyContainer.java
Sat Jun 21 10:05:03 2014
@@ -41,15 +41,6 @@ public class ComplexPropertyContainer /*
/**
* Complex Property type constructor (namespaceURI is given)
- *
- * @param metadata
- * The metadata to attach to this property
- * @param namespaceURI
- * The namespace URI to associate to this property
- * @param prefix
- * The prefix to set for this property
- * @param propertyName
- * The local Name of this property
*/
public ComplexPropertyContainer()
{
Modified:
pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/type/LayerType.java
URL:
http://svn.apache.org/viewvc/pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/type/LayerType.java?rev=1604331&r1=1604330&r2=1604331&view=diff
==============================================================================
---
pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/type/LayerType.java
(original)
+++
pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/type/LayerType.java
Sat Jun 21 10:05:03 2014
@@ -58,10 +58,6 @@ public class LayerType extends AbstractS
/**
* Set LayerName
*
- * @param prefix
- * the prefix of LayerName property to set
- * @param name
- * the name of LayerName property to set
* @param image
* the value of LayerName property to set
*/
@@ -88,10 +84,6 @@ public class LayerType extends AbstractS
/**
* Set LayerText
*
- * @param prefix
- * the prefix of LayerText property to set
- * @param name
- * the name of LayerText property to set
* @param image
* the value of LayerText property to set
*/
Modified:
pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/type/PropertiesDescription.java
URL:
http://svn.apache.org/viewvc/pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/type/PropertiesDescription.java?rev=1604331&r1=1604330&r2=1604331&view=diff
==============================================================================
---
pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/type/PropertiesDescription.java
(original)
+++
pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/type/PropertiesDescription.java
Sat Jun 21 10:05:03 2014
@@ -40,10 +40,8 @@ public class PropertiesDescription
private Map<String, PropertyType> types;
/**
- * Build PropMapping for specified namespace
+ * PropertiesDescritption constructor
*
- * @param namespace
- * namespace URI concerned by this PropMapping
*/
public PropertiesDescription()
{
@@ -67,8 +65,6 @@ public class PropertiesDescription
* new property name
* @param type
* Valuetype of the new property
- * @param attr
- * A list of attribute (put null while attribute management is
not implemented)
*/
public void addNewProperty(String name, PropertyType type)
{
Modified:
pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/type/ResourceEventType.java
URL:
http://svn.apache.org/viewvc/pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/type/ResourceEventType.java?rev=1604331&r1=1604330&r2=1604331&view=diff
==============================================================================
---
pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/type/ResourceEventType.java
(original)
+++
pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/type/ResourceEventType.java
Sat Jun 21 10:05:03 2014
@@ -51,12 +51,6 @@ public class ResourceEventType extends A
*
* @param metadata
* The metadata to attach to this property
- * @param namespace
- * the namespace URI to associate to this property
- * @param prefix
- * The prefix to set for this property
- * @param propertyName
- * The local Name of this thumbnail type
*/
public ResourceEventType(XMPMetadata metadata)
{
Modified:
pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/type/ResourceRefType.java
URL:
http://svn.apache.org/viewvc/pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/type/ResourceRefType.java?rev=1604331&r1=1604330&r2=1604331&view=diff
==============================================================================
---
pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/type/ResourceRefType.java
(original)
+++
pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/type/ResourceRefType.java
Sat Jun 21 10:05:03 2014
@@ -81,12 +81,6 @@ public class ResourceRefType extends Abs
*
* @param metadata
* The metadata to attach to this property
- * @param namespace
- * the namespace URI to associate to this property
- * @param prefix
- * The prefix to set for this property
- * @param propertyName
- * The local Name of this thumbnail type
*/
public ResourceRefType(XMPMetadata metadata)
{
Modified:
pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/type/ThumbnailType.java
URL:
http://svn.apache.org/viewvc/pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/type/ThumbnailType.java?rev=1604331&r1=1604330&r2=1604331&view=diff
==============================================================================
---
pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/type/ThumbnailType.java
(original)
+++
pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/type/ThumbnailType.java
Sat Jun 21 10:05:03 2014
@@ -49,12 +49,6 @@ public class ThumbnailType extends Abstr
*
* @param metadata
* The metadata to attach to this property
- * @param namespace
- * the namespace URI to associate to this property
- * @param prefix
- * The prefix to set for this property
- * @param propertyName
- * The local Name of this thumbnail type
*/
public ThumbnailType(XMPMetadata metadata)
{
@@ -80,10 +74,6 @@ public class ThumbnailType extends Abstr
/**
* Set Height
*
- * @param prefix
- * the prefix of Height property to set
- * @param name
- * the name of Height property to set
* @param height
* the value of Height property to set
*/
@@ -111,10 +101,6 @@ public class ThumbnailType extends Abstr
/**
* Set Width
*
- * @param prefix
- * the prefix of width property to set
- * @param name
- * the name of width property to set
* @param width
* the value of width property to set
*/
@@ -141,10 +127,6 @@ public class ThumbnailType extends Abstr
/**
* Set Image data
*
- * @param prefix
- * the prefix of image property to set
- * @param name
- * the name of image property to set
* @param image
* the value of image property to set
*/
@@ -171,10 +153,6 @@ public class ThumbnailType extends Abstr
/**
* Set Format
*
- * @param prefix
- * the prefix of format property to set
- * @param name
- * the name of format property to set
* @param format
* the value of format property to set
*/
Modified:
pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/type/TypeMapping.java
URL:
http://svn.apache.org/viewvc/pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/type/TypeMapping.java?rev=1604331&r1=1604330&r2=1604331&view=diff
==============================================================================
---
pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/type/TypeMapping.java
(original)
+++
pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/type/TypeMapping.java
Sat Jun 21 10:05:03 2014
@@ -318,7 +318,7 @@ public final class TypeMapping
/**
* Give type of specified property in specified schema (given by its
namespaceURI)
*
- * @param prop
+ * @param name
* the property Qualified Name
* @return Property type declared for namespace specified, null if unknown
*/
Modified:
pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/type/VersionType.java
URL:
http://svn.apache.org/viewvc/pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/type/VersionType.java?rev=1604331&r1=1604330&r2=1604331&view=diff
==============================================================================
---
pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/type/VersionType.java
(original)
+++
pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/type/VersionType.java
Sat Jun 21 10:05:03 2014
@@ -48,12 +48,6 @@ public class VersionType extends Abstrac
*
* @param metadata
* The metadata to attach to this property
- * @param namespace
- * the namespace URI to associate to this property
- * @param prefix
- * The prefix to set for this property
- * @param propertyName
- * The local Name of this thumbnail type
*/
public VersionType(XMPMetadata metadata)
{
Modified:
pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/xml/DomHelper.java
URL:
http://svn.apache.org/viewvc/pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/xml/DomHelper.java?rev=1604331&r1=1604330&r2=1604331&view=diff
==============================================================================
---
pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/xml/DomHelper.java
(original)
+++
pdfbox/branches/1.8/xmpbox/src/main/java/org/apache/xmpbox/xml/DomHelper.java
Sat Jun 21 10:05:03 2014
@@ -65,7 +65,7 @@ public final class DomHelper
* Return the first child element of the element parameter. If there is no
child, null is returned
*
* @param description
- * @return
+ * @return the first child element. Might be null.
* @throws XmpParsingException
*/
public static Element getFirstChildElement(Element description) throws
XmpParsingException
