Author: hboutemy
Date: Sun Feb 13 17:37:35 2011
New Revision: 1070268
URL: http://svn.apache.org/viewvc?rev=1070268&view=rev
Log:
improved documentation
Modified:
maven/doxia/doxia/trunk/doxia-sink-api/src/site/apt/index.apt
Modified: maven/doxia/doxia/trunk/doxia-sink-api/src/site/apt/index.apt
URL:
http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-sink-api/src/site/apt/index.apt?rev=1070268&r1=1070267&r2=1070268&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-sink-api/src/site/apt/index.apt (original)
+++ maven/doxia/doxia/trunk/doxia-sink-api/src/site/apt/index.apt Sun Feb 13
17:37:35 2011
@@ -8,7 +8,27 @@
Doxia Sink API
- API to generate Doxia documents.
+ The <Sink> interface is a generic markup language interface provided as a
Java API.
+It contains several methods that encapsulate common text syntax. A start tag
is denoted by
+<<<xxxx()>>> method and a end of tag by <<<xxxx_()>>> method.
+
+ For instance, you could do things like:
+
++--
+sink.paragraph();
+sink.text( "my text" );
+sink.paragraph_();
++--
+
+ similar to this HTML markup:
+
++--
+<p>my text</p>
++--
+
+ To find out more about the Sink API, you can read the
+ {{{./apidocs/org/apache/maven/doxia/sink/Sink.html}Javadoc}}.
+
* API Changes
