Author: desruisseaux
Date: Fri Mar 20 19:54:10 2015
New Revision: 1668131
URL: http://svn.apache.org/r1668131
Log:
Javadoc: minor formatting updates for a little bit more consistency with the
new usage of <div> for section header.
Modified:
sis/branches/JDK8/core/sis-feature/src/main/java/org/apache/sis/feature/CharacteristicTypeMap.java
sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/DefaultExtent.java
sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/DefaultGeographicBoundingBox.java
sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/DefaultTemporalExtent.java
sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/DefaultVerticalExtent.java
sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/geometry/Envelopes.java
sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/parameter/ParameterFormat.java
sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/parameter/ParameterValueList.java
sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/parameter/TensorParameters.java
sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/DefaultGeodeticDatum.java
Modified:
sis/branches/JDK8/core/sis-feature/src/main/java/org/apache/sis/feature/CharacteristicTypeMap.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-feature/src/main/java/org/apache/sis/feature/CharacteristicTypeMap.java?rev=1668131&r1=1668130&r2=1668131&view=diff
==============================================================================
---
sis/branches/JDK8/core/sis-feature/src/main/java/org/apache/sis/feature/CharacteristicTypeMap.java
[UTF-8] (original)
+++
sis/branches/JDK8/core/sis-feature/src/main/java/org/apache/sis/feature/CharacteristicTypeMap.java
[UTF-8] Fri Mar 20 19:54:10 2015
@@ -34,14 +34,14 @@ import org.opengis.feature.AttributeType
* Implementation of the map returned by {@link
DefaultAttributeType#characteristics()}.
* Information provided by this implementation are also used by {@link
CharacteristicMap}.
*
- * <p><b>Comparison with standard hash map:</b>
+ * <div class="section">Comparison with standard hash map</div>
* The straightforward approach would be to store the attributes directly as
values in a standard {@code HashMap}.
* But instead of that, we store attributes in an array and the array indices
in a {@code HashMap}. This level of
* indirection is useless if we consider only the {@link
DefaultAttributeType#characteristics()} method, since a
* standard {@code HashMap<String,AttributeType>} would work as well or
better. However this level of indirection
* become useful for {@link CharacteristicMap} (the map returned by {@link
DefaultAttribute#characteristics()}),
* since it allows a more efficient storage. We do this effort because some
applications may create a very large
- * amount of attribute instances.</p>
+ * amount of attribute instances.
*
* @author Martin Desruisseaux (Geomatys)
* @since 0.5
Modified:
sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/DefaultExtent.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/DefaultExtent.java?rev=1668131&r1=1668130&r2=1668131&view=diff
==============================================================================
---
sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/DefaultExtent.java
[UTF-8] (original)
+++
sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/DefaultExtent.java
[UTF-8] Fri Mar 20 19:54:10 2015
@@ -260,11 +260,11 @@ public class DefaultExtent extends ISOMe
* and creates a {@link GeographicBoundingBox}, {@link VerticalExtent} or
{@link TemporalExtent}
* elements as needed.
*
- * <p><b>Note:</b> This method is available only if the referencing module
is on the classpath.</p>
+ * <p><b>Note:</b> this method is available only if the referencing module
is on the classpath.</p>
*
* @param envelope The envelope to use for inferring the additional
extents.
* @throws UnsupportedOperationException if the referencing module is not
on the classpath.
- * @throws TransformException If a coordinate transformation was required
and failed.
+ * @throws TransformException if a coordinate transformation was required
and failed.
*
* @see DefaultGeographicBoundingBox#setBounds(Envelope)
* @see DefaultVerticalExtent#setBounds(Envelope)
Modified:
sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/DefaultGeographicBoundingBox.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/DefaultGeographicBoundingBox.java?rev=1668131&r1=1668130&r2=1668131&view=diff
==============================================================================
---
sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/DefaultGeographicBoundingBox.java
[UTF-8] (original)
+++
sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/DefaultGeographicBoundingBox.java
[UTF-8] Fri Mar 20 19:54:10 2015
@@ -475,7 +475,7 @@ public class DefaultGeographicBoundingBo
* specification do not mandates a particular CRS, so we avoid
transformations that are not
* strictly necessary.</p>
*
- * <p><b>Note:</b> This method is available only if the referencing module
is on the classpath.</p>
+ * <p><b>Note:</b> this method is available only if the referencing module
is on the classpath.</p>
*
* @param envelope The envelope to use for setting this geographic
bounding box.
* @throws UnsupportedOperationException if the referencing module is not
on the classpath.
Modified:
sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/DefaultTemporalExtent.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/DefaultTemporalExtent.java?rev=1668131&r1=1668130&r2=1668131&view=diff
==============================================================================
---
sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/DefaultTemporalExtent.java
[UTF-8] (original)
+++
sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/DefaultTemporalExtent.java
[UTF-8] Fri Mar 20 19:54:10 2015
@@ -195,12 +195,12 @@ public class DefaultTemporalExtent exten
* Sets the temporal extent to the specified values. This convenience
method creates a temporal
* primitive for the given dates, then invokes {@link
#setExtent(TemporalPrimitive)}.
*
- * <p><b>Note:</b> This method is available only if the {@code
sis-temporal} module is available on the classpath,
+ * <p><b>Note:</b> this method is available only if the {@code
sis-temporal} module is available on the classpath,
* or any other module providing an implementation of the {@link
org.opengis.temporal.TemporalFactory} interface.</p>
*
* @param startTime The start date and time for the content of the
dataset, or {@code null} if none.
* @param endTime The end date and time for the content of the dataset,
or {@code null} if none.
- * @throws UnsupportedOperationException If no implementation of {@code
TemporalFactory} has been found
+ * @throws UnsupportedOperationException if no implementation of {@code
TemporalFactory} has been found
* on the classpath.
*/
public void setBounds(final Date startTime, final Date endTime) throws
UnsupportedOperationException {
@@ -222,7 +222,7 @@ public class DefaultTemporalExtent exten
* The given envelope must have a {@linkplain
Envelope#getCoordinateReferenceSystem() CRS},
* and at least one dimension of that CRS shall be assignable to a
property of this extent.
*
- * <p><b>Note:</b> This method is available only if the {@code
sis-referencing} module is
+ * <p><b>Note:</b> this method is available only if the {@code
sis-referencing} module is
* available on the classpath.</p>
*
* @param envelope The envelope to use for setting this temporal extent.
Modified:
sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/DefaultVerticalExtent.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/DefaultVerticalExtent.java?rev=1668131&r1=1668130&r2=1668131&view=diff
==============================================================================
---
sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/DefaultVerticalExtent.java
[UTF-8] (original)
+++
sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/DefaultVerticalExtent.java
[UTF-8] Fri Mar 20 19:54:10 2015
@@ -220,7 +220,7 @@ public class DefaultVerticalExtent exten
* be multi-dimensional, in which case the {@linkplain
Envelope#getCoordinateReferenceSystem()
* envelope CRS} must have a vertical component.
*
- * <p><b>Note:</b> This method is available only if the referencing module
is on the classpath.</p>
+ * <p><b>Note:</b> this method is available only if the referencing module
is on the classpath.</p>
*
* @param envelope The envelope to use for setting this vertical extent.
* @throws UnsupportedOperationException if the referencing module is not
on the classpath.
Modified:
sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/geometry/Envelopes.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/geometry/Envelopes.java?rev=1668131&r1=1668130&r2=1668131&view=diff
==============================================================================
---
sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/geometry/Envelopes.java
[UTF-8] (original)
+++
sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/geometry/Envelopes.java
[UTF-8] Fri Mar 20 19:54:10 2015
@@ -200,10 +200,10 @@ public final class Envelopes extends Sta
* The transformation is only approximative: the returned envelope may be
bigger than necessary,
* or smaller than required if the bounding box contains a pole.
*
- * <p><b>Limitation</b><br>
+ * <div class="section">Limitation</div>
* This method can not handle the case where the envelope contains the
North or South pole,
* or when it crosses the ±180° longitude, because {@link MathTransform}
does not carry sufficient information.
- * For a more robust envelope transformation, use {@link
#transform(CoordinateOperation, Envelope)} instead.</p>
+ * For a more robust envelope transformation, use {@link
#transform(CoordinateOperation, Envelope)} instead.
*
* @param transform The transform to use.
* @param envelope Envelope to transform, or {@code null}. This envelope
will not be modified.
Modified:
sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/parameter/ParameterFormat.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/parameter/ParameterFormat.java?rev=1668131&r1=1668130&r2=1668131&view=diff
==============================================================================
---
sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/parameter/ParameterFormat.java
[UTF-8] (original)
+++
sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/parameter/ParameterFormat.java
[UTF-8] Fri Mar 20 19:54:10 2015
@@ -220,7 +220,7 @@ public class ParameterFormat extends Tab
* }
* </div>
*
- * <p><b>Tip:</b> The table formatted by default may be quite large.
It is recommended to invoke
+ * <p><b>Tip:</b> the table formatted by default may be quite large.
It is recommended to invoke
* {@link ParameterFormat#setPreferredCodespaces(String[])} before to
format in order to reduce the
* amount of columns to display.</p>
*/
Modified:
sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/parameter/ParameterValueList.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/parameter/ParameterValueList.java?rev=1668131&r1=1668130&r2=1668131&view=diff
==============================================================================
---
sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/parameter/ParameterValueList.java
[UTF-8] (original)
+++
sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/parameter/ParameterValueList.java
[UTF-8] Fri Mar 20 19:54:10 2015
@@ -41,7 +41,7 @@ import org.apache.sis.util.resources.Err
* This class performs checks on the parameter values to be added or removed.
* This implementation supports {@code set(…)}, {@code add(…)} and {@code
remove(…)} operations.
*
- * <p><b>Implementation note:</b> This class reproduces some {@link
java.util.ArrayList} functionalities.
+ * <p><b>Implementation note:</b> this class reproduces some {@link
java.util.ArrayList} functionalities.
* However we do <strong>not</strong> extend {@code ArrayList} because we
really need the default method
* implementations provided by {@code AbstractList} — the optimizations
performed by {@code ArrayList}
* are not suitable here.</p>
Modified:
sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/parameter/TensorParameters.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/parameter/TensorParameters.java?rev=1668131&r1=1668130&r2=1668131&view=diff
==============================================================================
---
sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/parameter/TensorParameters.java
[UTF-8] (original)
+++
sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/parameter/TensorParameters.java
[UTF-8] Fri Mar 20 19:54:10 2015
@@ -478,12 +478,12 @@ public class TensorParameters<E> impleme
* This method is invoked by {@link #getElementDescriptor(int[])} when a
new descriptor needs
* to be created.
*
- * <p><b>Default implementation</b></p>
+ * <div class="section">Default implementation</div>
* The default implementation converts the given indices to a parameter
name by invoking the
* {@link #indicesToName(int[])} method, then creates a descriptor for an
optional parameter
* of that name. The default value is given by {@link
#getDefaultValue(int[])}.
*
- * <p><b>Subclassing</b></p>
+ * <div class="section">Subclassing</div>
* Subclasses can override this method if they want more control on
descriptor properties
* like identification information, aliases or value domain.
*
@@ -506,13 +506,13 @@ public class TensorParameters<E> impleme
* Returns the parameter descriptor name of a matrix or tensor element at
the given indices.
* The returned name shall be parsable by the {@link
#nameToIndices(String)} method.
*
- * <p><b>Default implementation</b></p>
+ * <div class="section">Default implementation</div>
* The default implementation requires an {@code indices} array having a
length equals to the {@linkplain #rank()
* rank}. That length is usually 2, where {@code indices[0]} is the
<var>row</var> index and {@code indices[1]} is
* the <var>column</var> index. Then this method builds a name with the
“{@link #prefix} + <var>row</var> +
* {@link #separator} + <var>column</var> + …” pattern (e.g. {@code
"elt_0_0"}).
*
- * <p><b>Subclassing</b></p>
+ * <div class="section">Subclassing</div>
* If a subclass overrides this method for creating different names, then
that subclass shall
* also override {@link #nameToIndices(String)} for parsing those names.
*
@@ -535,7 +535,7 @@ public class TensorParameters<E> impleme
* Returns the indices of matrix element for the given parameter name, or
{@code null} if none.
* This method is the converse of {@link #indicesToName(int[])}.
*
- * <p><b>Default implementation</b></p>
+ * <div class="section">Default implementation</div>
* The default implementation expects a name matching the “{@link #prefix}
+ <var>row</var> + {@link #separator} +
* <var>column</var> + …” pattern and returns an array containing the
<var>row</var>, <var>column</var> and other
* indices, in that order.
Modified:
sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/DefaultGeodeticDatum.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/DefaultGeodeticDatum.java?rev=1668131&r1=1668130&r2=1668131&view=diff
==============================================================================
---
sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/DefaultGeodeticDatum.java
[UTF-8] (original)
+++
sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/DefaultGeodeticDatum.java
[UTF-8] Fri Mar 20 19:54:10 2015
@@ -362,8 +362,8 @@ public class DefaultGeodeticDatum extend
* {@linkplain #getPrimeMeridian() prime meridian}, then it is caller's
responsibility
* to apply longitude rotation before to use the matrix returned by this
method.</p>
*
- * <p><b>Search order</b><br>
- * This method performs the search in the following order:</p>
+ * <div class="section">Search order</div>
+ * This method performs the search in the following order:
* <ol>
* <li>If this {@code GeodeticDatum} contains {@code
BursaWolfParameters} having the given
* {@linkplain BursaWolfParameters#getTargetDatum() target datum}
(ignoring metadata),
@@ -373,16 +373,16 @@ public class DefaultGeodeticDatum extend
* and {@linkplain
org.apache.sis.referencing.operation.matrix.MatrixSIS#inverse() inverted}.</li>
* </ol>
*
- * <p><b>Multi-occurrences resolution</b><br>
+ * <div class="section">Multi-occurrences resolution</div>
* If more than one {@code BursaWolfParameters} instance is found in any
of the above steps, then the one having
* the largest intersection between its {@linkplain
BursaWolfParameters#getDomainOfValidity() domain of validity}
* and the given extent will be selected. If more than one instance have
the same intersection, then the first
- * occurrence is selected.</p>
+ * occurrence is selected.
*
- * <p><b>Time-dependent parameters</b><br>
+ * <div class="section">Time-dependent parameters</div>
* If the given extent contains a {@linkplain
org.opengis.metadata.extent.TemporalExtent temporal extent},
* then the instant located midway between start and end time will be
taken as the date where to evaluate the
- * Bursa-Wolf parameters. This is relevant only to {@linkplain
TimeDependentBWP time-dependent parameters}.</p>
+ * Bursa-Wolf parameters. This is relevant only to {@linkplain
TimeDependentBWP time-dependent parameters}.
*
* @param targetDatum The target datum.
* @param areaOfInterest The geographic and temporal extent where the
transformation should be valid, or {@code null}.
