Tools/texdoclet
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

README.md updated

Browse Source
This commit is contained in:
stfm
2012-06-23 11:10:27 +02:00
parent bafe49c1c5
commit 0dc425cf01
1 changed files with 10 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@@ -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 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 [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:
<http://java.net/projects/texdoclet>. <http://java.net/projects/texdoclet>.
See <http://doclet.github.com> for more information.
Build Build
----- -----
@@ -16,6 +18,12 @@ Build
Run 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 <path to>TeXDoclet.jar \
-doclet org.stfm.texdoclet.TeXDoclet \
<TeXDoclet parameters>
Example : Example :
javadoc -docletpath target/TeXDoclet.jar \ javadoc -docletpath target/TeXDoclet.jar \
@@ -31,7 +39,7 @@ Example :
-sourcepath src/main/java \ -sourcepath src/main/java \
-subpackages org:com -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 : Print help :