sis-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From desruisse...@apache.org
Subject svn commit: r1793835 - in /sis/branches/JDK8: core/sis-build-helper/src/main/java/org/apache/sis/internal/taglet/ core/sis-metadata/src/main/java/org/apache/sis/metadata/ src/main/javadoc/
Date Thu, 04 May 2017 17:18:56 GMT
Author: desruisseaux
Date: Thu May  4 17:18:56 2017
New Revision: 1793835

URL: http://svn.apache.org/viewvc?rev=1793835&view=rev
Log:
Javadoc style update.

Modified:
    sis/branches/JDK8/core/sis-build-helper/src/main/java/org/apache/sis/internal/taglet/Preformat.java
    sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/TitleProperty.java
    sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/ValueExistencePolicy.java
    sis/branches/JDK8/src/main/javadoc/stylesheet.css

Modified: sis/branches/JDK8/core/sis-build-helper/src/main/java/org/apache/sis/internal/taglet/Preformat.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-build-helper/src/main/java/org/apache/sis/internal/taglet/Preformat.java?rev=1793835&r1=1793834&r2=1793835&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-build-helper/src/main/java/org/apache/sis/internal/taglet/Preformat.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-build-helper/src/main/java/org/apache/sis/internal/taglet/Preformat.java
[UTF-8] Thu May  4 17:18:56 2017
@@ -148,7 +148,7 @@ all:    while (tk.hasMoreTokens()) {
         /*
          * Nows inserts each line.
          */
-        final StringBuilder buffer = new StringBuilder("<blockquote><pre>");
+        final StringBuilder buffer = new StringBuilder("<pre class=\"code-sample\">");
         tk = new StringTokenizer(text, "\r\n", true);
         while (tk.hasMoreTokens()) {
             String line = tk.nextToken();
@@ -166,7 +166,7 @@ all:    while (tk.hasMoreTokens()) {
             }
             buffer.append(line);
         }
-        return buffer.append("</pre></blockquote>").toString();
+        return buffer.append("</pre>").toString();
     }
 
     /**

Modified: sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/TitleProperty.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/TitleProperty.java?rev=1793835&r1=1793834&r2=1793835&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/TitleProperty.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/TitleProperty.java
[UTF-8] Thu May  4 17:18:56 2017
@@ -26,9 +26,10 @@ import java.lang.annotation.Documented;
 
 /**
  * Identifies the name of a property to use for summarizing in one line the content of a
metadata object.
- * For example in a {@linkplain org.apache.sis.metadata.iso.citation.DefaultCitation citation},
it is the
- * {@code "title"} property. This information is used in {@linkplain MetadataStandard#asTreeTable
metadata
- * tree views} for producing briefer trees, especially when there is redundant node names.
+ * For example in a {@linkplain org.apache.sis.metadata.iso.citation.DefaultCitation citation}
instance,
+ * the {@code "title"} property is often the only information that a user needs for a first
look.
+ * This annotation is used in {@linkplain MetadataStandard#asTreeTable metadata tree views}
for producing briefer trees,
+ * especially when there is redundant node names.
  *
  * <div class="note"><b>Example:</b>
  * the {@code Citation} type contains a {@linkplain org.apache.sis.metadata.iso.citation.DefaultCitation#getDates()
date}
@@ -37,16 +38,18 @@ import java.lang.annotation.Documented;
  *
  * {@preformat text
  *   Citation
+ *    ├─Title……………………… My document
  *    └─Date
  *       ├─Date………………… 2012/01/01
  *       └─Date type…… Creation
  * }
  *
- * The <code>&#64;TitleProperty(name="date")</code> annotation on the {@code
DefaultCitationDate} implementation class
- * instructs Apache SIS that the tree table view should be as below:
+ * With <code>&#64;TitleProperty(name="title")</code> on {@code DefaultCitation}
implementation class and
+ * <code>&#64;TitleProperty(name="date")</code> on {@code DefaultCitationDate}
class,
+ * Apache SIS can produce a more compact tree table view should be as below:
  *
  * {@preformat text
- *   Citation
+ *   Citation……………………… My document
  *    └─Date………………………… 2012/01/01
  *       └─Date type…… Creation
  * }

Modified: sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/ValueExistencePolicy.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/ValueExistencePolicy.java?rev=1793835&r1=1793834&r2=1793835&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/ValueExistencePolicy.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/ValueExistencePolicy.java
[UTF-8] Thu May  4 17:18:56 2017
@@ -140,13 +140,13 @@ public enum ValueExistencePolicy {
      * the {@link org.apache.sis.metadata.iso.citation.DefaultCitation} and
      * {@link org.apache.sis.metadata.iso.citation.DefaultCitationDate} classes are annotated
with
      * <code>&#64;TitleProperty(name="title")</code> and <code>&#64;TitleProperty(name="date")</code>
-     * respectively. The following table compares the trees produces by two policies:
+     * respectively. The following table compares the trees produced by two policies:
      *
      * <table class="sis">
      *   <caption>Comparison of "non-empty" and "compact" policy on the same metadata</caption>
      *   <tr>
      *     <th>{@code NON_EMPTY}</th>
-     *     <th>{@code COMPACT}</th>
+     *     <th class="sep">{@code COMPACT}</th>
      *   </tr><tr><td>
      *     {@preformat text
      *       Citation
@@ -155,7 +155,7 @@ public enum ValueExistencePolicy {
      *           ├─Date………………… 2012/01/01
      *           └─Date type…… Creation
      *     }
-     *   </td><td>
+     *   </td><td class="sep">
      *     {@preformat text
      *       Citation……………………… My document
      *        └─Date………………………… 2012/01/01

Modified: sis/branches/JDK8/src/main/javadoc/stylesheet.css
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/src/main/javadoc/stylesheet.css?rev=1793835&r1=1793834&r2=1793835&view=diff
==============================================================================
--- sis/branches/JDK8/src/main/javadoc/stylesheet.css (original)
+++ sis/branches/JDK8/src/main/javadoc/stylesheet.css Thu May  4 17:18:56 2017
@@ -212,6 +212,28 @@ div.block center {
 }
 
 /*
+ * Output of {@preformat} inline tag.
+ */
+pre.code-sample {
+  margin-left:   40px;
+  margin-right:  40px;
+  margin-top:    12px;
+  margin-bottom: 12px;
+}
+
+td > pre.code-sample {
+  margin: 9px;
+}
+
+:not(td) > pre.code-sample {
+  padding:      9px;
+  border-style: solid;
+  border-width: 1px;
+  border-color: gray;
+  background-color: rgba(200, 200, 200, 0.1);
+}
+
+/*
  * Miscellaneous.
  */
 span.deprecated {



Mime
View raw message