From 529c0d1e555772fd6e58c525446572f5d1e0062b Mon Sep 17 00:00:00 2001 From: "Brian M. Long" Date: Wed, 21 Dec 2022 16:40:14 -0500 Subject: [PATCH] added README --- README.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..7b893b1 --- /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.0 + + false + destDir + + -d d + --flavor bitbucket + --title 'API Documentation' + --apiName '${project.name} + + + + + + + + +``` + +You can generate the docs with the following command: + +``` +mvn -Papidocs generate-resources +``` + +The documentation is always generated relative to the `target/site/apidocs` directory. Hopefully that can be fixed in the future.