sis-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From desruisse...@apache.org
Subject [sis] 01/03: Adjust the style and formatting of <div class="note">...</div>.
Date Sat, 19 Oct 2019 12:37:34 GMT
This is an automated email from the ASF dual-hosted git repository.

desruisseaux pushed a commit to branch geoapi-4.0
in repository https://gitbox.apache.org/repos/asf/sis.git

commit efa820369671b68cf81e9a0d9bd1ba4f2ccb4fd3
Author: Martin Desruisseaux <martin.desruisseaux@geomatys.com>
AuthorDate: Fri Oct 18 16:42:48 2019 +0200

    Adjust the style and formatting of <div class="note">...</div>.
---
 .../java/org/apache/sis/xml/MarshalContext.java     |  4 ++--
 .../main/java/org/apache/sis/setup/OptionKey.java   |  4 ++--
 .../org/apache/sis/util/collection/TreeTable.java   |  4 ++--
 src/main/javadoc/sis.css                            | 21 +++++++++++++++------
 .../org/apache/sis/storage/DataStoreProvider.java   |  4 ++--
 .../org/apache/sis/storage/DataStoreRegistry.java   |  2 +-
 6 files changed, 24 insertions(+), 15 deletions(-)

diff --git a/core/sis-metadata/src/main/java/org/apache/sis/xml/MarshalContext.java b/core/sis-metadata/src/main/java/org/apache/sis/xml/MarshalContext.java
index c048d0c..4cc681a 100644
--- a/core/sis-metadata/src/main/java/org/apache/sis/xml/MarshalContext.java
+++ b/core/sis-metadata/src/main/java/org/apache/sis/xml/MarshalContext.java
@@ -68,8 +68,8 @@ public abstract class MarshalContext {
      * A {@code null} value means that the timezone is unspecified. Callers are encouraged
      * to use the UTC timezone as the default value, but some flexibility is allowed.
      *
-     * <div class="warning"><b>Upcoming API change — Java time API</b><br>
-     * Return type may be changed to {@link java.time.ZoneId} when Apache SIS will target
Java 8.
+     * <div class="warning"><b>Upcoming API change — Java time API</b>:
+     * return type may be changed to {@link java.time.ZoneId} when Apache SIS will target
Java 8.
      * This change may be applied in synchronization with GeoAPI 4.0.
      * </div>
      *
diff --git a/core/sis-utility/src/main/java/org/apache/sis/setup/OptionKey.java b/core/sis-utility/src/main/java/org/apache/sis/setup/OptionKey.java
index 4e632e1..2b3fac2 100644
--- a/core/sis-utility/src/main/java/org/apache/sis/setup/OptionKey.java
+++ b/core/sis-utility/src/main/java/org/apache/sis/setup/OptionKey.java
@@ -94,8 +94,8 @@ public class OptionKey<T> implements Serializable {
      * If this option is not provided, then the default value is format specific.
      * That default is often, but not necessarily, the {@linkplain TimeZone#getDefault()
platform default}.
      *
-     * <div class="warning"><b>Upcoming API change — Java time API</b><br>
-     * The type may be changed to {@link java.time.ZoneId} when Apache SIS will target Java
8.
+     * <div class="warning"><b>Upcoming API change — Java time API</b>:
+     * the type may be changed to {@link java.time.ZoneId} when Apache SIS will target Java
8.
      * This change may be applied in synchronization with GeoAPI 4.0.
      * </div>
      *
diff --git a/core/sis-utility/src/main/java/org/apache/sis/util/collection/TreeTable.java
b/core/sis-utility/src/main/java/org/apache/sis/util/collection/TreeTable.java
index 06fde02..d0ba260 100644
--- a/core/sis-utility/src/main/java/org/apache/sis/util/collection/TreeTable.java
+++ b/core/sis-utility/src/main/java/org/apache/sis/util/collection/TreeTable.java
@@ -252,8 +252,8 @@ public interface TreeTable {
          * and for avoiding infinite recursivity when comparing the children.
          * A third reason is given in the <cite>purpose</cite> example below.
          *
-         * <div class="note"><b>Purpose of this method: example with ISO metadata</b><br>
-         * Consider the following tree made of ISO 19115 metadata objects: a platform containing
a list of instruments,
+         * <div class="note"><b>Purpose of this method: example with ISO metadata</b>:
+         * consider the following tree made of ISO 19115 metadata objects: a platform containing
a list of instruments,
          * and an instrument containing a reference to the platform on which the instrument
is installed. In this example,
          * nodes 2 and 4 contain a reference to the same {@code Platform} instance, so we
have a cyclic graph:
          *
diff --git a/src/main/javadoc/sis.css b/src/main/javadoc/sis.css
index 9323af4..55b82bf 100644
--- a/src/main/javadoc/sis.css
+++ b/src/main/javadoc/sis.css
@@ -139,12 +139,21 @@ div.horizontal-flow > div {
  * Note or examples.
  */
 div.note {
-  color:     #353833;
-  font-size:   small;
-  margin-left:  40px;
-  margin-right: 40px;
-  margin-top:    9px;
-  margin-bottom: 9px;
+  color:      #353833;
+  margin-left:   40px;
+  margin-right:  40px;
+  margin-top:     9px;
+  margin-bottom:  9px;
+  text-align: justify;
+}
+
+div.note:before {
+  color:     green;
+  position:  relative;
+  float:     left;
+  left:      -28px;
+  width:     0;
+  content:   "🛈";
 }
 
 
diff --git a/storage/sis-storage/src/main/java/org/apache/sis/storage/DataStoreProvider.java
b/storage/sis-storage/src/main/java/org/apache/sis/storage/DataStoreProvider.java
index d8091d3..169a5b5 100644
--- a/storage/sis-storage/src/main/java/org/apache/sis/storage/DataStoreProvider.java
+++ b/storage/sis-storage/src/main/java/org/apache/sis/storage/DataStoreProvider.java
@@ -245,8 +245,8 @@ public abstract class DataStoreProvider {
      * {@link java.nio.ByteBuffer#mark()}, {@link java.io.InputStream#mark(int)} and
      * {@link javax.imageio.stream.ImageInputStream#mark()}.</p>
      *
-     * <div class="note"><b>Implementation example</b><br>
-     * Implementations will typically check the first bytes of the stream for a "magic number"
associated
+     * <div class="note"><b>Implementation example</b>:
+     * implementations will typically check the first bytes of the stream for a "magic number"
associated
      * with the format, as in the following example:
      *
      * {@preformat java
diff --git a/storage/sis-storage/src/main/java/org/apache/sis/storage/DataStoreRegistry.java
b/storage/sis-storage/src/main/java/org/apache/sis/storage/DataStoreRegistry.java
index b6f4853..782daca 100644
--- a/storage/sis-storage/src/main/java/org/apache/sis/storage/DataStoreRegistry.java
+++ b/storage/sis-storage/src/main/java/org/apache/sis/storage/DataStoreRegistry.java
@@ -35,7 +35,7 @@ import org.apache.sis.util.ArraysExt;
  * be any other objects documented in the {@link StorageConnector} class.
  *
  * <div class="note"><b>API note:</b>
- * This class is package-private for now in order to get more experience about what could
be a good API.
+ * this class is package-private for now in order to get more experience about what could
be a good API.
  * This class may become public in a future SIS version.</div>
  *
  * <div class="section">Thread safety</div>


Mime
View raw message