From 0dc425cf01a8bd38fe86421913b8d4345d8b2ca2 Mon Sep 17 00:00:00 2001 From: stfm Date: Sat, 23 Jun 2012 11:10:27 +0200 Subject: [PATCH] README.md updated --- README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1fec60f..7894ed9 100644 --- a/README.md +++ b/README.md @@ -5,9 +5,11 @@ TeXDoclet is a Java doclet implementation that generates a LaTeX file from you J The doclet is based on the doclet originally created by Greg Wonderly of [C2 technologies Inc.](http://www.c2-tech.com>) and its revision by Soeren Caspersen of -[XO Software](http://www.xosoftware.dk). The project of Greg Wonderly is still available here: +[XO Software](http://www.xosoftware.dk). The project of Greg Wonderly is available here: . +See for more information. + Build ----- @@ -16,6 +18,12 @@ Build Run --- +You have to specify that *javadoc* has to use another doclet than the default doclet by giving the following parameters to the *javadoc* call : + + javadoc -docletpath TeXDoclet.jar \ + -doclet org.stfm.texdoclet.TeXDoclet \ + + Example : javadoc -docletpath target/TeXDoclet.jar \ @@ -31,7 +39,7 @@ Example : -sourcepath src/main/java \ -subpackages org:com -See createDocs.sh script in /examples dir how to run. +See `createDocs.sh` scripts in `/examples` subdirectory for more examples. Print help :