Author: vsiveton
Date: Wed Oct 29 04:29:48 2008
New Revision: 708880
URL: http://svn.apache.org/viewvc?rev=708880&view=rev
Log:
o more javadoc
Added:
maven/doxia/doxia/trunk/doxia-core/src/main/javadoc/
maven/doxia/doxia/trunk/doxia-core/src/main/javadoc/org/
maven/doxia/doxia/trunk/doxia-core/src/main/javadoc/org/apache/
maven/doxia/doxia/trunk/doxia-core/src/main/javadoc/org/apache/maven/
maven/doxia/doxia/trunk/doxia-core/src/main/javadoc/org/apache/maven/doxia/
maven/doxia/doxia/trunk/doxia-core/src/main/javadoc/org/apache/maven/doxia/package.html
(with props)
Modified:
maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/Doxia.java
maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/Parser.java
Modified:
maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/Doxia.java
URL:
http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/Doxia.java?rev=708880&r1=708879&r2=708880&view=diff
==============================================================================
---
maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/Doxia.java
(original)
+++
maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/Doxia.java
Wed Oct 29 04:29:48 2008
@@ -42,7 +42,8 @@
* Parses the given source model using a parser with given id,
* and emits Doxia events into the given sink.
*
- * @param source A reader that provides the source document.
+ * @param source not null reader that provides the source document.
+ * You could use <code>newReader</code> methods from [EMAIL PROTECTED]
org.codehaus.plexus.util.ReaderFactory}.
* @param parserId Identifier for the parser to use.
* @param sink A sink that consumes the Doxia events.
* @throws org.apache.maven.doxia.parser.manager.ParserNotFoundException
Modified:
maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/Parser.java
URL:
http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/Parser.java?rev=708880&r1=708879&r2=708880&view=diff
==============================================================================
---
maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/Parser.java
(original)
+++
maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/Parser.java
Wed Oct 29 04:29:48 2008
@@ -51,7 +51,8 @@
/**
* Parses the given source model and emits Doxia events into the given
sink.
*
- * @param source A reader that provides the source document.
+ * @param source not null reader that provides the source document.
+ * You could use <code>newReader</code> methods from [EMAIL PROTECTED]
org.codehaus.plexus.util.ReaderFactory}.
* @param sink A sink that consumes the Doxia events.
* @throws ParseException if the model could not be parsed.
*/
Added:
maven/doxia/doxia/trunk/doxia-core/src/main/javadoc/org/apache/maven/doxia/package.html
URL:
http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/javadoc/org/apache/maven/doxia/package.html?rev=708880&view=auto
==============================================================================
---
maven/doxia/doxia/trunk/doxia-core/src/main/javadoc/org/apache/maven/doxia/package.html
(added)
+++
maven/doxia/doxia/trunk/doxia-core/src/main/javadoc/org/apache/maven/doxia/package.html
Wed Oct 29 04:29:48 2008
@@ -0,0 +1,60 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+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.
+-->
+
+<body>
+ <h1>Maven Doxia API</h1>
+ <p>The Doxia API is based on <i>Sinks</i> and <i>Parser</i> objects: its
goal is to parse a given source model
+ using a given parser, and emits Doxia events into the given sink.</p>
+
+ <h2>Using Maven Doxia API</h2>
+ <p>The following snippet shows how to use the Doxia API:</p>
+
+ <div align="left" class="java">
+ <table border="0" cellpadding="3" cellspacing="0" bgcolor="#ffffff">
+ <tr>
+ <!-- start source code -->
+ <td nowrap="nowrap" valign="top" align="left">
+ <code>
+ <font color="#ffffff"> </font><font
color="#000000">File userDir = </font><font
color="#7f0055"><b>new </b></font><font color="#000000">File</font><font
color="#000000">( </font><font
color="#000000">System.getProperty </font><font
color="#000000">( </font><font
color="#2a00ff">"user.dir" </font><font
color="#000000">) )</font><font color="#000000">;</font><br />
+ <font color="#ffffff"> </font><font
color="#000000">File inputFile = </font><font
color="#7f0055"><b>new </b></font><font color="#000000">File</font><font
color="#000000">( </font><font color="#000000">userDir, </font><font
color="#2a00ff">"test.apt" </font><font
color="#000000">)</font><font color="#000000">;</font><br />
+ <font color="#ffffff"> </font><font
color="#000000">File outputFile = </font><font
color="#7f0055"><b>new </b></font><font color="#000000">File</font><font
color="#000000">( </font><font color="#000000">userDir, </font><font
color="#2a00ff">"test.html" </font><font
color="#000000">)</font><font color="#000000">;</font><br />
+ <font color="#ffffff"></font><br />
+ <font color="#ffffff"> </font><font
color="#000000">Reader source = ReaderFactory.newReader</font><font
color="#000000">( </font><font
color="#000000">inputFile, </font><font
color="#2a00ff">"UTF-8" </font><font color="#000000">)</font><font
color="#000000">;</font><br />
+ <font color="#ffffff"></font><br />
+ <font color="#ffffff"> </font><font
color="#000000">SinkFactory sinkFactory = </font><font
color="#000000">(</font><font color="#000000">SinkFactory</font><font
color="#000000">) </font><font color="#000000">lookup</font><font
color="#000000">( </font><font
color="#000000">SinkFactory.ROLE, </font><font
color="#2a00ff">"html" </font><font color="#000000">)</font><font
color="#000000">; </font><font
color="#3f7f5f">// Plexus lookup</font><br />
+ <font color="#ffffff"> </font><font
color="#000000">Sink sink = sinkFactory.createSink</font><font
color="#000000">( </font><font
color="#000000">outputFile.getParentFile</font><font
color="#000000">()</font><font
color="#000000">, outputFile.getName</font><font
color="#000000">() ) )</font><font color="#000000">;</font><br />
+ <font color="#ffffff"></font><br />
+ <font color="#ffffff"> </font><font
color="#000000">Doxia doxia = </font><font
color="#000000">(</font><font color="#000000">Doxia</font><font
color="#000000">) </font><font color="#000000">lookup</font><font
color="#000000">( </font><font
color="#000000">Doxia.ROLE </font><font color="#000000">)</font><font
color="#000000">; </font><font
color="#3f7f5f">// Plexus lookup</font><br />
+ <font color="#ffffff"></font><br />
+ <font color="#ffffff"> </font><font
color="#000000">doxia.parse</font><font color="#000000">( </font><font
color="#000000">source, </font><font
color="#2a00ff">"apt"</font><font
color="#000000">, sink </font><font color="#000000">)</font><font
color="#000000">;</font>
+ </code>
+ </td>
+ <!-- end source code -->
+ </tr>
+ </table>
+ </div>
+
+ <h2>Resources</h2>
+ <ul>
+ <li><a href="http://maven.apache.org/doxia/";>Maven Doxia Website</a></li>
+ <li><a href="http://plexus.codehaus.org/";>Plexus</a></li>
+ </ul>
+</body>
Propchange:
maven/doxia/doxia/trunk/doxia-core/src/main/javadoc/org/apache/maven/doxia/package.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange:
maven/doxia/doxia/trunk/doxia-core/src/main/javadoc/org/apache/maven/doxia/package.html
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
