Author: ebourg
Date: Wed Oct 9 12:51:18 2013
New Revision: 1530589
URL: http://svn.apache.org/r1530589
Log:
Documentation improvements
Modified:
commons/proper/jci/trunk/src/site/xdoc/index.xml
commons/proper/jci/trunk/src/site/xdoc/usage.xml
Modified: commons/proper/jci/trunk/src/site/xdoc/index.xml
URL:
http://svn.apache.org/viewvc/commons/proper/jci/trunk/src/site/xdoc/index.xml?rev=1530589&r1=1530588&r2=1530589&view=diff
==============================================================================
--- commons/proper/jci/trunk/src/site/xdoc/index.xml (original)
+++ commons/proper/jci/trunk/src/site/xdoc/index.xml Wed Oct 9 12:51:18 2013
@@ -22,19 +22,19 @@
<author email="[email protected]">Commons Documentation
Team</author>
</properties>
<body>
- <section name="The JCI Component">
+ <section name="Apache Commons JCI">
<p>
JCI is a java compiler interface. It can be used to either
compile java (or any other language that can be
- compiled to java classes like e.g. groovy or javascript) to
java. It is well integrated with a FAM (FilesystemAlterationMonitor)
- that can be used with the JCI compiling/reloading classloader.
All the currently supported compilers
- feature in-memory compilation.
+ compiled to java classes like e.g. groovy or javascript) to
java. It is well integrated with a filesystem
+ alteration monitor that can be used with the JCI
compiling/reloading classloader. All the currently
+ supported compilers feature in-memory compilation.
</p>
<p>The current implementation supports compilation via the
following compilers:</p>
<ul>
- <li>eclipse</li>
- <li>janino</li>
- <li>groovy</li>
- <li>rhino</li>
+ <li><a href="http://www.eclipse.org/jdt/core/";>Eclipse JDT
compiler</a></li>
+ <li><a
href="http://docs.codehaus.org/display/JANINO/Home";>Janino</a></li>
+ <li><a href="http://groovy.codehaus.org/";>Groovy</a></li>
+ <li><a href="http://www.mozilla.org/rhino";>Rhino</a></li>
</ul>
</section>
<section name="Releases">
@@ -44,7 +44,8 @@
</section>
<section name="Documentation">
<p>
- The <a href="apidocs/index.html">Javadoc API documents</a> are
available online.
+ The <a href="apidocs/index.html">Javadoc API documentation</a>
is available online.
+ See the <a href="usage.html">Usage page</a> for some examples.
</p>
</section>
</body>
Modified: commons/proper/jci/trunk/src/site/xdoc/usage.xml
URL:
http://svn.apache.org/viewvc/commons/proper/jci/trunk/src/site/xdoc/usage.xml?rev=1530589&r1=1530588&r2=1530589&view=diff
==============================================================================
--- commons/proper/jci/trunk/src/site/xdoc/usage.xml (original)
+++ commons/proper/jci/trunk/src/site/xdoc/usage.xml Wed Oct 9 12:51:18 2013
@@ -27,7 +27,7 @@
The <code>JavaCompiler</code> is quite simple. You have to
provide the paths to
the sources, where to get the sources from and where to store
the classes. Then
you just pick one of the compilers to do the work. The result
of the compilation
- is returned as <code>CompilationResult</code>.
+ is returned as a <code>CompilationResult</code>.
</p>
<source><![CDATA[
@@ -41,12 +41,13 @@ System.out.println( result.getWarnings()
Information like line numbers of errors etc are accessible in
a consistent way.
If supported by the compiler you can even get notified about
error before the
end of the compilation. (see the
<code>CompilationProblemHandler</code>) for that.
- The <a
href="http://commons.apache.org/jci/commons-jci-examples/index.html";>example
subproject</a>
- provides a simple <a
href="http://commons.apache.org/jci/xref/org/apache/commons/jci/examples/serverpages/ServerPageServlet.html";>JSP
servlet</a>
- and a javac-like <a
href="http://commons.apache.org/jci/xref/org/apache/commons/jci/examples/commandline/CommandlineCompiler.html";>command
line interface</a>.
+ The example module provides a simple
+ <a
href="xref/org/apache/commons/jci/examples/serverpages/ServerPageServlet.html">JSP
servlet</a>
+ and a javac-like <a
href="xref/org/apache/commons/jci/examples/commandline/CommandlineCompiler.html">command
line interface</a>.
</p>
</section>
+
<section name="Filesystem monitoring">
<p>
A subproject of JCI provides a
<code>FilesystemAlterationMonitor</code> that can
@@ -67,10 +68,25 @@ fam.start();
<p>
But you can also just implement a simple
<code>FilesystemAlterationListener</code>
yourself and just use it to get notified about configuration
files changes
- <a
href="http://commons.apache.org/jci/xref/org/apache/commons/jci/examples/configuration/ConfigurationReloading.html";>for
example</a>.
+ <a
href="xref/org/apache/commons/jci/examples/configuration/ConfigurationReloading.html">for
example</a>.
The example just extends the <code>FileChangeListener</code>
that provides a few convenience methods.
</p>
</section>
+
+ <section name="Maven artifacts">
+ <p>
+ Commons JCI is split into several modules, there is one artifact
per compiler. Using the Eclipse compiler
+ requires to declare the following dependency in your project:
+ </p>
+<source><![CDATA[ <dependency>
+ <groupId>org.apache.commons</groupId>
+ <artifactId>commons-jci-eclipse</artifactId>
+ <version>1.1</version>
+ </dependency>
+]]></source>
+ <p>The other artifacts are <code>commons-jci-groovy</code>,
<code>commons-jci-janino</code>
+ and <code>commons-jci-rhino</code>.</p>
+ </section>
</body>
</document>
