Author: desruisseaux
Date: Sat Dec 8 09:01:20 2012
New Revision: 1418631
URL: http://svn.apache.org/viewvc?rev=1418631&view=rev
Log:
Javadoc fixes.
Modified:
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/internal/util/LocalizedParseException.java
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/Version.java
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/type/CodeLists.java
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/type/DefaultNameFactory.java
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/type/DefaultNameSpace.java
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/xml/MarshalContext.java
sis/branches/JDK7/src/main/javadoc/stylesheet.css
Modified:
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/internal/util/LocalizedParseException.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/internal/util/LocalizedParseException.java?rev=1418631&r1=1418630&r2=1418631&view=diff
==============================================================================
---
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/internal/util/LocalizedParseException.java
(original)
+++
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/internal/util/LocalizedParseException.java
Sat Dec 8 09:01:20 2012
@@ -86,7 +86,7 @@ public final class LocalizedParseExcepti
*
* @param locale The locale for {@link #getLocalizedMessage()}.
* @param key The resource key as one of the {@link Errors.Keys}
constant.
- * @param text The full text that {@code Format} failed to parse.
+ * @param text The full text that {@code Format} failed to parse.
* @param errorOffset The position where the error is found while parsing.
*/
public LocalizedParseException(final Locale locale, final int key, final
CharSequence text, final int errorOffset) {
@@ -98,7 +98,7 @@ public final class LocalizedParseExcepti
* information. This convenience constructor creates a message of the kind
"<cite>Can not
* parse string "text" as an object of type 'type'</cite>".
*
- * @param locale The locale for {@link
ParseException#getLocalizedMessage()}.
+ * @param locale The locale for {@link #getLocalizedMessage()}.
* @param type The type of objects parsed by the {@link
java.text.Format}.
* @param text The full text that {@code Format} failed to parse.
* @param pos Index of the {@linkplain ParsePosition#getIndex() first
parsed character},
Modified:
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/Version.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/Version.java?rev=1418631&r1=1418630&r2=1418631&view=diff
==============================================================================
---
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/Version.java
(original)
+++
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/Version.java
Sat Dec 8 09:01:20 2012
@@ -81,6 +81,7 @@ public class Version implements CharSequ
* @param version The version as a string.
*/
public Version(final String version) {
+ ArgumentChecks.ensureNonNull("version", version);
this.version = CharSequences.trimWhitespaces(version);
}
Modified:
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/type/CodeLists.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/type/CodeLists.java?rev=1418631&r1=1418630&r2=1418631&view=diff
==============================================================================
---
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/type/CodeLists.java
(original)
+++
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/type/CodeLists.java
Sat Dec 8 09:01:20 2012
@@ -62,9 +62,9 @@ public final class CodeLists extends Sta
* Examples:
*
* <ul>
- * <li><code>getListName({@linkplain
org.opengis.referencing.cs.AxisDirection#NORTH})</code> returns {@code
"CS_AxisDirection"}.</li>
- * <li><code>getListName({@linkplain
org.opengis.metadata.identification.CharacterSet#UTF_8})</code> returns {@code
"MD_CharacterSetCode"}.</li>
- * <li><code>getListName({@linkplain
org.opengis.metadata.content.ImagingCondition#BLURRED_IMAGE})</code> returns
{@code "MD_ImagingConditionCode"}.</li>
+ * <li>{@code getListName(AxisDirection.NORTH)} returns {@code
"CS_AxisDirection"}.</li>
+ * <li>{@code getListName(CharacterSet.UTF_8)} returns {@code
"MD_CharacterSetCode"}.</li>
+ * <li>{@code getListName(ImagingCondition.BLURRED_IMAGE)} returns
{@code "MD_ImagingConditionCode"}.</li>
* </ul>
*
* @param code The code for which to get the class name, or {@code null}.
@@ -85,9 +85,9 @@ public final class CodeLists extends Sta
* Examples:
*
* <ul>
- * <li><code>getCodeName({@linkplain
org.opengis.referencing.cs.AxisDirection#NORTH})</code> returns {@code
"north"}.</li>
- * <li><code>getCodeName({@linkplain
org.opengis.metadata.identification.CharacterSet#UTF_8})</code> returns {@code
"utf8"}.</li>
- * <li><code>getCodeName({@linkplain
org.opengis.metadata.content.ImagingCondition#BLURRED_IMAGE})</code> returns
{@code "blurredImage"}.</li>
+ * <li>{@code getCodeName(AxisDirection#NORTH)} returns {@code
"north"}.</li>
+ * <li>{@code getCodeName(CharacterSet#UTF_8)} returns {@code
"utf8"}.</li>
+ * <li>{@code getCodeName(ImagingCondition#BLURRED_IMAGE)} returns
{@code "blurredImage"}.</li>
* </ul>
*
* @param code The code for which to get the name, or {@code null}.
@@ -114,9 +114,9 @@ public final class CodeLists extends Sta
* from that name. Examples:</p>
*
* <ul>
- * <li><code>getCodeTitle({@linkplain
org.opengis.referencing.cs.AxisDirection#NORTH})</code> returns {@code
"North"}.</li>
- * <li><code>getCodeTitle({@linkplain
org.opengis.metadata.identification.CharacterSet#UTF_8})</code> returns {@code
"UTF-8"}.</li>
- * <li><code>getCodeTitle({@linkplain
org.opengis.metadata.content.ImagingCondition#BLURRED_IMAGE})</code> returns
{@code "Blurred image"}.</li>
+ * <li>{@code getCodeTitle(AxisDirection#NORTH)} returns {@code
"North"}.</li>
+ * <li>{@code getCodeTitle(CharacterSet#UTF_8)} returns {@code
"UTF-8"}.</li>
+ * <li>{@code getCodeTitle(ImagingCondition#BLURRED_IMAGE)} returns
{@code "Blurred image"}.</li>
* </ul>
*
* @param code The code from which to get a title, or {@code null}.
Modified:
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/type/DefaultNameFactory.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/type/DefaultNameFactory.java?rev=1418631&r1=1418630&r2=1418631&view=diff
==============================================================================
---
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/type/DefaultNameFactory.java
(original)
+++
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/type/DefaultNameFactory.java
Sat Dec 8 09:01:20 2012
@@ -220,7 +220,7 @@ public class DefaultNameFactory extends
/**
* Constructs a generic name from a qualified name.
* This method splits the given name around a separator inferred from the
given scope, or the
- * {@value org.apache.sis.util.typeDefaultNameSpace#DEFAULT_SEPARATOR}
separator if the given
+ * {@value org.apache.sis.util.type.DefaultNameSpace#DEFAULT_SEPARATOR}
separator if the given
* scope is null.
*
* @param scope The {@linkplain AbstractName#scope() scope} of the
generic name to
@@ -291,10 +291,10 @@ public class DefaultNameFactory extends
* <ul>
* <li>{@link GenericName}, to be casted and returned as-is.</li>
* <li>{@link CharSequence} (usually a {@link String} or an {@link
InternationalString}), to
- * be parsed as a generic name using the {@linkplain
DefaultNameSpace#DEFAULT_SEPARATOR
- * default separator}.</li>
+ * be parsed as a generic name using the
+ * {@value
org.apache.sis.util.type.DefaultNameSpace#DEFAULT_SEPARATOR} separator.</li>
* <li>{@link Identifier}, its {@linkplain Identifier#getCode() code} to
be parsed as a generic name
- * using the {@value
org.apache.sis.util.typeDefaultNameSpace#DEFAULT_SEPARATOR} separator.</li>
+ * using the {@value
org.apache.sis.util.type.DefaultNameSpace#DEFAULT_SEPARATOR} separator.</li>
* </ul>
*
* @param value The object to cast into an array of generic names.
Modified:
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/type/DefaultNameSpace.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/type/DefaultNameSpace.java?rev=1418631&r1=1418630&r2=1418631&view=diff
==============================================================================
---
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/type/DefaultNameSpace.java
(original)
+++
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/type/DefaultNameSpace.java
Sat Dec 8 09:01:20 2012
@@ -43,7 +43,6 @@ import java.util.Objects;
*
* <p>{@code DefaultNameSpace} can be instantiated by any of the following
methods:</p>
* <ul>
- * <li>{@link DefaultNameFactory#createNameSpace(GenericName)}</li>
* <li>{@link DefaultNameFactory#createNameSpace(GenericName, Map)}</li>
* </ul>
*
Modified:
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/xml/MarshalContext.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/xml/MarshalContext.java?rev=1418631&r1=1418630&r2=1418631&view=diff
==============================================================================
---
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/xml/MarshalContext.java
(original)
+++
sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/xml/MarshalContext.java
Sat Dec 8 09:01:20 2012
@@ -31,20 +31,6 @@ import org.apache.sis.util.Version;
*/
public abstract class MarshalContext {
/**
- * A constant for GML version 3.0.
- *
- * @see #getVersion(String)
- */
- public static final Version GML_3_0 = new Version("3.0");
-
- /**
- * A constant for GML version 3.2.
- *
- * @see #getVersion(String)
- */
- public static final Version GML_3_2 = new Version("3.2");
-
- /**
* Creates a new (un)marshalling context.
*/
protected MarshalContext() {
@@ -61,8 +47,7 @@ public abstract class MarshalContext {
* <th>Typical values</th>
* </tr>
* <tr>
- * <td>gml</td><td>Geographic Markup Language</td>
- * <td>{@link #GML_3_0}, {@link #GML_3_2}</td>
+ * <td>gml</td> <td>Geographic Markup Language</td> <td>{@code 3.0},
{@code 3.2}</td>
* </tr>
* </table>
*
Modified: sis/branches/JDK7/src/main/javadoc/stylesheet.css
URL:
http://svn.apache.org/viewvc/sis/branches/JDK7/src/main/javadoc/stylesheet.css?rev=1418631&r1=1418630&r2=1418631&view=diff
==============================================================================
--- sis/branches/JDK7/src/main/javadoc/stylesheet.css (original)
+++ sis/branches/JDK7/src/main/javadoc/stylesheet.css Sat Dec 8 09:01:20 2012
@@ -126,6 +126,12 @@ div.block ol {
margin-bottom: 9pt;
}
+div.block li > ul,
+div.block li > ol {
+ margin-top: 0pt;
+ margin-bottom: 0pt;
+}
+
div.block ul {
list-style-type: square;
}