sis-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From desruisse...@apache.org
Subject svn commit: r1768400 - /sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/identification/DefaultKeywords.java
Date Sun, 06 Nov 2016 22:59:23 GMT
Author: desruisseaux
Date: Sun Nov  6 22:59:23 2016
New Revision: 1768400

URL: http://svn.apache.org/viewvc?rev=1768400&view=rev
Log:
Javadoc formatting.

Modified:
    sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/identification/DefaultKeywords.java

Modified: sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/identification/DefaultKeywords.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/identification/DefaultKeywords.java?rev=1768400&r1=1768399&r2=1768400&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/identification/DefaultKeywords.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/identification/DefaultKeywords.java
[UTF-8] Sun Nov  6 22:59:23 2016
@@ -91,8 +91,8 @@ public class DefaultKeywords extends ISO
     /**
      * Creates keywords initialized to the given key word.
      *
-     * @param keywords Commonly used words or formalised words or phrases used to describe
-     *                 the subject, or {@code null} if none.
+     * @param keywords  commonly used words or formalised words or phrases used to describe
the subject,
+     *                  or {@code null} if none.
      */
     public DefaultKeywords(final CharSequence... keywords) {
         if (keywords != null) {
@@ -112,7 +112,7 @@ public class DefaultKeywords extends ISO
      * This is a <cite>shallow</cite> copy constructor, since the other metadata
contained in the
      * given object are not recursively copied.
      *
-     * @param object The metadata to copy values from, or {@code null} if none.
+     * @param object  the metadata to copy values from, or {@code null} if none.
      *
      * @see #castOrCopy(Keywords)
      */
@@ -139,8 +139,8 @@ public class DefaultKeywords extends ISO
      *       metadata contained in the given object are not recursively copied.</li>
      * </ul>
      *
-     * @param  object The object to get as a SIS implementation, or {@code null} if none.
-     * @return A SIS implementation containing the values of the given object (may be the
+     * @param  object  the object to get as a SIS implementation, or {@code null} if none.
+     * @return a SIS implementation containing the values of the given object (may be the
      *         given object itself), or {@code null} if the argument was null.
      */
     public static DefaultKeywords castOrCopy(final Keywords object) {
@@ -153,7 +153,7 @@ public class DefaultKeywords extends ISO
     /**
      * Returns commonly used word(s) or formalised word(s) or phrase(s) used to describe
the subject.
      *
-     * @return Word(s) or phrase(s) used to describe the subject.
+     * @return word(s) or phrase(s) used to describe the subject.
      */
     @Override
     @XmlElement(name = "keyword", required = true)
@@ -164,7 +164,7 @@ public class DefaultKeywords extends ISO
     /**
      * Sets commonly used word(s) or formalised word(s) or phrase(s) used to describe the
subject.
      *
-     * @param newValues The new keywords.
+     * @param newValues  the new keywords.
      */
     public void setKeywords(final Collection<? extends InternationalString> newValues)
{
         keywords = writeCollection(newValues, keywords, InternationalString.class);
@@ -173,7 +173,7 @@ public class DefaultKeywords extends ISO
     /**
      * Returns the subject matter used to group similar keywords.
      *
-     * @return Subject matter used to group similar keywords, or {@code null}.
+     * @return subject matter used to group similar keywords, or {@code null}.
      */
     @Override
     @XmlElement(name = "type")
@@ -184,7 +184,7 @@ public class DefaultKeywords extends ISO
     /**
      * Sets the subject matter used to group similar keywords.
      *
-     * @param newValue The new keyword type.
+     * @param newValue  the new keyword type.
      */
     public void setType(final KeywordType newValue) {
         checkWritePermission();
@@ -194,7 +194,7 @@ public class DefaultKeywords extends ISO
     /**
      * Returns the name of the formally registered thesaurus or a similar authoritative source
of keywords.
      *
-     * @return Name of registered thesaurus or similar authoritative source of keywords,
or {@code null}.
+     * @return name of registered thesaurus or similar authoritative source of keywords,
or {@code null}.
      */
     @Override
     @XmlElement(name = "thesaurusName")
@@ -205,7 +205,7 @@ public class DefaultKeywords extends ISO
     /**
      * Sets the name of the formally registered thesaurus or a similar authoritative source
of keywords.
      *
-     * @param newValue The new thesaurus name.
+     * @param newValue  the new thesaurus name.
      */
     public void setThesaurusName(final Citation newValue) {
         checkWritePermission();
@@ -216,7 +216,7 @@ public class DefaultKeywords extends ISO
      * Returns the user-defined categorization of groups of keywords that extend or
      * are orthogonal to the standardized {@linkplain #getType() keyword type} codes.
      *
-     * @return User-defined categorization of groups of keywords, or {@code null} if none.
+     * @return user-defined categorization of groups of keywords, or {@code null} if none.
      *
      * @since 0.5
      */
@@ -228,7 +228,7 @@ public class DefaultKeywords extends ISO
     /**
      * Sets the user-defined categorization of groups of keywords.
      *
-     * @param newValue New user-defined categorization of groups of keywords.
+     * @param newValue  new user-defined categorization of groups of keywords.
      *
      * @since 0.5
      */



Mime
View raw message