sis-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From desruisse...@apache.org
Subject svn commit: r1507237 - in /sis: branches/JDK7/src/main/javadoc/overview.html site/trunk/content/source.mdtext
Date Fri, 26 Jul 2013 09:46:37 GMT
Author: desruisseaux
Date: Fri Jul 26 09:46:37 2013
New Revision: 1507237

URL: http://svn.apache.org/r1507237
Log:
One more text to move from Maven site to CMS pages.

Modified:
    sis/branches/JDK7/src/main/javadoc/overview.html
    sis/site/trunk/content/source.mdtext

Modified: sis/branches/JDK7/src/main/javadoc/overview.html
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/src/main/javadoc/overview.html?rev=1507237&r1=1507236&r2=1507237&view=diff
==============================================================================
--- sis/branches/JDK7/src/main/javadoc/overview.html (original)
+++ sis/branches/JDK7/src/main/javadoc/overview.html Fri Jul 26 09:46:37 2013
@@ -25,19 +25,11 @@
     <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   </head>
   <body>
-    Overview of <a href="{@website}">Apache SIS™ (Spatial Information System)</a>.
+    Overview of <a href="http://sis.apache.org">Apache SIS™ (Spatial Information
System)</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}, {@code Simple} or {@code General} prefix.

Modified: sis/site/trunk/content/source.mdtext
URL: http://svn.apache.org/viewvc/sis/site/trunk/content/source.mdtext?rev=1507237&r1=1507236&r2=1507237&view=diff
==============================================================================
--- sis/site/trunk/content/source.mdtext [UTF-8] (original)
+++ sis/site/trunk/content/source.mdtext [UTF-8] Fri Jul 26 09:46:37 2013
@@ -222,6 +222,18 @@ a case-by-case basis. Of course, tabular
 
 
 
+### Javadoc annotations    {#javadoc-tags}
+
+SIS uses standard javadoc annotations. The meaning of some tags are refined as below:
+
+  * `@since`   - the SIS version when the annotated element (class, method, <i>etc.</i>)
was first introduced.
+  * `@version` - the last SIS version when the code of the annotated class got a significant
change.
+  * `@author`  - developer name in <var>FirstName</var> <var>LastName</var>
(<var>Organization</var>) format.
+                 A separated `@author` tag is added for each developer.
+                 The intend is to allow other developers to know to who to ask questions
if needed.
+
+
+
 ### HTML elements    {#html}
 
 HTML tags and entities shall be used only when there is no equivalent Javadoc tag.
@@ -276,6 +288,17 @@ HTML tag                  | Description
     Some exceptions to this rule may exist for preserving tabular structures, but should
be rare.
 
 
+
+Classes naming
+--------------
+Implementations of GeoAPI interfaces usually (but not always) begin with `Abstract`, `Default`,
`Simple` or `General` prefixes.
+The `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 `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 `1D`, `2D`,
`3D` or `4D` rather than being prefixed.
+
+
+
 *[ISO]: International Organization for Standardization
 *[OGC]: Open Geospatial Consortium
 



Mime
View raw message