sis-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From desruisse...@apache.org
Subject svn commit: r1383344 - in /incubator/sis/trunk: pom.xml sis-metadata/src/main/java/org/apache/sis/metadata/ModifiableMetadata.java src/ src/main/ src/main/javadoc/ src/main/javadoc/overview.html src/main/javadoc/stylesheet.css
Date Tue, 11 Sep 2012 10:44:38 GMT
Author: desruisseaux
Date: Tue Sep 11 10:44:37 2012
New Revision: 1383344

URL: http://svn.apache.org/viewvc?rev=1383344&view=rev
Log:
Added Javadoc overview and stylesheet. For now, this apply only to the aggregated javadoc
generated from the root project directory.

Added:
    incubator/sis/trunk/src/
    incubator/sis/trunk/src/main/
    incubator/sis/trunk/src/main/javadoc/
    incubator/sis/trunk/src/main/javadoc/overview.html   (with props)
    incubator/sis/trunk/src/main/javadoc/stylesheet.css   (with props)
Modified:
    incubator/sis/trunk/pom.xml
    incubator/sis/trunk/sis-metadata/src/main/java/org/apache/sis/metadata/ModifiableMetadata.java

Modified: incubator/sis/trunk/pom.xml
URL: http://svn.apache.org/viewvc/incubator/sis/trunk/pom.xml?rev=1383344&r1=1383343&r2=1383344&view=diff
==============================================================================
--- incubator/sis/trunk/pom.xml (original)
+++ incubator/sis/trunk/pom.xml Tue Sep 11 10:44:37 2012
@@ -279,7 +279,7 @@ Apache SIS is a toolkit for describing l
     <profile>
       <id>apache-release</id>
       <properties>
-        <maven.compiler.debug>false</maven.compiler.debug>
+        <maven.compiler.debug>false</maven.compiler.debug> <!-- For smaller
JAR files size. -->
         <maven.compiler.optimize>true</maven.compiler.optimize>
       </properties>
     </profile>
@@ -362,6 +362,7 @@ Apache SIS is a toolkit for describing l
           <quiet>true</quiet>                                   <!-- Shuts
off non-error and non-warning messages. -->
           <keywords>true</keywords>                             <!-- Adds
HTML meta keyword tags to the generated files. -->
           <breakiterator>true</breakiterator>                   <!-- Better
boundary detection when determining the end of the first sentence. -->
+          <stylesheetfile>src/main/javadoc/stylesheet.css</stylesheetfile>
           <links>
             <link>http://www.geoapi.org/3.0/javadoc</link>
           </links>

Modified: incubator/sis/trunk/sis-metadata/src/main/java/org/apache/sis/metadata/ModifiableMetadata.java
URL: http://svn.apache.org/viewvc/incubator/sis/trunk/sis-metadata/src/main/java/org/apache/sis/metadata/ModifiableMetadata.java?rev=1383344&r1=1383343&r2=1383344&view=diff
==============================================================================
--- incubator/sis/trunk/sis-metadata/src/main/java/org/apache/sis/metadata/ModifiableMetadata.java
(original)
+++ incubator/sis/trunk/sis-metadata/src/main/java/org/apache/sis/metadata/ModifiableMetadata.java
Tue Sep 11 10:44:37 2012
@@ -363,7 +363,7 @@ public abstract class ModifiableMetadata
     /**
      * Returns the type of collection to use for the given type. The current implementation
can
      * return only two values: <code>{@linkplain Set}.class</code> if the attribute
should not
-     * accept duplicated values, or <code>{@linkplain List}.class</code> otherwise.
Future Geotk
+     * accept duplicated values, or <code>{@linkplain List}.class</code> otherwise.
Future SIS
      * versions may accept other types.
      * <p>
      * The default implementation returns <code>{@linkplain Set}.class</code>
if the element type

Added: incubator/sis/trunk/src/main/javadoc/overview.html
URL: http://svn.apache.org/viewvc/incubator/sis/trunk/src/main/javadoc/overview.html?rev=1383344&view=auto
==============================================================================
--- incubator/sis/trunk/src/main/javadoc/overview.html (added)
+++ incubator/sis/trunk/src/main/javadoc/overview.html Tue Sep 11 10:44:37 2012
@@ -0,0 +1,33 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>API Overview</title>
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+  </head>
+  <body>
+    Overview of <a href="http://incubator.apache.org/sis/">Apache Spatial Information
System (SIS)</a>.
+
+    <h3>Requirements</h3>
+    <p>SIS requires Java 6 Standard Edition.</p>
+
+    <h3>Javadoc annotations</h3>
+    <p>SIS uses standard javadoc annotations. The meaning of some tags are refined
as below:</p>
+    <ul>
+      <li>{@code @since}   - the SIS version when the annotated element (class, method,
<i>etc.</i>) was first introduced.</li>
+      <li>{@code @version} - the last SIS version when the code of the annotated class
got a significant change.</li>
+      <li>{@code @author}  - developer names in <var>First name</var> <var>Last
name</var> <var>(organization)</var> format.</li>
+    </ul>
+
+    <h3>Classes naming</h3>
+    <p>Implementations of <a href="http://www.geoapi.org/">GeoAPI interfaces</a>
usually (but not always)
+    begin with {@code Abstract}, {@code Default} or {@code General} prefix.
+    The {@code Abstract} prefix is used when a class is abstract according ISO specifications
-
+    it may or may not be be abstract in the Java sense.
+    The {@code General} prefix is used when an implementation is designed for use in the
general case,
+    as opposed to other implementations specialized for a fixed number of dimensions or other
conditions.
+    Implementations specialized for a fixed number of dimensions are suffixed with {@code
1D}, {@code 2D},
+    {@code 3D} or {@code 4D} rather than being prefixed.</p>
+
+    <p>Classes that are not GeoAPI implementation are usually not prefixed by any of
the above.</p>
+  </body>
+</html>

Propchange: incubator/sis/trunk/src/main/javadoc/overview.html
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: incubator/sis/trunk/src/main/javadoc/overview.html
------------------------------------------------------------------------------
    svn:mime-type = text/html

Added: incubator/sis/trunk/src/main/javadoc/stylesheet.css
URL: http://svn.apache.org/viewvc/incubator/sis/trunk/src/main/javadoc/stylesheet.css?rev=1383344&view=auto
==============================================================================
--- incubator/sis/trunk/src/main/javadoc/stylesheet.css (added)
+++ incubator/sis/trunk/src/main/javadoc/stylesheet.css Tue Sep 11 10:44:37 2012
@@ -0,0 +1,84 @@
+/*
+ * Javadoc style sheet
+ */
+
+/* Page background color */
+body { background-color: #FFFFFF; color:#000000 }
+
+/* Headings */
+h1 { font-size: 145% }
+
+/* Table colors */
+.TableHeadingColor     { background: #CCCCFF; color:#000000 } /* Dark mauve */
+.TableSubHeadingColor  { background: #EEEEFF; color:#000000 } /* Light mauve */
+.TableRowColor         { background: #FFFFFF; color:#000000 } /* White */
+
+/* Font used in left-hand frame lists */
+.FrameTitleFont   { font-size: 100%; font-family: Helvetica, Arial, sans-serif; color:#000000
}
+.FrameHeadingFont { font-size:  90%; font-family: Helvetica, Arial, sans-serif; color:#000000
}
+.FrameItemFont    { font-size:  90%; font-family: Helvetica, Arial, sans-serif; color:#000000
}
+
+/* Navigation bar fonts and colors */
+.NavBarCell1    { background-color:#EEEEFF; color:#000000} /* Light mauve */
+.NavBarCell1Rev { background-color:#00008B; color:#FFFFFF} /* Dark Blue */
+.NavBarFont1    { font-family: Arial, Helvetica, sans-serif; color:#000000;color:#000000;}
+.NavBarFont1Rev { font-family: Arial, Helvetica, sans-serif; color:#FFFFFF;color:#FFFFFF;}
+
+.NavBarCell2    { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000}
+.NavBarCell3    { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000}
+
+
+/*
+ * Following is specific to the SIS project.
+ */
+/*
+ * Table without vertical space between rows, a little bit of space between columns,
+ * a light background color and a header with a darker background color. The header
+ * also have a little bit more space, and a border is drawn around the table.
+ */
+table.sis {
+  background-color: #F4F8FF;
+  border-spacing: 0pt;
+  border-style: solid;
+  white-space: nowrap;
+}
+
+table.sis tr th {
+  background-color: #B9DCFF;
+  border-bottom-style: solid;
+  border-bottom-width: 1pt;
+  padding: 3pt;
+}
+
+table.sis tr td {
+  padding-left:  6pt;
+  padding-right: 6pt;
+  vertical-align: text-top;
+}
+
+/*
+ * Table without vertical space between rows and a little bit of space between columns.
+ * Other properties are left to their default values. In particular, there is no border.
+ */
+table.compact {
+  border-spacing: 0pt;
+}
+
+table.compact tr td {
+  padding-top:    0pt;
+  padding-bottom: 0pt;
+  padding-right:  3pt;
+  padding-left:   3pt;
+}
+
+table.compact tr td.onright {
+  padding-right: 1pt;
+  text-align:    right;
+  font-weight:   normal;
+}
+
+table.compact tr td.onleft {
+  padding-left: 1pt;
+  text-align:   left;
+  font-weight:  normal;
+}

Propchange: incubator/sis/trunk/src/main/javadoc/stylesheet.css
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: incubator/sis/trunk/src/main/javadoc/stylesheet.css
------------------------------------------------------------------------------
    svn:mime-type = text/css



Mime
View raw message