diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ee4dd59
--- /dev/null
+++ b/README.md
@@ -0,0 +1,49 @@
+# Activiti API Doclet
+
+This library provides a Javadoc Doclet for the generation of Activiti API documentation. You can use it by defining a Javadoc plugin in your Activiti extension Maven JAR project. That plugin should be configured to use this doclet. See the snippet below.
+
+```xml
+
+ apidocs
+
+
+
+ org.apache.maven.plugins
+ maven-javadoc-plugin
+ 3.4.1
+
+
+ generate-doclet
+ generate-resources
+ javadoc
+
+ com.inteligr8.activiti.doclet.ActivitiDoclet
+
+ com.inteligr8.activiti
+ activiti-api-doclet
+ 1.0.1
+
+ false
+ apidocs
+ ${basedir}
+
+ --flavor bitbucket
+ --title 'API Documentation'
+ --apiName '${project.name}
+
+
+
+
+
+
+
+
+```
+
+You can generate the docs with the following command:
+
+```
+mvn -Papidocs generate-resources
+```
+
+The documentation will be placed in `/`.
diff --git a/src/it/base/pom.xml b/src/it/base/pom.xml
index 9c6ce45..cccac76 100644
--- a/src/it/base/pom.xml
+++ b/src/it/base/pom.xml
@@ -50,10 +50,12 @@
@pom.version@
false
- destDir
+ apidocs
+ ${basedir}
- -d d
--flavor bitbucket
+ --title 'Example Title'
+ --apiName '${project.name}'
diff --git a/src/main/java/com/inteligr8/activiti/doclet/ActivitiDoclet.java b/src/main/java/com/inteligr8/activiti/doclet/ActivitiDoclet.java
index a7c2681..90a7781 100644
--- a/src/main/java/com/inteligr8/activiti/doclet/ActivitiDoclet.java
+++ b/src/main/java/com/inteligr8/activiti/doclet/ActivitiDoclet.java
@@ -44,7 +44,7 @@ import jdk.javadoc.doclet.Reporter;
public class ActivitiDoclet implements Doclet {
private final Logger logger = LoggerFactory.getLogger(this.getClass());
- private String outputDirectory;
+
private String flavor;
private String title;
private String apiName;
@@ -57,13 +57,6 @@ public class ActivitiDoclet implements Doclet {
@Override
public Set getSupportedOptions() {
return new HashSet<>(Arrays.asList(
- new PathOption("-d", "Destination directory for output files", Kind.STANDARD, "--destDir") {
- @Override
- public boolean process(String name, List valueAndClasses) {
- outputDirectory = valueAndClasses.get(0);
- return true;
- }
- },
new ValueOption("--flavor", "Flavor of the markdown host: github or bitbucket", Kind.STANDARD) {
@Override
public boolean process(String name, List valueAndClasses) {
@@ -122,7 +115,7 @@ public class ActivitiDoclet implements Doclet {
List beandocs = docfilter.build();
try {
- MarkdownWriter mdwriter = new MarkdownWriter(docenv, this.outputDirectory);
+ MarkdownWriter mdwriter = new MarkdownWriter(docenv);
if (this.title != null)
mdwriter.setTitle(this.title);
if (this.apiName != null)
@@ -192,18 +185,5 @@ public class ActivitiDoclet implements Doclet {
}
}
-
- private abstract class PathOption extends ValueOption {
-
- public PathOption(String name, String description, Kind kind, String... additionalNames) {
- super(name, description, kind, additionalNames);
- }
-
- @Override
- public String getParameters() {
- return "";
- }
-
- }
}
diff --git a/src/main/java/com/inteligr8/activiti/doclet/MarkdownWriter.java b/src/main/java/com/inteligr8/activiti/doclet/MarkdownWriter.java
index 9e5e1c5..15f001a 100644
--- a/src/main/java/com/inteligr8/activiti/doclet/MarkdownWriter.java
+++ b/src/main/java/com/inteligr8/activiti/doclet/MarkdownWriter.java
@@ -61,15 +61,9 @@ class MarkdownWriter {
private String apiName;
private String flavor;
- public MarkdownWriter(DocletEnvironment docenv, String outputDirectory) throws IOException {
+ public MarkdownWriter(DocletEnvironment docenv) throws IOException {
this.docenv = docenv;
- this.outputDirectory = (outputDirectory == null || outputDirectory.trim().length() == 0) ? new File(".") : new File(outputDirectory);
- this.fmconfig = this.getFreemarkerConfiguration();
- }
-
- public MarkdownWriter(DocletEnvironment docenv, File outputDirectory) throws IOException {
- this.docenv = docenv;
- this.outputDirectory = outputDirectory == null ? new File(".") : outputDirectory;
+ this.outputDirectory = new File(".");
this.fmconfig = this.getFreemarkerConfiguration();
}
@@ -111,7 +105,6 @@ class MarkdownWriter {
this.logger.debug("Building documentation index model");
IndexFreemarkerModel indexModel = new IndexFreemarkerModel();
- System.out.println("title: " + this.title);
indexModel.setTitle(this.title);
indexModel.setApiName(this.apiName);