javadoc fixme, whitespace fixes

This commit is contained in:
Ivan Masár
2016-11-12 18:06:53 +01:00
parent dfbaa9074e
commit 0b0fab6404
19 changed files with 842 additions and 835 deletions

View File

@@ -491,7 +491,7 @@ public class StatisticsDataVisits extends StatisticsData
* @param value * @param value
* UUID (or legacy record ID) of the DSO in question. * UUID (or legacy record ID) of the DSO in question.
* @param datasetQuery * @param datasetQuery
* unknown, PLEASE DOCUMENT. * FIXME: PLEASE DOCUMENT.
* @param context * @param context
* The relevant DSpace Context. * The relevant DSpace Context.
* @return the name of the given DSO * @return the name of the given DSO

View File

@@ -91,7 +91,7 @@ public class DiscoverUtility
* @param scope * @param scope
* DSpace object * DSpace object
* @param enableFacet * @param enableFacet
* UNKNOWN. PLEASE DOCUMENT. * FIXME: PLEASE DOCUMENT.
* @return the query. * @return the query.
*/ */
public static DiscoverQuery getDiscoverQuery(Context context, public static DiscoverQuery getDiscoverQuery(Context context,
@@ -128,7 +128,7 @@ public class DiscoverUtility
* @param scope * @param scope
* DSpace object * DSpace object
* @param enableFacet * @param enableFacet
* UNKNOWN. PLEASE DOCUMENT. * FIXME: PLEASE DOCUMENT.
* @return the query. * @return the query.
*/ */
public static DiscoverQuery getTagCloudDiscoverQuery(Context context, public static DiscoverQuery getTagCloudDiscoverQuery(Context context,

View File

@@ -156,7 +156,7 @@ public class Author extends XmlElement implements SwordElementInterface
* is a XOM element. * is a XOM element.
* *
* @param author The element to unmarshall. * @param author The element to unmarshall.
* @param validationProperties UNKNOWN. PLEASE DOCUMENT. * @param validationProperties FIXME: PLEASE DOCUMENT.
* @return SWORD validation info * @return SWORD validation info
* @throws org.purl.sword.base.UnmarshallException passed through * @throws org.purl.sword.base.UnmarshallException passed through
*/ */

View File

@@ -161,7 +161,7 @@ public class Content extends XmlElement implements SwordElementInterface
* Unmarshall the content element into the data in this object. * Unmarshall the content element into the data in this object.
* *
* @param content the element to unmarshall. * @param content the element to unmarshall.
* @param validationProperties UNKNOWN. PLEASE DOCUMENT. * @param validationProperties FIXME: PLEASE DOCUMENT.
* @return SWORD validation info * @return SWORD validation info
* @throws UnmarshallException If the element does not contain a * @throws UnmarshallException If the element does not contain a
* content element or if there are problems * content element or if there are problems
@@ -247,7 +247,7 @@ public class Content extends XmlElement implements SwordElementInterface
* *
* @param elements add results to this. * @param elements add results to this.
* @param attributes add these too. * @param attributes add these too.
* @param validationContext UNKNOWN. PLEASE DOCUMENT. * @param validationContext FIXME: PLEASE DOCUMENT.
* @return SWORD validation info * @return SWORD validation info
*/ */
protected SwordValidationInfo validate(List<SwordValidationInfo> elements, protected SwordValidationInfo validate(List<SwordValidationInfo> elements,

View File

@@ -575,7 +575,7 @@ public class Entry extends XmlElement implements SwordElementInterface
/** /**
* *
* @param info add results to this. If null, a new one is created. * @param info add results to this. If null, a new one is created.
* @param validationContext UNKNOWN. PLEASE DOCUMENT. * @param validationContext FIXME: PLEASE DOCUMENT.
* @return SWORD validation info * @return SWORD validation info
*/ */
protected SwordValidationInfo validate(SwordValidationInfo info, protected SwordValidationInfo validate(SwordValidationInfo info,

View File

@@ -212,7 +212,7 @@ public class Generator extends XmlElement implements SwordElementInterface
/** /**
* *
* @param validationContext UNKNOWN. PLEASE DOCUMENT. * @param validationContext FIXME: PLEASE DOCUMENT.
* @return SWORD validation info. * @return SWORD validation info.
*/ */
@Override @Override
@@ -225,7 +225,7 @@ public class Generator extends XmlElement implements SwordElementInterface
* *
* @param existing add results to this. * @param existing add results to this.
* @param attributeItems add these too. * @param attributeItems add these too.
* @param validationContext UNKNOWN. PLEASE DOCUMENT. * @param validationContext FIXME: PLEASE DOCUMENT.
* @return SWORD validation info * @return SWORD validation info
*/ */
public SwordValidationInfo validate(List<SwordValidationInfo> existing, public SwordValidationInfo validate(List<SwordValidationInfo> existing,

View File

@@ -95,7 +95,7 @@ public class Source extends XmlElement implements SwordElementInterface
/** /**
* *
* @param source the element to unmarshall. * @param source the element to unmarshall.
* @param validationProperties UNKNOWN. PLEASE DOCUMENT. * @param validationProperties FIXME: PLEASE DOCUMENT.
* @return SWORD validation info * @return SWORD validation info
* @throws UnmarshallException If there was an error unmarshalling the data. * @throws UnmarshallException If there was an error unmarshalling the data.
*/ */

View File

@@ -148,7 +148,7 @@ implements SwordElementInterface
/** /**
* *
* @param text The text element. * @param text The text element.
* @param validationProperties UNKNOWN. PLEASE DOCUMENT. * @param validationProperties FIXME: PLEASE DOCUMENT.
* @return SWORD validation info * @return SWORD validation info
* @throws UnmarshallException If the specified element is not of * @throws UnmarshallException If the specified element is not of
* the correct type, where the localname is used * the correct type, where the localname is used
@@ -253,7 +253,7 @@ implements SwordElementInterface
* *
* @param existing add results to this. * @param existing add results to this.
* @param attributeItems add these too. * @param attributeItems add these too.
* @param validationContext UNKNOWN. PLEASE DOCUMENT. * @param validationContext FIXME: PLEASE DOCUMENT.
* @return SWORD validation info * @return SWORD validation info
*/ */
protected SwordValidationInfo validate(List<SwordValidationInfo> existing, protected SwordValidationInfo validate(List<SwordValidationInfo> existing,

View File

@@ -62,7 +62,7 @@ implements SwordElementInterface
* is an area that can be improved in a future implementation, if necessary. * is an area that can be improved in a future implementation, if necessary.
* *
* @param element The text element. * @param element The text element.
* @param validationProperties UNKNOWN. PLEASE DOCUMENT. * @param validationProperties FIXME: PLEASE DOCUMENT.
* @return object representing the text element * @return object representing the text element
* @throws UnmarshallException If the specified element is not of * @throws UnmarshallException If the specified element is not of
* the correct type, where the localname is used * the correct type, where the localname is used
@@ -141,8 +141,8 @@ implements SwordElementInterface
/** /**
* *
* @param existing add results to this. * @param existing add results to this.
* @param attributeItems UNKNOWN. PLEASE DOCUMENT. * @param attributeItems FIXME: PLEASE DOCUMENT.
* @param validationContext UNKNOWN. PLEASE DOCUMENT. * @param validationContext FIXME: PLEASE DOCUMENT.
* @return SWORD validation info * @return SWORD validation info
*/ */
protected SwordValidationInfo validate(List<SwordValidationInfo> existing, protected SwordValidationInfo validate(List<SwordValidationInfo> existing,

View File

@@ -680,8 +680,8 @@ public class Collection extends XmlElement implements SwordElementInterface
/** /**
* *
* @param existing add results to this. * @param existing add results to this.
* @param attributes UNKNOWN. PLEASE DOCUMENT. * @param attributes FIXME: PLEASE DOCUMENT.
* @param validationContext UNKNOWN. PLEASE DOCUMENT. * @param validationContext FIXME: PLEASE DOCUMENT.
* @return SWORD validation info * @return SWORD validation info
*/ */
protected SwordValidationInfo validate(List<SwordValidationInfo> existing, protected SwordValidationInfo validate(List<SwordValidationInfo> existing,

View File

@@ -199,7 +199,7 @@ public class DepositResponse
* Unmarshall the specified XML data into a SWORD error document. * Unmarshall the specified XML data into a SWORD error document.
* *
* @param xml The XML data as a string. * @param xml The XML data as a string.
* @param validationContext UNKNOWN. PLEASE DOCUMENT. * @param validationContext FIXME: PLEASE DOCUMENT.
* @return SWORD validation info * @return SWORD validation info
* @throws UnmarshallException If there was an error unmarshalling the data. * @throws UnmarshallException If there was an error unmarshalling the data.
*/ */

View File

@@ -267,7 +267,7 @@ public class SWORDEntry extends Entry
* extensions that exist in the element. * extensions that exist in the element.
* *
* @param entry The entry to parse. * @param entry The entry to parse.
* @param validationProperties UNKNOWN. PLEASE DOCUMENT. * @param validationProperties FIXME: PLEASE DOCUMENT.
* @return SWORD validation info * @return SWORD validation info
* @throws UnmarshallException If the entry is not an atom:entry * @throws UnmarshallException If the entry is not an atom:entry
* or if there is an exception extracting the data. * or if there is an exception extracting the data.

View File

@@ -101,7 +101,7 @@ public class SWORDErrorDocument extends SWORDEntry
/** /**
* *
* @param entry an element to unmarshall. * @param entry an element to unmarshall.
* @param validationProperties UNKNOWN. PLEASE DOCUMENT. * @param validationProperties FIXME: PLEASE DOCUMENT.
* @throws org.purl.sword.base.UnmarshallException passed through. * @throws org.purl.sword.base.UnmarshallException passed through.
*/ */
public SwordValidationInfo unmarshall(Element entry, Properties validationProperties) public SwordValidationInfo unmarshall(Element entry, Properties validationProperties)
@@ -155,7 +155,7 @@ public class SWORDErrorDocument extends SWORDEntry
/** /**
* *
* @param validationContext UNKNOWN. PLEASE DOCUMENT. * @param validationContext FIXME: PLEASE DOCUMENT.
* @return SWORD validation info * @return SWORD validation info
*/ */
public SwordValidationInfo validate(Properties validationContext) public SwordValidationInfo validate(Properties validationContext)

View File

@@ -373,7 +373,7 @@ public class Service extends XmlElement implements SwordElementInterface
* @param service * @param service
* element to unmarshall * element to unmarshall
* @param validationProperties * @param validationProperties
* UNKNOWN. PLEASE DOCUMENT. * FIXME: PLEASE DOCUMENT.
* @return SWORD validation info * @return SWORD validation info
* @throws UnmarshallException If the element does not contain a * @throws UnmarshallException If the element does not contain a
* content element or if there are problems * content element or if there are problems
@@ -530,7 +530,7 @@ public class Service extends XmlElement implements SwordElementInterface
/** /**
* *
* @param existing add results to this. * @param existing add results to this.
* @param validationContext UNKNOWN. PLEASE DOCUMENT. * @param validationContext FIXME: PLEASE DOCUMENT.
* @return validation information * @return validation information
*/ */
protected SwordValidationInfo validate(List<SwordValidationInfo> existing, protected SwordValidationInfo validate(List<SwordValidationInfo> existing,

View File

@@ -134,7 +134,7 @@ public class ServiceDocument {
* dispose of any previous Service object associated with this object. * dispose of any previous Service object associated with this object.
* *
* @param xml The XML string. * @param xml The XML string.
* @param validationProperties UNKNOWN. PLEASE DOCUMENT. * @param validationProperties FIXME: PLEASE DOCUMENT.
* @return SWORD validation info * @return SWORD validation info
* @throws UnmarshallException * @throws UnmarshallException
* If there was a problem unmarshalling the data. This might be * If there was a problem unmarshalling the data. This might be
@@ -181,7 +181,7 @@ public class ServiceDocument {
* @param element * @param element
* element to unmarshall. * element to unmarshall.
* @param validationProperties * @param validationProperties
* UNKNOWN. PLEASE DOCUMENT. * FIXME: PLEASE DOCUMENT.
* @return SWORD validation info * @return SWORD validation info
* @throws UnmarshallException * @throws UnmarshallException
* If there was a problem unmarshalling the data. This might be * If there was a problem unmarshalling the data. This might be

View File

@@ -107,7 +107,7 @@ implements SwordElementInterface
* is an area that can be improved in a future implementation, if necessary. * is an area that can be improved in a future implementation, if necessary.
* *
* @param acceptPackaging The text element. * @param acceptPackaging The text element.
* @param validationProperties UNKNOWN. PLEASE DOCUMENT. * @param validationProperties FIXME: PLEASE DOCUMENT.
* @return SWORD validation info * @return SWORD validation info
* *
* @throws UnmarshallException If the specified element is not of * @throws UnmarshallException If the specified element is not of
@@ -214,8 +214,8 @@ implements SwordElementInterface
/** /**
* *
* @param existing add results to this. * @param existing add results to this.
* @param attributeItems UNKNOWN. PLEASE DOCUMENT. * @param attributeItems FIXME: PLEASE DOCUMENT.
* @param validationContext UNKNOWN. PLEASE DOCUMENT. * @param validationContext FIXME: PLEASE DOCUMENT.
* @return SWORD validation info * @return SWORD validation info
*/ */
protected SwordValidationInfo validate(List<SwordValidationInfo> existing, protected SwordValidationInfo validate(List<SwordValidationInfo> existing,

View File

@@ -353,8 +353,8 @@ public class SwordValidationInfo {
/** /**
* *
* @param elementItems UNKNOWN. PLEASE DOCUMENT. * @param elementItems FIXME: PLEASE DOCUMENT.
* @param attributeItems UNKNOWN. PLEASE DOCUMENT. * @param attributeItems FIXME: PLEASE DOCUMENT.
*/ */
public void addUnmarshallValidationInfo( public void addUnmarshallValidationInfo(
List<SwordValidationInfo> elementItems, List<SwordValidationInfo> elementItems,

View File

@@ -186,8 +186,8 @@ public class Workspace extends XmlElement implements SwordElementInterface
/** /**
* *
* @param workspace the element to unmarshall. * @param workspace the element to unmarshall.
* @param validationProperties UNKNOWN. PLEASE DOCUMENT. * @param validationProperties FIXME: PLEASE DOCUMENT.
* @return UNKNOWN. PLEASE DOCUMENT. * @return FIXME: PLEASE DOCUMENT.
* @throws UnmarshallException If the element does not contain a * @throws UnmarshallException If the element does not contain a
* workspace element or if there are problems * workspace element or if there are problems
* accessing the data. * accessing the data.
@@ -274,8 +274,8 @@ public class Workspace extends XmlElement implements SwordElementInterface
/** /**
* *
* @param existing add results to this. * @param existing add results to this.
* @param validationContext UNKNOWN. PLEASE DOCUMENT. * @param validationContext FIXME: PLEASE DOCUMENT.
* @return UNKNOWN. PLEASE DOCUMENT. * @return FIXME: PLEASE DOCUMENT.
*/ */
protected SwordValidationInfo validate(List<SwordValidationInfo> existing, protected SwordValidationInfo validate(List<SwordValidationInfo> existing,
Properties validationContext) Properties validationContext)