Author: desruisseaux
Date: Thu Mar 5 22:18:17 2015
New Revision: 1664504
URL: http://svn.apache.org/r1664504
Log:
Javadoc formatting: replaced the table by a more classical list.
A few tests suggest that the list is more redeable.
Modified:
sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/parameter/ParameterBuilder.java
sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/Builder.java
Modified:
sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/parameter/ParameterBuilder.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/parameter/ParameterBuilder.java?rev=1664504&r1=1664503&r2=1664504&view=diff
==============================================================================
---
sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/parameter/ParameterBuilder.java
[UTF-8] (original)
+++
sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/parameter/ParameterBuilder.java
[UTF-8] Thu Mar 5 22:18:17 2015
@@ -42,45 +42,31 @@ import static org.apache.sis.util.Argume
* since those properties are specific to the each parameter. Other properties
like codespace,
* version and cardinality are left unchanged because they may be shared by
many parameters.
*
- * <table class="sis">
- * <caption>{@code IdentifiedObject} properties</caption>
- * <tr>
- * <th>Property</th>
- * <th>Description</th>
- * </tr>
- *
- * <tr><td><b>{@linkplain DefaultParameterDescriptor#getName()
Names}:</b></td>
- * <td>Each parameter must have a name, which can be specified by any of the
{@link #addName(CharSequence)
+ * <ul>
+ * <li><p><b>{@linkplain DefaultParameterDescriptor#getName() Names}:</b>
+ * each parameter must have a name, which can be specified by any of the
{@link #addName(CharSequence)
* addName(…)} methods. Parameters can optionally have an arbitrary amount
of aliases, which are also specified
- * by the {@code addName(…)} methods. Each call after the first one adds an
alias.</td></tr>
+ * by the {@code addName(…)} methods. Each call after the first one adds an
alias.</p></li>
*
- * <tr><td><b>{@linkplain DefaultParameterDescriptor#getIdentifiers()
Identifiers}:</b></td>
- * <td>Parameters can also have an arbitrary amount of identifiers, which
are specified by any of the
+ * <li><p><b>{@linkplain DefaultParameterDescriptor#getIdentifiers()
Identifiers}:</b>
+ * parameters can also have an arbitrary amount of identifiers, which are
specified by any of the
* {@link #addIdentifier(String) addIdentifier(…)} methods. Like names, more
than one identifier can be
- * added by invoking the method many time.</td></tr>
+ * added by invoking the method many time.</p></li>
*
- * <tr><td><b>{@linkplain DefaultParameterDescriptor#getRemarks()
Remarks}:</b></td>
- * <td>Parameters can have at most one remark, which is specified by the
{@code setRemarks(…)} method.</td></tr>
- * </table>
+ * <li><p><b>{@linkplain DefaultParameterDescriptor#getRemarks()
Remarks}:</b>
+ * parameters can have at most one remark, which is specified by the {@code
setRemarks(…)} method.</p></li>
+ * </ul>
*
*
* {@section Usage example}
* Parameter descriptors are typically grouped in a {@link
ParameterDescriptorGroup}.
* All parameters usually have the same namespace, which can be declared only
once.
- * The following example creates parameters for "<cite>Mercator (variant
A)</cite>"
- * projection method (EPSG:9804) with the following characteristics:
- *
- * <ul>
- * <li>A single name or identifier in the "EPSG" namespace, except:
- * <ul>
- * <li><cite>Longitude of natural origin</cite> parameter, which
illustrates the case of parameters having
- * more than one name because different softwares or standards use
different conventions.</li>
- * <li><cite>"Mercator (variant A)"</cite> projection, which is commonly
known under different names.</li>
- * </ul>
- * </li>
- * <li>Default values define a projection centered on (0°,0°), with no scale
factor and no false easting/northing.</li>
- * <li>Projection is valid from 80°S to 84°N and on all the longitude range
(±180°).</li>
- * </ul>
+ * The following example creates parameters for <cite>"Mercator (variant
A)"</cite>
+ * projection method (EPSG:9804), previously known as <cite>"Mercator
(1SP)"</cite>,
+ * centered by default on (0°,0°) with no scale factor and no false
easting/northing.
+ * The projection is valid from 80°S to 84°N and on all the longitude range
(±180°).
+ * In this example, the <cite>"Longitude of natural origin"</cite> parameter
is giving different aliases
+ * for illustrating the case of different softwares or standards using
different conventions.
*
* {@preformat java
* ParameterBuilder builder = new ParameterBuilder();
Modified:
sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/Builder.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/Builder.java?rev=1664504&r1=1664503&r2=1664504&view=diff
==============================================================================
---
sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/Builder.java
[UTF-8] (original)
+++
sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/Builder.java
[UTF-8] Thu Mar 5 22:18:17 2015
@@ -48,71 +48,59 @@ import java.util.Objects;
*
* <p>This base class provides methods for defining the {@link
IdentifiedObject} properties shown below:</p>
*
- * <table class="sis">
- * <caption>{@code IdentifiedObject} properties</caption>
- * <tr>
- * <th>Property</th>
- * <th>Description</th>
- * </tr>
- *
- * <tr><td><b>{@linkplain AbstractIdentifiedObject#getName() Name}:</b></td>
- * <td>Each {@code IdentifiedObject} shall have a name, which can be
specified by a call to any of the
- * {@link #addName(CharSequence) addName(…)} methods defined in this
class.</td></tr>
- *
- * <tr><td><b>{@linkplain AbstractIdentifiedObject#getAlias()
Aliases}:</b></td>
- * <td>Identified objects can optionally have an arbitrary amount of
aliases, which are also specified
- * by the {@code addName(…)} methods. Each call after the first one adds an
alias.</td></tr>
- *
- * <tr><td><b>{@linkplain AbstractIdentifiedObject#getIdentifiers()
Identifiers}:</b></td>
- * <td>Identified objects can also have an arbitrary amount of identifiers,
which are specified by any
- * of the {@link #addIdentifier(String) addIdentifier(…)} methods. Like
names, more than one identifier
- * can be added by invoking the method many time.</td></tr>
- *
- * <tr><td><b>{@linkplain AbstractIdentifiedObject#getRemarks()
Remarks}:</b></td>
- * <td>Identified objects can have at most one remark, which is specified by
the {@code setRemarks(…)}
- * method.</td></tr>
- * </table>
+ * <ul>
+ * <li><p><b>{@linkplain AbstractIdentifiedObject#getName() Name}:</b>
+ * each {@code IdentifiedObject} shall have a name, which can be
specified by a call to any of the
+ * {@link #addName(CharSequence) addName(…)} methods defined in this
class.</p></li>
+ *
+ * <li><p><b>{@linkplain AbstractIdentifiedObject#getAlias() Aliases}:</b>
+ * identified objects can optionally have an arbitrary amount of
aliases, which are also specified
+ * by the {@code addName(…)} methods. Each call after the first one adds
an alias.</p></li>
+ *
+ * <li><p><b>{@linkplain AbstractIdentifiedObject#getIdentifiers()
Identifiers}:</b>
+ * identified objects can also have an arbitrary amount of identifiers,
which are specified by any
+ * of the {@link #addIdentifier(String) addIdentifier(…)} methods. Like
names, more than one identifier
+ * can be added by invoking the method many time.</p></li>
+ *
+ * <li><p><b>{@linkplain AbstractIdentifiedObject#getRemarks() Remarks}:</b>
+ * identified objects can have at most one remark, which is specified by
the {@code setRemarks(…)}
+ * method.</p></li>
+ * </ul>
*
* The names and identifiers cited in the above table can be built from {@link
CharSequence} given to the
* {@code addName(…)} or {@code addIdentifier(…)} methods combined with the
following properties:
*
- * <table class="sis">
- * <caption>{@code Identifier} properties</caption>
- * <tr>
- * <th>Property</th>
- * <th>Description</th>
- * </tr>
- *
- * <tr><td><b>{@linkplain ImmutableIdentifier#getCodeSpace() Code
space}:</b></td>
- * <td>Each {@code Identifier} name or code can be local to a code space
defined by an authority.
- * Both the authority and code space can be specified by the {@link
#setCodeSpace(Citation, String)} method,
- * and usually (but not necessarily) apply to all {@code Identifier}
instances.</td></tr>
- *
- * <tr><td><b>{@linkplain ImmutableIdentifier#getVersion() Version}:</b></td>
- * <td>Identifiers can optionally have a version specified by the {@link
#setVersion(String)} method.
- * The version usually (but not necessarily) applies to all {@code
Identifier} instances.</td></tr>
- *
- * <tr><td><b>{@linkplain ImmutableIdentifier#getDescription()
Description}:</b></td>
- * <td>Identifiers can optionally have a description specified by the {@link
#setDescription(CharSequence)} method.
- * The description applies only to the next identifier to create.</td></tr>
- * </table>
+ * <ul>
+ * <li><p><b>{@linkplain ImmutableIdentifier#getCodeSpace() Code space}:</b>
+ * each {@code Identifier} name or code can be local to a code space
defined by an authority.
+ * Both the authority and code space can be specified by the {@link
#setCodeSpace(Citation, String)} method,
+ * and usually (but not necessarily) apply to all {@code Identifier}
instances.</p></li>
+ *
+ * <li><p><b>{@linkplain ImmutableIdentifier#getVersion() Version}:</b>
+ * identifiers can optionally have a version specified by the {@link
#setVersion(String)} method.
+ * The version usually (but not necessarily) applies to all {@code
Identifier} instances.</p></li>
+ *
+ * <li><p><b>{@linkplain ImmutableIdentifier#getDescription()
Description}:</b>
+ * identifiers can optionally have a description specified by the {@link
#setDescription(CharSequence)} method.
+ * The description applies only to the next identifier to
create.</p></li>
+ * </ul>
*
* {@section Namespaces and scopes}
* The {@code addName(…)} and {@code addIdentifier(…)} methods come in three
flavors:
* <ul>
- * <li>The {@link #addIdentifier(String)} and {@link #addName(CharSequence)}
methods combine the given argument
+ * <li><p>The {@link #addIdentifier(String)} and {@link
#addName(CharSequence)} methods combine the given argument
* with the above-cited authority, code space, version and description
information.
* The result is a {@linkplain org.apache.sis.util.iso.DefaultLocalName
local name} or identifier,
- * in which the code space information is stored but not shown by the
{@code toString()} method.</li>
+ * in which the code space information is stored but not shown by the
{@code toString()} method.</p></li>
*
- * <li>The {@link #addIdentifier(Citation, String)} and {@link
#addName(Citation, CharSequence)} methods use the given
+ * <li><p>The {@link #addIdentifier(Citation, String)} and {@link
#addName(Citation, CharSequence)} methods use the given
* {@link Citation} argument, ignoring any authority or code space
information given to this {@code Builder}.
* The result is a {@linkplain org.apache.sis.util.iso.DefaultScopedName
scoped name} or identifier,
- * in which the code space information is shown by the {@code
toString()} method.</li>
+ * in which the code space information is shown by the {@code
toString()} method.</p></li>
*
- * <li>The {@link #addIdentifier(Identifier)}, {@link #addName(Identifier)}
and {@link #addName(GenericName)}
+ * <li><p>The {@link #addIdentifier(Identifier)}, {@link
#addName(Identifier)} and {@link #addName(GenericName)}
* methods take the given object <cite>as-is</cite>. Any authority, code
space, version or description
- * information given to the {@code Builder} are ignored.</li>
+ * information given to the {@code Builder} are ignored.</p></li>
* </ul>
*
* <div class="note"><b>Example:</b>
@@ -144,18 +132,21 @@ import java.util.Objects;
* In order to simplify that common usage, two groups of properties have
different lifetimes in the {@code Builder} class:
*
* <ul>
- * <li>{@linkplain NamedIdentifier#getAuthority() Authority},
+ * <li><p>
+ * {@linkplain NamedIdentifier#getAuthority() Authority},
* {@linkplain NamedIdentifier#getCodeSpace() code space} and
* {@linkplain NamedIdentifier#getVersion() version}:<br>
- * Kept until they are specified again, because those properties are
typically shared by all components.</li>
- *
- * <li>{@linkplain AbstractIdentifiedObject#getName() Name},
+ * Kept until they are specified again, because those properties are
typically shared by all components.
+ * </p></li>
+ * <li><p>
+ * {@linkplain AbstractIdentifiedObject#getName() Name},
* {@linkplain AbstractIdentifiedObject#getAlias() aliases},
* {@linkplain AbstractIdentifiedObject#getIdentifiers() identifiers},
* {@linkplain ImmutableIdentifier#getDescription() description} and
* {@linkplain AbstractIdentifiedObject#getRemarks() remarks}:<br>
* Cleared after each call to a {@code createXXX(…)} method, because
those properties are usually specific
- * to a particular {@code IdentifiedObject} or {@code Identifier}
instance.</li>
+ * to a particular {@code IdentifiedObject} or {@code Identifier}
instance.
+ * </p></li>
* </ul>
*
* {@section Usage examples}
