Skip to content
Open

RP #1

Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,17 @@ where:
and options are:

* -? prints usage to stdout; exits (optional)
* -d <f> output directory (required)
* -d &lt;f&gt; output directory (required)
* -ext &lt;s&gt; the output file extension, defaults to '.html' (optional)
* -h prints usage to stdout; exits (optional)
* -help displays verbose help information (optional)
* -tpl <f> alternative templates to use (optional)
* -tpl &lt;f&gt; alternative templates to use (optional)

## Maven dependencies

You'll need to install `jcmdline-1.0.1.jar` manually (Available from [here](http://jcmdline.sourceforge.net/)):
You'll need to install `jcmdline-2.0.0.jar` manually (Available from [here](http://jcmdline.sourceforge.net/)):

`mvn install:install-file -Dfile=jcmdline-1.0.1.jar -DgroupId=jcmdline -DartifactId=jcmdline -Dversion=1.0.1 -Dpackaging=jar`
`mvn install:install-file -Dfile=jcmdline-2.0.0.jar -DgroupId=jcmdline -DartifactId=jcmdline -Dversion=2.0.0 -Dpackaging=jar`

## Comment syntax

Expand All @@ -44,9 +45,9 @@ Example:
```
<#---
Does fancy stuff.

<p>And does it well !</p>

@param fist The first parameter.
@param second The second parameter, a <code>boolean</code>.
-->
Expand Down Expand Up @@ -91,4 +92,4 @@ To do so, use the `-tpl </path/to/tpl/folder` option. The folder must contains t
* `index-all-cat.ftl` : Index of categories.
* `index-all-alpha.ftl` : Alphabetical index.
* `overview.ftl` : Overview (list of documented `.ftl` libraries).
* `filelist.ftl` : List of documented `.ftl` files (Left side of the frameset).
* `filelist.ftl` : List of documented `.ftl` files (Left side of the frameset).
4 changes: 2 additions & 2 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<dependency>
<groupId>jcmdline</groupId>
<artifactId>jcmdline</artifactId>
<version>1.0.1</version>
<version>2.0.0</version>
<type>jar</type>
</dependency>
</dependencies>
Expand Down Expand Up @@ -57,4 +57,4 @@
</plugin>
</plugins>
</build>
</project>
</project>
Loading