sis-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From desruisse...@apache.org
Subject svn commit: r1390339 - in /sis/trunk/sis-build-helper/src: main/javadoc/ main/javadoc/overview.html main/javadoc/stylesheet.css site/apt/index.apt site/resources/ site/resources/css/ site/resources/css/site.css
Date Wed, 26 Sep 2012 09:02:16 GMT
Author: desruisseaux
Date: Wed Sep 26 09:02:15 2012
New Revision: 1390339

URL: http://svn.apache.org/viewvc?rev=1390339&view=rev
Log:
Style files for sis-build-helper, together with documentation updates.

Added:
    sis/trunk/sis-build-helper/src/main/javadoc/
    sis/trunk/sis-build-helper/src/main/javadoc/overview.html   (with props)
    sis/trunk/sis-build-helper/src/main/javadoc/stylesheet.css   (with props)
    sis/trunk/sis-build-helper/src/site/resources/
    sis/trunk/sis-build-helper/src/site/resources/css/
    sis/trunk/sis-build-helper/src/site/resources/css/site.css   (with props)
Modified:
    sis/trunk/sis-build-helper/src/site/apt/index.apt

Added: sis/trunk/sis-build-helper/src/main/javadoc/overview.html
URL: http://svn.apache.org/viewvc/sis/trunk/sis-build-helper/src/main/javadoc/overview.html?rev=1390339&view=auto
==============================================================================
--- sis/trunk/sis-build-helper/src/main/javadoc/overview.html (added)
+++ sis/trunk/sis-build-helper/src/main/javadoc/overview.html Wed Sep 26 09:02:15 2012
@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>API Overview</title>
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+  </head>
+  <body>
+    Overview of Apache <a href="{@website}/sis-build-helper">sis-build-helper</a>
module.
+    This Javadoc is only about one specific module. For the full Apache SIS project, see
+    the <a href="{@website}/apidocs/overview-summary.html">aggregated Javadoc</a>.
+  </body>
+</html>

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

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

Added: sis/trunk/sis-build-helper/src/main/javadoc/stylesheet.css
URL: http://svn.apache.org/viewvc/sis/trunk/sis-build-helper/src/main/javadoc/stylesheet.css?rev=1390339&view=auto
==============================================================================
--- sis/trunk/sis-build-helper/src/main/javadoc/stylesheet.css (added)
+++ sis/trunk/sis-build-helper/src/main/javadoc/stylesheet.css Wed Sep 26 09:02:15 2012
@@ -0,0 +1 @@
+link ../../../../src/main/javadoc/stylesheet.css
\ No newline at end of file

Propchange: sis/trunk/sis-build-helper/src/main/javadoc/stylesheet.css
------------------------------------------------------------------------------
    svn:special = *

Modified: sis/trunk/sis-build-helper/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/sis/trunk/sis-build-helper/src/site/apt/index.apt?rev=1390339&r1=1390338&r2=1390339&view=diff
==============================================================================
--- sis/trunk/sis-build-helper/src/site/apt/index.apt (original)
+++ sis/trunk/sis-build-helper/src/site/apt/index.apt Wed Sep 26 09:02:15 2012
@@ -1,5 +1,5 @@
                              ------------------------------
-                                          Index
+                                        Overview
                              ------------------------------
 
 Building Apache SIS
@@ -13,19 +13,21 @@ Building Apache SIS
 
   This module provides the following javadoc taglets:
 
-   * <<<@module>>> - replaced in the generated javadoc by a link to the
module where the
-     class is defined.
-
-   * <<<{@website}>>> - an inline taglet for the URL to the Apache SIS
web site (Maven reports).
-
-   * <<<{@section}>>> - an inline taglet for the title of a new section
in the javadoc.
-
-   * <<<{@note}>>> - an inline taglet for a remark that readers can safely
ignore.
-     Notes appear in indented paragraphs with a smaller font.
-
-   * <<<{preformat}>>> - an inline taglet for pre-formatted text. The first
word inside
-     the taglet shall be one of <<<java>>>, <<<xml>>>,
<<<sql>>>, <<<wkt>>>, <<<text>>>,
-     <<<math>>> or <<<shell>>>.
+*---------------------+-------------------------------------------------------------------------------------------+
+|| Javadoc tag        || Description                                                    
                        ||
+*---------------------+-------------------------------------------------------------------------------------------+
+| <<<@module>>>       | Create links to the module where the class is defined,
source code and Maven artifacts.   |
+*---------------------+-------------------------------------------------------------------------------------------+
+| <<<\{@website\}>>>  | an inline taglet for the URL to the Apache SIS
web site (Maven reports).                  |
+*---------------------+-------------------------------------------------------------------------------------------+
+| <<<\{@section\}>>>  | an inline taglet for the title of a new section
in the javadoc.                           |
+*---------------------+-------------------------------------------------------------------------------------------+
+| <<<\{@note\}>>>     | an inline taglet for a remark that readers can
safely ignore.                             |
+|                     | Notes appear as indented paragraphs with a smaller font.        
                         |
+*---------------------+-------------------------------------------------------------------------------------------+
+| <<<\{preformat\}>>> | an inline taglet for pre-formatted text. The first
word inside the taglet shall be one of |
+|                     | <<<java>>>, <<<xml>>>, <<<sql>>>,
<<<wkt>>>, <<<text>>>, <<<math>>> or
<<<shell>>>.       |
+*---------------------+-------------------------------------------------------------------------------------------+
 
 
 * Localized resources compiler
@@ -46,7 +48,7 @@ Building Apache SIS
   inner class named <<<Keys>>>, then the compiler will rewrite the constants
declared in that
   inner class with the list of keys found in the <<<Vocabulary*.properties>>>
files.
 
-  The resource compiler is executed at Maven build time when the <<<pom.xml>>>
file of a module
+  The resource compiler is executed at Maven build time if the <<<pom.xml>>>
file
   contains the following declaration. Note that current implementation looks only for resources
   in the <<<org.apache.sis.resources>>> package; all other packages are
ignored.
 

Added: sis/trunk/sis-build-helper/src/site/resources/css/site.css
URL: http://svn.apache.org/viewvc/sis/trunk/sis-build-helper/src/site/resources/css/site.css?rev=1390339&view=auto
==============================================================================
--- sis/trunk/sis-build-helper/src/site/resources/css/site.css (added)
+++ sis/trunk/sis-build-helper/src/site/resources/css/site.css Wed Sep 26 09:02:15 2012
@@ -0,0 +1,29 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/*
+ * Inherit all the styles from the root site.css,
+ * with only the URL to the images modified.
+ */
+@import url("../css/site.css");
+
+h2 {
+  background: url(../../images/h2.png) repeat-x;
+}
+#breadcrumbs {
+  background: url(../../images/bar.png) repeat-x;
+}

Propchange: sis/trunk/sis-build-helper/src/site/resources/css/site.css
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: sis/trunk/sis-build-helper/src/site/resources/css/site.css
------------------------------------------------------------------------------
    svn:mime-type = text/css



Mime
View raw message