Author: desruisseaux
Date: Fri Mar 20 19:20:07 2015
New Revision: 1668122
URL: http://svn.apache.org/r1668122
Log:
Remove the documentation about the {@section} custom javadoc, and document the
style that we use.
Modified:
sis/site/trunk/content/book/en/developer-guide.html
sis/site/trunk/content/source.mdtext
Modified: sis/site/trunk/content/book/en/developer-guide.html
URL:
http://svn.apache.org/viewvc/sis/site/trunk/content/book/en/developer-guide.html?rev=1668122&r1=1668121&r2=1668122&view=diff
==============================================================================
--- sis/site/trunk/content/book/en/developer-guide.html [UTF-8] (original)
+++ sis/site/trunk/content/book/en/developer-guide.html [UTF-8] Fri Mar 20
19:20:07 2015
@@ -1774,7 +1774,7 @@ System.out.println("The GeoAPI interface
The approach used also determines whether it is possible to share the same
instance of an object for all languages.
</p>
-<h3 id="LocalizedString">Distinct Character Sequences for Each Locael</h3>
+<h3 id="LocalizedString">Distinct Character Sequences for Each Locale</h3>
<p>
Some classes are only designed to function according to one locale
convention at a time.
This is of course true for the standard implementations of
<code>java.text.Format</code>,
Modified: sis/site/trunk/content/source.mdtext
URL:
http://svn.apache.org/viewvc/sis/site/trunk/content/source.mdtext?rev=1668122&r1=1668121&r2=1668122&view=diff
==============================================================================
--- sis/site/trunk/content/source.mdtext [UTF-8] (original)
+++ sis/site/trunk/content/source.mdtext [UTF-8] Fri Mar 20 19:20:07 2015
@@ -220,7 +220,6 @@ Javadoc tag | Description
`@module` | Create links to the module where the class is defined, source
code and Maven artifacts.
`{@include}` | Include the content of a given HTML file below a `<h2>`
section having the given title.
`{@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`.
-`{@section}` | An inline taglet for the title of a new section in the
javadoc.
@@ -235,6 +234,18 @@ For example:
* Instead of "`<pre>✎</pre>`" for a Java listing, use "`{@preformat java
✎}`"
(this Javadoc tag is specific to Apache SIS — see above table).
+The following HTML tags can be used:
+
+HTML element | Description
+------------------------- |
--------------------------------------------------------------------------------
+`<div class="section">` | Header of a sub-section in a package, class or
member description.
+`<div class="note">` | Note or example (use smaller font).
+`<ul>` or `<ol>` | Start a list with few space between the items
(useful for short descriptions).
+`<ul class="verbose">` | Start a list with more space between the items
(useful for long descriptions).
+`<table class="sis">` | Table with a blue header row and some space
between the cells
+`<table class="compact">` | Table without vertical space between the cells.
+`<td class="sep">` | Table cell with a vertical line on the left side.
+
MathML elements {#mathml}
@@ -263,7 +274,7 @@ Paragraphs {#paragraph}
Usages of the `<p>` tag should be relatively rare.
Do **not** use `<p>` for the first paragraph in a package, class or member
documentation,
or for the first paragraph after a `</ul>`, `</ol>`, `</table>`,
`</blockquote>`, `</pre>`,
-`{@preformat}` or `{@section}` element.
+or `{@preformat}` element.
The `<p>` tag shall be used only for separating a new paragraph from a
previous one.
In such cases, `<p>` shall have a matching `</p>` tag at the paragraph end in
order to form valid HTML.
