Compare commits
4 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 45a9d8ae72 | |||
| 386c67d959 | |||
| 60a8b678d0 | |||
| 149e4035d7 |
58
README.md
58
README.md
@ -1,12 +1,6 @@
|
||||
# Activiti API Doclet
|
||||
|
||||
This library provides a Javadoc Doclet for the generation of Activiti API documentation.
|
||||
|
||||
## Generating Documentation
|
||||
|
||||
The generated documentation is formatted in Markdown. It works great when checked into your project stored in GitHub, Bitbucket, or similar Git-based web interface.
|
||||
|
||||
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.
|
||||
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
|
||||
<profile>
|
||||
@ -16,7 +10,7 @@ You can use it by defining a Javadoc plugin in your Activiti extension Maven JAR
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-javadoc-plugin</artifactId>
|
||||
<version>3.8.0</version>
|
||||
<version>3.4.1</version>
|
||||
<executions>
|
||||
<execution>
|
||||
<id>generate-doclet</id>
|
||||
@ -27,16 +21,25 @@ You can use it by defining a Javadoc plugin in your Activiti extension Maven JAR
|
||||
<docletArtifact>
|
||||
<groupId>com.inteligr8.activiti</groupId>
|
||||
<artifactId>activiti-api-doclet</artifactId>
|
||||
<version>1.1-SNAPSHOT</version>
|
||||
<<<<<<< HEAD
|
||||
<version>1.0.0</version>
|
||||
</docletArtifact>
|
||||
<useStandardDocletOptions>false</useStandardDocletOptions>
|
||||
<destDir>destDir</destDir>
|
||||
<additionalOptions>
|
||||
<additionalOption>-d d</additionalOption>
|
||||
=======
|
||||
<version>1.0.1</version>
|
||||
</docletArtifact>
|
||||
<useStandardDocletOptions>false</useStandardDocletOptions>
|
||||
<destDir>apidocs</destDir>
|
||||
<reportOutputDirectory>${basedir}</reportOutputDirectory>
|
||||
<additionalOptions>
|
||||
>>>>>>> develop
|
||||
<additionalOption>--flavor bitbucket</additionalOption>
|
||||
<additionalOption>--title 'API Documentation'</additionalOption>
|
||||
<additionalOption>--apiName '${project.name}</additionalOption>
|
||||
</additionalOptions>
|
||||
<sourceFileIncludes>**/*.java</sourceFileIncludes>
|
||||
<destDir>apidocs</destDir>
|
||||
<reportOutputDirectory>${basedir}</reportOutputDirectory>
|
||||
</configuration>
|
||||
</execution>
|
||||
</executions>
|
||||
@ -52,31 +55,8 @@ You can generate the docs with the following command:
|
||||
mvn -Papidocs generate-resources
|
||||
```
|
||||
|
||||
<<<<<<< HEAD
|
||||
The documentation is always generated relative to the `target/site/apidocs` directory. Hopefully that can be fixed in the future.
|
||||
=======
|
||||
The documentation will be placed in `<reportOutputDirectory>/<destDir>`.
|
||||
|
||||
## Special Considerations
|
||||
|
||||
This supports many standard tags used in JavaDoc comments. This includes support for the following:
|
||||
|
||||
| Tag | Classes/Interfaces | Methods |
|
||||
| ------------- |:------------------:|:-------:|
|
||||
| `@author` | ✓ | ✓ |
|
||||
| `@since` | ✓ | ✓ |
|
||||
| `@version` | ✓ | ✓ |
|
||||
| `@deprecated` | ✓ | ✓ |
|
||||
| `@see` | ✓ | ✓ |
|
||||
| `@param` | | ✓ |
|
||||
| `@return` | | ✓ |
|
||||
| `@throws` | | ✓ |
|
||||
|
||||
If the `@see` tag contains a `#` (e.g. `beanId#method`) then it will hyperlink to the specified bean and method documentation. If you use `beanId#` it will hyperlink to the bean documentation. You can use `beanId#delegate` if you want to hyperlink tot he bean and delegate method documentation.
|
||||
|
||||
If the `@throws` tag is a `BPMNError`, the next term is expected to be the error code, followed by the standard comment. For example, `@throws BPMNError http-404 Not found`.
|
||||
|
||||
The following additional non-standard tags are supported as well:
|
||||
|
||||
| Tag | Description |
|
||||
| ------------- | ----------- |
|
||||
| `@field` | A BPMN field name followed by the standard comment. This field may be used by the execution. |
|
||||
| `@varIn` | An Activiti variable name followed by the standard comment. This variable may be used by the execution. |
|
||||
| `@varOut` | An Activiti variable name followed by the standard comment. This variable may be set during the execution. |
|
||||
>>>>>>> develop
|
||||
|
||||
23
pom.xml
23
pom.xml
@ -4,7 +4,7 @@
|
||||
<groupId>com.inteligr8.activiti</groupId>
|
||||
<artifactId>activiti-api-doclet</artifactId>
|
||||
<packaging>jar</packaging>
|
||||
<version>1.1-SNAPSHOT</version>
|
||||
<version>1.0.1</version>
|
||||
|
||||
<name>Activiti Doclet</name>
|
||||
<description>JavaDoc Doclet for Activiti Extension APIs</description>
|
||||
@ -41,7 +41,7 @@
|
||||
<maven.compiler.release>11</maven.compiler.release>
|
||||
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
|
||||
|
||||
<spring.version>6.2.2</spring.version>
|
||||
<spring.version>5.3.24</spring.version>
|
||||
</properties>
|
||||
|
||||
<dependencies>
|
||||
@ -53,7 +53,7 @@
|
||||
<dependency>
|
||||
<groupId>org.freemarker</groupId>
|
||||
<artifactId>freemarker</artifactId>
|
||||
<version>2.3.34</version>
|
||||
<version>2.3.31</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.slf4j</groupId>
|
||||
@ -63,24 +63,16 @@
|
||||
</dependencies>
|
||||
|
||||
<build>
|
||||
<pluginManagement>
|
||||
<plugins>
|
||||
<plugin>
|
||||
<artifactId>maven-invoker-plugin</artifactId>
|
||||
<version>3.9.0</version>
|
||||
</plugin>
|
||||
</plugins>
|
||||
</pluginManagement>
|
||||
<plugins>
|
||||
<plugin>
|
||||
<artifactId>maven-invoker-plugin</artifactId>
|
||||
<version>3.2.2</version>
|
||||
<configuration>
|
||||
<projectsDirectory>${basedir}/src/it</projectsDirectory>
|
||||
<cloneProjectsTo>${project.build.directory}/it</cloneProjectsTo>
|
||||
<localRepositoryPath>${project.build.directory}/it-repo</localRepositoryPath>
|
||||
<mavenHome>${env.MAVEN_HOME}</mavenHome>
|
||||
<debug>true</debug>
|
||||
<skipInvocation>${skipTests}</skipInvocation>
|
||||
<properties>
|
||||
<project.main.basedir>${basedir}</project.main.basedir>
|
||||
</properties>
|
||||
@ -106,7 +98,7 @@
|
||||
<dependency>
|
||||
<groupId>org.activiti</groupId>
|
||||
<artifactId>activiti-engine</artifactId>
|
||||
<version>7.11.1</version>
|
||||
<version>7.4.0</version>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
<repositories>
|
||||
@ -127,6 +119,7 @@
|
||||
<plugins>
|
||||
<plugin>
|
||||
<artifactId>maven-invoker-plugin</artifactId>
|
||||
<version>3.2.2</version>
|
||||
<executions>
|
||||
<execution>
|
||||
<id>run-its</id>
|
||||
@ -165,7 +158,7 @@
|
||||
</plugin>
|
||||
<plugin>
|
||||
<artifactId>maven-javadoc-plugin</artifactId>
|
||||
<version>3.11.2</version>
|
||||
<version>3.4.1</version>
|
||||
<executions>
|
||||
<execution>
|
||||
<id>javadoc</id>
|
||||
@ -191,7 +184,7 @@
|
||||
<plugin>
|
||||
<groupId>org.sonatype.plugins</groupId>
|
||||
<artifactId>nexus-staging-maven-plugin</artifactId>
|
||||
<version>1.7.0</version>
|
||||
<version>1.6.13</version>
|
||||
<configuration>
|
||||
<serverId>ossrh</serverId>
|
||||
<nexusUrl>https://s01.oss.sonatype.org/</nexusUrl>
|
||||
|
||||
@ -22,12 +22,12 @@
|
||||
<dependency>
|
||||
<groupId>org.activiti</groupId>
|
||||
<artifactId>activiti-engine</artifactId>
|
||||
<version>7.11.1</version>
|
||||
<version>7.4.0</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.springframework</groupId>
|
||||
<artifactId>spring-context</artifactId>
|
||||
<version>6.2.2</version>
|
||||
<version>5.3.24</version>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
|
||||
@ -36,7 +36,7 @@
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-javadoc-plugin</artifactId>
|
||||
<version>3.11.2</version>
|
||||
<version>3.4.1</version>
|
||||
<executions>
|
||||
<execution>
|
||||
<id>generate-doclet</id>
|
||||
@ -50,14 +50,13 @@
|
||||
<version>@pom.version@</version>
|
||||
</docletArtifact>
|
||||
<useStandardDocletOptions>false</useStandardDocletOptions>
|
||||
<outputDirectory>${basedir}</outputDirectory>
|
||||
<destDir>apidocs</destDir>
|
||||
<reportOutputDirectory>${basedir}</reportOutputDirectory>
|
||||
<additionalOptions>
|
||||
<additionalOption>--flavor bitbucket</additionalOption>
|
||||
<additionalOption>--title 'Example Title'</additionalOption>
|
||||
<additionalOption>--apiName '${project.name}'</additionalOption>
|
||||
</additionalOptions>
|
||||
|
||||
<!-- This is required in maven-javadoc-plugin v3.5+ -->
|
||||
<sourceFileIncludes>**/*.java</sourceFileIncludes>
|
||||
</configuration>
|
||||
</execution>
|
||||
</executions>
|
||||
|
||||
@ -1,23 +0,0 @@
|
||||
|
||||
import org.springframework.stereotype.Component;
|
||||
|
||||
/**
|
||||
* This is an example comment for the class TestExtraTagsBean.
|
||||
*
|
||||
* @author brian@inteligr8.com
|
||||
* @version 1.0
|
||||
*/
|
||||
@Component("extra")
|
||||
public class TestExtraTagsBean {
|
||||
|
||||
/**
|
||||
* This is an example comment for the method apiMethod1()
|
||||
*
|
||||
* @field field1 An example field comment.
|
||||
* @varIn var1 An example input variable comment.
|
||||
* @varOut var2 An example output variable comment.
|
||||
*/
|
||||
public void apiMethod1() {
|
||||
}
|
||||
|
||||
}
|
||||
@ -7,8 +7,6 @@ import org.springframework.stereotype.Component;
|
||||
* Here is a second line that happens
|
||||
* to span multiple lines.
|
||||
*
|
||||
* Here is a {@link http://inteligr8.com} for testing purposes. And here is another { @link http://inteligr8.com } one.
|
||||
*
|
||||
* @author brian@inteligr8.com
|
||||
* @version 1.0
|
||||
*/
|
||||
@ -35,9 +33,8 @@ public class TestNamedBean {
|
||||
* This is an example comment for the method apiMethod3()
|
||||
*
|
||||
* @param param An example parameter comment.
|
||||
* @param classType An example generic parameter.
|
||||
*/
|
||||
public <T> void apiMethod3(String param, Class<T> classType) {
|
||||
public void apiMethod3(String param) {
|
||||
}
|
||||
|
||||
/**
|
||||
@ -84,12 +81,6 @@ public class TestNamedBean {
|
||||
* @param param A parameter comment.
|
||||
* @return A return comment.
|
||||
* @throws java.lang.Exception An exception comment.
|
||||
* @throws org.activiti.engine.delegate.BpmnError http-404
|
||||
* @throws BpmnError http-400 A client error.
|
||||
* @see test-sub.apiMethod10
|
||||
* @see {@link http://inteligr8.com}
|
||||
* @see [Inteligr8](http://inteligr8.com)
|
||||
* @see http://inteligr8.com
|
||||
*/
|
||||
public String apiMethod8(String param) throws Exception {
|
||||
return null;
|
||||
|
||||
@ -1,24 +0,0 @@
|
||||
|
||||
import org.activiti.engine.delegate.DelegateTask;
|
||||
import org.activiti.engine.delegate.TaskListener;
|
||||
import org.springframework.stereotype.Component;
|
||||
|
||||
/**
|
||||
* This is an example comment for the class TestNamedTaskListenerBean.
|
||||
*
|
||||
* Here is a second line that happens
|
||||
* to span multiple lines. This class does not have an author.
|
||||
*/
|
||||
@Component("testTaskListener")
|
||||
public class TestNamedTaskListenerBean implements TaskListener {
|
||||
|
||||
/**
|
||||
* This is an example method comment.
|
||||
*
|
||||
* @param task A delegate task for access to the activity and process instance.
|
||||
*/
|
||||
@Override
|
||||
public void notify(DelegateTask task) {
|
||||
}
|
||||
|
||||
}
|
||||
@ -31,10 +31,10 @@ class ActivitiApiBeanDoc {
|
||||
|
||||
private final String beanId;
|
||||
private TypeElement classElement;
|
||||
private boolean isDelegate = false;
|
||||
private boolean isExecutionListener = false;
|
||||
private boolean isTaskListener = false;
|
||||
private Map<String, ExecutableElement> methodElements = new HashMap<>();
|
||||
private ExecutableElement delegateMethodElement;
|
||||
private ExecutableElement executionListenerMethodElement;
|
||||
private ExecutableElement taskListenerMethodElement;
|
||||
|
||||
public ActivitiApiBeanDoc(String beanId, TypeElement classElement) {
|
||||
this.beanId = beanId;
|
||||
@ -49,41 +49,14 @@ class ActivitiApiBeanDoc {
|
||||
return classElement;
|
||||
}
|
||||
|
||||
public ExecutableElement getDelegateMethodElement() {
|
||||
return delegateMethodElement;
|
||||
}
|
||||
|
||||
public void setDelegateMethodElement(ExecutableElement delegateMethodElement) {
|
||||
this.delegateMethodElement = delegateMethodElement;
|
||||
}
|
||||
|
||||
public ExecutableElement getExecutionListenerMethodElement() {
|
||||
return executionListenerMethodElement;
|
||||
}
|
||||
|
||||
public void setExecutionListenerMethodElement(ExecutableElement executionListenerMethodElement) {
|
||||
this.executionListenerMethodElement = executionListenerMethodElement;
|
||||
}
|
||||
|
||||
public ExecutableElement getTaskListenerMethodElement() {
|
||||
return taskListenerMethodElement;
|
||||
}
|
||||
|
||||
public void setTaskListenerMethodElement(ExecutableElement taskListenerMethodElement) {
|
||||
this.taskListenerMethodElement = taskListenerMethodElement;
|
||||
}
|
||||
|
||||
public ActivitiApiBeanDoc addMethodElement(ExecutableElement method) {
|
||||
public ActivitiApiBeanDoc addMethod(ExecutableElement method) {
|
||||
this.methodElements.put(method.toString(), method);
|
||||
return this;
|
||||
}
|
||||
|
||||
public List<ExecutableElement> getMethodElements() {
|
||||
return new ArrayList<>(this.methodElements.values());
|
||||
}
|
||||
|
||||
public List<ExecutableElement> getSortedMethodElements() {
|
||||
List<ExecutableElement> methodElements = this.getMethodElements();
|
||||
List<ExecutableElement> methodElements = new ArrayList<>(this.methodElements.size());
|
||||
methodElements.addAll(this.methodElements.values());
|
||||
Collections.sort(methodElements, new Comparator<ExecutableElement>() {
|
||||
@Override
|
||||
public int compare(ExecutableElement methodElement1, ExecutableElement methodElement2) {
|
||||
@ -95,6 +68,30 @@ class ActivitiApiBeanDoc {
|
||||
return methodElements;
|
||||
}
|
||||
|
||||
public boolean isDelegate() {
|
||||
return isDelegate;
|
||||
}
|
||||
|
||||
public void setDelegate(boolean isDelegate) {
|
||||
this.isDelegate = isDelegate;
|
||||
}
|
||||
|
||||
public boolean isExecutionListener() {
|
||||
return isExecutionListener;
|
||||
}
|
||||
|
||||
public void setExecutionListener(boolean isExecutionListener) {
|
||||
this.isExecutionListener = isExecutionListener;
|
||||
}
|
||||
|
||||
public boolean isTaskListener() {
|
||||
return isTaskListener;
|
||||
}
|
||||
|
||||
public void setTaskListener(boolean isTaskListener) {
|
||||
this.isTaskListener = isTaskListener;
|
||||
}
|
||||
|
||||
@Override
|
||||
public String toString() {
|
||||
return this.beanId;
|
||||
|
||||
@ -14,22 +14,16 @@
|
||||
*/
|
||||
package com.inteligr8.activiti.doclet;
|
||||
|
||||
import java.util.ArrayList;
|
||||
import java.util.Collection;
|
||||
import java.util.Collections;
|
||||
import java.util.Comparator;
|
||||
import java.util.HashSet;
|
||||
import java.util.LinkedList;
|
||||
import java.util.List;
|
||||
import java.util.Set;
|
||||
|
||||
import javax.lang.model.element.Element;
|
||||
import javax.lang.model.element.ElementKind;
|
||||
import javax.lang.model.element.ExecutableElement;
|
||||
import javax.lang.model.element.Modifier;
|
||||
import javax.lang.model.element.TypeElement;
|
||||
import javax.lang.model.type.DeclaredType;
|
||||
import javax.lang.model.type.TypeKind;
|
||||
import javax.lang.model.type.TypeMirror;
|
||||
|
||||
import org.slf4j.Logger;
|
||||
@ -43,10 +37,6 @@ import jdk.javadoc.doclet.DocletEnvironment;
|
||||
*/
|
||||
class ActivitiDocFilter {
|
||||
|
||||
private final static String INTERFACE_JAVA_DELEGATE = "org.activiti.engine.delegate.JavaDelegate";
|
||||
private final static String INTERFACE_EXECUTION_LISTENER = "org.activiti.engine.delegate.ExecutionListener";
|
||||
private final static String INTERFACE_TASK_LISTENER = "org.activiti.engine.delegate.TaskListener";
|
||||
|
||||
private final Logger logger = LoggerFactory.getLogger(this.getClass());
|
||||
private final List<ActivitiApiBeanDoc> beandocs = new LinkedList<>();
|
||||
private final DocletEnvironment docenv;
|
||||
@ -98,45 +88,28 @@ class ActivitiDocFilter {
|
||||
this.logger.debug("Adding named bean: {} => {}", beanId, classElement);
|
||||
|
||||
ActivitiApiBeanDoc beandoc = new ActivitiApiBeanDoc(beanId, classElement);
|
||||
|
||||
Set<String> delegateMethodElements = new HashSet<>(5);
|
||||
Set<String> executionListenerMethodElements = new HashSet<>(5);
|
||||
Set<String> taskListenerMethodElements = new HashSet<>(5);
|
||||
|
||||
// getAllTypeElements() will get inherited interfaces
|
||||
TypeElement superclassElement = classElement;
|
||||
while (superclassElement != null) {
|
||||
for (TypeMirror interfaceType : superclassElement.getInterfaces()) {
|
||||
this.logger.trace("Found interface '{}' on bean '{}'", interfaceType, beanId);
|
||||
|
||||
switch (interfaceType.toString()) {
|
||||
case INTERFACE_JAVA_DELEGATE:
|
||||
this.logger.debug("The bean '{}' is a JavaDelegate", beanId);
|
||||
delegateMethodElements.addAll(this.toStrings(this.docenv.getTypeUtils().asElement(interfaceType).getEnclosedElements()));
|
||||
break;
|
||||
case INTERFACE_EXECUTION_LISTENER:
|
||||
this.logger.debug("The bean '{}' is a ExecutionListener", beanId);
|
||||
executionListenerMethodElements.addAll(this.toStrings(this.docenv.getTypeUtils().asElement(interfaceType).getEnclosedElements()));
|
||||
break;
|
||||
case INTERFACE_TASK_LISTENER:
|
||||
this.logger.debug("The bean '{}' is a TaskListener", beanId);
|
||||
taskListenerMethodElements.addAll(this.toStrings(this.docenv.getTypeUtils().asElement(interfaceType).getEnclosedElements()));
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
TypeMirror superclassMirror = superclassElement.getSuperclass();
|
||||
if (superclassMirror == null) {
|
||||
superclassElement = null;
|
||||
} else if (superclassMirror.getKind() != TypeKind.DECLARED) {
|
||||
superclassElement = null;
|
||||
} else {
|
||||
superclassElement = (TypeElement) ((DeclaredType) superclassMirror).asElement();
|
||||
for (TypeMirror interfaceType : classElement.getInterfaces()) {
|
||||
this.logger.info("{} contains {}", beanId, interfaceType);
|
||||
this.logger.trace("Found interface '{}' on bean '{}'", interfaceType, beanId);
|
||||
|
||||
switch (interfaceType.toString()) {
|
||||
case "org.activiti.engine.delegate.JavaDelegate":
|
||||
this.logger.debug("The bean '{}' is a JavaDelegate", beanId);
|
||||
beandoc.setDelegate(true);
|
||||
break;
|
||||
case "org.activiti.engine.delegate.ExecutionListener":
|
||||
this.logger.debug("The bean '{}' is a ExecutionListener", beanId);
|
||||
beandoc.setExecutionListener(true);
|
||||
break;
|
||||
case "org.activiti.engine.delegate.TaskListener":
|
||||
this.logger.debug("The bean '{}' is a TaskListener", beanId);
|
||||
beandoc.setTaskListener(true);
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
this.logger.info("delegates: {}: {}", beanId, delegateMethodElements);
|
||||
|
||||
// getAllMembers() will get inherited methods
|
||||
for (Element memberElement : this.docenv.getElementUtils().getAllMembers(classElement)) {
|
||||
switch (memberElement.getKind()) {
|
||||
@ -144,33 +117,22 @@ class ActivitiDocFilter {
|
||||
ExecutableElement methodElement = (ExecutableElement)memberElement;
|
||||
|
||||
if (!methodElement.getModifiers().contains(Modifier.PUBLIC)) {
|
||||
this.logger.trace("Skipping non-public method: {}.{}", classElement, methodElement.getSimpleName());
|
||||
this.logger.trace("Skipping non-public method: {}#{}", classElement, methodElement.getSimpleName());
|
||||
continue;
|
||||
}
|
||||
|
||||
if (methodElement.getModifiers().contains(Modifier.ABSTRACT)) {
|
||||
this.logger.trace("Skipping abstract method: {}.{}", classElement, methodElement.getSimpleName());
|
||||
this.logger.trace("Skipping abstract method: {}#{}", classElement, methodElement.getSimpleName());
|
||||
continue;
|
||||
}
|
||||
|
||||
if (this.skipObjectMethods && methodElement.getEnclosingElement().toString().equals("java.lang.Object")) {
|
||||
this.logger.trace("Skipping java.lang.Object method: {}.{}", classElement, methodElement.getSimpleName());
|
||||
this.logger.trace("Skipping java.lang.Object methods: {}#{}", classElement, methodElement.getSimpleName());
|
||||
continue;
|
||||
}
|
||||
|
||||
if (delegateMethodElements.contains(methodElement.toString())) {
|
||||
this.logger.debug("The bean '{}' has delegate method '{}'", beanId, methodElement);
|
||||
beandoc.setDelegateMethodElement(methodElement);
|
||||
} else if (executionListenerMethodElements.contains(methodElement.toString())) {
|
||||
this.logger.debug("The bean '{}' has execution listener method '{}'", beanId, methodElement);
|
||||
beandoc.setExecutionListenerMethodElement(methodElement);
|
||||
} else if (taskListenerMethodElements.contains(methodElement.toString())) {
|
||||
this.logger.debug("The bean '{}' has task listener method '{}'", beanId, methodElement);
|
||||
beandoc.setTaskListenerMethodElement(methodElement);
|
||||
} else {
|
||||
this.logger.debug("The bean '{}' has method '{}'", beanId, methodElement);
|
||||
beandoc.addMethodElement(methodElement);
|
||||
}
|
||||
|
||||
this.logger.debug("The bean '{}' has method '{}'", beanId, methodElement);
|
||||
beandoc.addMethod(methodElement);
|
||||
break;
|
||||
default:
|
||||
}
|
||||
@ -192,15 +154,5 @@ class ActivitiDocFilter {
|
||||
|
||||
return beandocs;
|
||||
}
|
||||
|
||||
public List<String> toStrings(Collection<? extends Element> elements) {
|
||||
if (elements == null)
|
||||
return Collections.emptyList();
|
||||
|
||||
List<String> strs = new ArrayList<String>(elements.size());
|
||||
for (Element element : elements)
|
||||
strs.add(element.toString());
|
||||
return strs;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
@ -45,6 +45,7 @@ public class ActivitiDoclet implements Doclet {
|
||||
|
||||
private final Logger logger = LoggerFactory.getLogger(this.getClass());
|
||||
|
||||
private String flavor;
|
||||
private String title;
|
||||
private String apiName;
|
||||
|
||||
@ -56,6 +57,17 @@ public class ActivitiDoclet implements Doclet {
|
||||
@Override
|
||||
public Set<? extends Option> getSupportedOptions() {
|
||||
return new HashSet<>(Arrays.asList(
|
||||
new ValueOption("--flavor", "Flavor of the markdown host: github or bitbucket", Kind.STANDARD) {
|
||||
@Override
|
||||
public boolean process(String name, List<String> valueAndClasses) {
|
||||
flavor = valueAndClasses.get(0);
|
||||
return true;
|
||||
}
|
||||
|
||||
public String getParameters() {
|
||||
return "'github' or 'bitbucket'";
|
||||
}
|
||||
},
|
||||
new ValueOption("--title", "Title for documentation", Kind.STANDARD) {
|
||||
@Override
|
||||
public boolean process(String name, List<String> valueAndClasses) {
|
||||
@ -108,6 +120,8 @@ public class ActivitiDoclet implements Doclet {
|
||||
mdwriter.setTitle(this.title);
|
||||
if (this.apiName != null)
|
||||
mdwriter.setApiName(this.apiName);
|
||||
if (this.flavor != null)
|
||||
mdwriter.setFlavor(this.flavor);
|
||||
mdwriter.write(beandocs);
|
||||
return true;
|
||||
} catch (TemplateException te) {
|
||||
|
||||
@ -14,15 +14,17 @@
|
||||
*/
|
||||
package com.inteligr8.activiti.doclet;
|
||||
|
||||
import java.util.HashSet;
|
||||
import java.util.LinkedHashMap;
|
||||
import java.util.LinkedList;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
import java.util.Set;
|
||||
|
||||
/**
|
||||
* @author brian@inteligr8.com
|
||||
*/
|
||||
public class BeanFreemarkerModel implements JavadocDocumentable, JavadocTaggable {
|
||||
public class BeanFreemarkerModel {
|
||||
|
||||
private String title;
|
||||
|
||||
@ -30,19 +32,15 @@ public class BeanFreemarkerModel implements JavadocDocumentable, JavadocTaggable
|
||||
|
||||
private String beanId;
|
||||
|
||||
private String bookmark;
|
||||
|
||||
private String docFirstSentence;
|
||||
|
||||
private String docBody;
|
||||
|
||||
private MethodSignatureFreemarkerModel delegateMethod;
|
||||
|
||||
private MethodSignatureFreemarkerModel executionListenerMethod;
|
||||
|
||||
private MethodSignatureFreemarkerModel taskListenerMethod;
|
||||
private Set<String> delegateRoles = new HashSet<>();
|
||||
|
||||
private Map<String, List<String>> tags = new LinkedHashMap<>();
|
||||
|
||||
private List<ReferenceFreemarkerModel> seeRefs = new LinkedList<>();
|
||||
|
||||
private List<MethodFreemarkerModel> methods = new LinkedList<>();
|
||||
|
||||
@ -70,6 +68,14 @@ public class BeanFreemarkerModel implements JavadocDocumentable, JavadocTaggable
|
||||
this.beanId = beanId;
|
||||
}
|
||||
|
||||
public String getBookmark() {
|
||||
return bookmark;
|
||||
}
|
||||
|
||||
public void setBookmark(String bookmark) {
|
||||
this.bookmark = bookmark;
|
||||
}
|
||||
|
||||
public String getDocFirstSentence() {
|
||||
return docFirstSentence;
|
||||
}
|
||||
@ -85,33 +91,13 @@ public class BeanFreemarkerModel implements JavadocDocumentable, JavadocTaggable
|
||||
public void setDocBody(String docBody) {
|
||||
this.docBody = docBody;
|
||||
}
|
||||
|
||||
public boolean isHasDelegate() {
|
||||
return this.delegateMethod != null || this.executionListenerMethod != null || this.taskListenerMethod != null;
|
||||
|
||||
public Set<String> getDelegateRoles() {
|
||||
return delegateRoles;
|
||||
}
|
||||
|
||||
public MethodSignatureFreemarkerModel getDelegateMethod() {
|
||||
return delegateMethod;
|
||||
}
|
||||
|
||||
public void setDelegateMethod(MethodSignatureFreemarkerModel delegateMethod) {
|
||||
this.delegateMethod = delegateMethod;
|
||||
}
|
||||
|
||||
public MethodSignatureFreemarkerModel getExecutionListenerMethod() {
|
||||
return executionListenerMethod;
|
||||
}
|
||||
|
||||
public void setExecutionListenerMethod(MethodSignatureFreemarkerModel executionListenerMethod) {
|
||||
this.executionListenerMethod = executionListenerMethod;
|
||||
}
|
||||
|
||||
public MethodSignatureFreemarkerModel getTaskListenerMethod() {
|
||||
return taskListenerMethod;
|
||||
}
|
||||
|
||||
public void setTaskListenerMethod(MethodSignatureFreemarkerModel taskListenerMethod) {
|
||||
this.taskListenerMethod = taskListenerMethod;
|
||||
|
||||
public void setDelegateRoles(Set<String> delegateRoles) {
|
||||
this.delegateRoles = delegateRoles;
|
||||
}
|
||||
|
||||
public Map<String, List<String>> getTags() {
|
||||
@ -121,15 +107,6 @@ public class BeanFreemarkerModel implements JavadocDocumentable, JavadocTaggable
|
||||
public void setTags(Map<String, List<String>> tags) {
|
||||
this.tags = tags;
|
||||
}
|
||||
|
||||
@Override
|
||||
public List<ReferenceFreemarkerModel> getSeeRefs() {
|
||||
return seeRefs;
|
||||
}
|
||||
|
||||
public void setSeeRefs(List<ReferenceFreemarkerModel> seeRefs) {
|
||||
this.seeRefs = seeRefs;
|
||||
}
|
||||
|
||||
public List<MethodFreemarkerModel> getMethods() {
|
||||
return methods;
|
||||
|
||||
@ -1,42 +0,0 @@
|
||||
/*
|
||||
* This program is free software: you can redistribute it and/or modify it
|
||||
* under the terms of the GNU Lesser General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or (at your
|
||||
* option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful, but WITHOUT
|
||||
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
||||
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
|
||||
* more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License along
|
||||
* with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/
|
||||
package com.inteligr8.activiti.doclet;
|
||||
|
||||
/**
|
||||
* @author brian@inteligr8.com
|
||||
*/
|
||||
public class FieldFreemarkerModel {
|
||||
|
||||
private String name;
|
||||
|
||||
private String comment;
|
||||
|
||||
public String getName() {
|
||||
return name;
|
||||
}
|
||||
|
||||
public void setName(String name) {
|
||||
this.name = name;
|
||||
}
|
||||
|
||||
public String getComment() {
|
||||
return comment;
|
||||
}
|
||||
|
||||
public void setComment(String comment) {
|
||||
this.comment = comment;
|
||||
}
|
||||
|
||||
}
|
||||
@ -1,95 +0,0 @@
|
||||
package com.inteligr8.activiti.doclet;
|
||||
|
||||
import java.util.Collection;
|
||||
import java.util.Map;
|
||||
import java.util.Set;
|
||||
|
||||
public class FluentMap<K, V> implements Map<K, V> {
|
||||
|
||||
private Map<K, V> map;
|
||||
|
||||
public FluentMap(Map<K, V> map) {
|
||||
this.map = map;
|
||||
}
|
||||
|
||||
@Override
|
||||
public void clear() {
|
||||
this.map.clear();
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean containsKey(Object key) {
|
||||
return this.map.containsKey(key);
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean containsValue(Object value) {
|
||||
return this.map.containsValue(value);
|
||||
}
|
||||
|
||||
@Override
|
||||
public Set<Entry<K, V>> entrySet() {
|
||||
return this.map.entrySet();
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean equals(Object obj) {
|
||||
return this.map.equals(obj);
|
||||
}
|
||||
|
||||
@Override
|
||||
public V get(Object key) {
|
||||
return this.map.get(key);
|
||||
}
|
||||
|
||||
@Override
|
||||
public int hashCode() {
|
||||
return this.map.hashCode();
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean isEmpty() {
|
||||
return this.map.isEmpty();
|
||||
}
|
||||
|
||||
@Override
|
||||
public Set<K> keySet() {
|
||||
return this.map.keySet();
|
||||
}
|
||||
|
||||
@Override
|
||||
public V put(K key, V value) {
|
||||
return this.map.put(key, value);
|
||||
}
|
||||
|
||||
@Override
|
||||
public void putAll(Map<? extends K, ? extends V> m) {
|
||||
this.map.putAll(m);
|
||||
}
|
||||
|
||||
@Override
|
||||
public V remove(Object key) {
|
||||
return this.map.remove(key);
|
||||
}
|
||||
|
||||
@Override
|
||||
public int size() {
|
||||
return this.map.size();
|
||||
}
|
||||
|
||||
@Override
|
||||
public Collection<V> values() {
|
||||
return this.map.values();
|
||||
}
|
||||
|
||||
public FluentMap<K, V> with(K key, V value) {
|
||||
this.map.put(key, value);
|
||||
return this;
|
||||
}
|
||||
|
||||
public FluentMap<K, V> without(K key) {
|
||||
this.map.remove(key);
|
||||
return this;
|
||||
}
|
||||
|
||||
}
|
||||
@ -27,10 +27,6 @@ public class IndexFreemarkerModel {
|
||||
private String apiName;
|
||||
|
||||
private List<BeanFreemarkerModel> beans = new LinkedList<>();
|
||||
|
||||
private boolean hasDelegateBeans;
|
||||
|
||||
private boolean hasMethodBeans;
|
||||
|
||||
public String getTitle() {
|
||||
return title;
|
||||
@ -55,21 +51,5 @@ public class IndexFreemarkerModel {
|
||||
public void setBeans(List<BeanFreemarkerModel> beans) {
|
||||
this.beans = beans;
|
||||
}
|
||||
|
||||
public boolean isHasDelegateBeans() {
|
||||
return hasDelegateBeans;
|
||||
}
|
||||
|
||||
public void setHasDelegateBeans(boolean hasDelegateBeans) {
|
||||
this.hasDelegateBeans = hasDelegateBeans;
|
||||
}
|
||||
|
||||
public boolean isHasMethodBeans() {
|
||||
return hasMethodBeans;
|
||||
}
|
||||
|
||||
public void setHasMethodBeans(boolean hasMethodBeans) {
|
||||
this.hasMethodBeans = hasMethodBeans;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
@ -1,30 +0,0 @@
|
||||
/*
|
||||
* This program is free software: you can redistribute it and/or modify it
|
||||
* under the terms of the GNU Lesser General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or (at your
|
||||
* option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful, but WITHOUT
|
||||
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
||||
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
|
||||
* more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License along
|
||||
* with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/
|
||||
package com.inteligr8.activiti.doclet;
|
||||
|
||||
/**
|
||||
* @author brian@inteligr8.com
|
||||
*/
|
||||
public interface JavadocDocumentable {
|
||||
|
||||
String getDocFirstSentence();
|
||||
|
||||
void setDocFirstSentence(String docFirstSentence);
|
||||
|
||||
String getDocBody();
|
||||
|
||||
void setDocBody(String docBody);
|
||||
|
||||
}
|
||||
@ -1,29 +0,0 @@
|
||||
/*
|
||||
* This program is free software: you can redistribute it and/or modify it
|
||||
* under the terms of the GNU Lesser General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or (at your
|
||||
* option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful, but WITHOUT
|
||||
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
||||
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
|
||||
* more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License along
|
||||
* with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/
|
||||
package com.inteligr8.activiti.doclet;
|
||||
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
|
||||
/**
|
||||
* @author brian@inteligr8.com
|
||||
*/
|
||||
public interface JavadocTaggable {
|
||||
|
||||
Map<String, List<String>> getTags();
|
||||
|
||||
List<ReferenceFreemarkerModel> getSeeRefs();
|
||||
|
||||
}
|
||||
@ -18,15 +18,11 @@ import java.io.File;
|
||||
import java.io.IOException;
|
||||
import java.io.PrintWriter;
|
||||
import java.nio.charset.Charset;
|
||||
import java.util.Arrays;
|
||||
import java.util.HashMap;
|
||||
import java.util.HashSet;
|
||||
import java.util.LinkedHashMap;
|
||||
import java.util.LinkedList;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
import java.util.Map.Entry;
|
||||
import java.util.Set;
|
||||
import java.util.regex.Matcher;
|
||||
import java.util.regex.Pattern;
|
||||
|
||||
@ -38,8 +34,10 @@ import javax.lang.model.type.TypeMirror;
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
|
||||
import com.sun.source.doctree.BlockTagTree;
|
||||
import com.sun.source.doctree.DocCommentTree;
|
||||
import com.sun.source.doctree.DocTree;
|
||||
import com.sun.source.doctree.InlineTagTree;
|
||||
import com.sun.source.util.DocTrees;
|
||||
|
||||
import freemarker.template.Configuration;
|
||||
@ -54,28 +52,14 @@ import jdk.javadoc.doclet.DocletEnvironment;
|
||||
class MarkdownWriter {
|
||||
|
||||
private final Logger logger = LoggerFactory.getLogger(this.getClass());
|
||||
private final Set<String> bpmnErrorSet = new HashSet<>(Arrays.asList(
|
||||
"BpmnError".toLowerCase(),
|
||||
"org.activiti.engine.delegate.BpmnError".toLowerCase()));
|
||||
|
||||
private final Pattern tagPattern = Pattern.compile("@([^ ]+) ?(.*)$");
|
||||
private final Pattern namedCommentPattern = Pattern.compile("([^ ]+) ?(.*)$");
|
||||
private final Map<Pattern, String> sanitizations = new FluentMap<>(new LinkedHashMap<Pattern, String>())
|
||||
.with(Pattern.compile("^[ ]+", Pattern.MULTILINE), "")
|
||||
.with(Pattern.compile("\r\n", Pattern.MULTILINE), "\n")
|
||||
.with(Pattern.compile("([^\n])\n([^\n])", Pattern.MULTILINE), "$1 $2")
|
||||
.with(Pattern.compile("([^\\.\\?!])[ ]{2}", Pattern.MULTILINE), "$1 ")
|
||||
.with(Pattern.compile("\\{ ?(@[^}]+) \\}"), "{$1}")
|
||||
.with(Pattern.compile("\\{@link ([^}]+)\\}"), "[$1]($1)")
|
||||
.with(Pattern.compile("([A-Za-z0-9\\-\\._]+@[A-Za-z0-9\\-\\._]+)"), "[$1](mailto:$1)");
|
||||
private final Pattern seeRefPattern = Pattern.compile("^([A-Za-z0-9_\\-]+)[\\.#]([A-Za-z0-9_]*)$");
|
||||
|
||||
private final Pattern tagPattern = Pattern.compile("@[^ ]+ ?(.*)$");
|
||||
private final Pattern namedTagPattern = Pattern.compile("@[^ ]+ ([^ ]+) ?(.*)$");
|
||||
private final DocletEnvironment docenv;
|
||||
private final File outputDirectory;
|
||||
private final Configuration fmconfig;
|
||||
|
||||
private String title = "API Documentation";
|
||||
private String apiName;
|
||||
private String flavor;
|
||||
|
||||
public MarkdownWriter(DocletEnvironment docenv) throws IOException {
|
||||
this.docenv = docenv;
|
||||
@ -102,6 +86,10 @@ class MarkdownWriter {
|
||||
this.apiName = apiName;
|
||||
}
|
||||
|
||||
public void setFlavor(String flavor) {
|
||||
this.flavor = flavor;
|
||||
}
|
||||
|
||||
public void write(List<ActivitiApiBeanDoc> beandocs) throws IOException, TemplateException {
|
||||
IndexFreemarkerModel model = this.buildModel(beandocs);
|
||||
|
||||
@ -129,46 +117,136 @@ class MarkdownWriter {
|
||||
beanModel.setTitle(this.title);
|
||||
beanModel.setApiName(this.apiName);
|
||||
beanModel.setBeanId(beandoc.getBeanId());
|
||||
beanModel.setBookmark(this.formatBookmark(beanModel.getBeanId()));
|
||||
if (beandoc.isDelegate())
|
||||
beanModel.getDelegateRoles().add("ServiceTask");
|
||||
if (beandoc.isExecutionListener())
|
||||
beanModel.getDelegateRoles().add("ExecutionListener");
|
||||
if (beandoc.isTaskListener())
|
||||
beanModel.getDelegateRoles().add("TaskListener");
|
||||
if (commentTree != null) {
|
||||
this.logger.debug("Found documentation for bean: {}", beandoc.getBeanId());
|
||||
|
||||
this.buildDocumentation(commentTree, beanModel);
|
||||
if (commentTree.getFirstSentence() != null)
|
||||
beanModel.setDocFirstSentence(commentTree.getFirstSentence().toString());
|
||||
if (commentTree.getBody() != null)
|
||||
beanModel.setDocBody(commentTree.getFullBody().toString());
|
||||
for (DocTree tag : commentTree.getBlockTags()) {
|
||||
this.buildTagModel(tag, beandoc.getBeanId(),
|
||||
null, null, null, null, null, null, beanModel);
|
||||
String tagName = null;
|
||||
if (tag instanceof BlockTagTree) {
|
||||
tagName = ((BlockTagTree)tag).getTagName();
|
||||
} else if (tag instanceof InlineTagTree) {
|
||||
tagName = ((InlineTagTree)tag).getTagName();
|
||||
} else {
|
||||
this.logger.error("A tag comment is not of an expected type: {}", tag.getClass());
|
||||
continue;
|
||||
}
|
||||
|
||||
this.logger.trace("Found tag '{}' for bean: {}", tagName, beandoc.getBeanId());
|
||||
this.putAdd(beanModel.getTags(), tagName, tag.toString());
|
||||
}
|
||||
}
|
||||
|
||||
if (beandoc.getDelegateMethodElement() != null) {
|
||||
beanModel.setDelegateMethod(this.buildMethodSignatureModel(beandoc, beandoc.getDelegateMethodElement()));
|
||||
indexModel.setHasDelegateBeans(true);
|
||||
}
|
||||
if (beandoc.getExecutionListenerMethodElement() != null) {
|
||||
beanModel.setExecutionListenerMethod(this.buildMethodSignatureModel(beandoc, beandoc.getExecutionListenerMethodElement()));
|
||||
indexModel.setHasDelegateBeans(true);
|
||||
}
|
||||
if (beandoc.getTaskListenerMethodElement() != null) {
|
||||
beanModel.setTaskListenerMethod(this.buildMethodSignatureModel(beandoc, beandoc.getTaskListenerMethodElement()));
|
||||
indexModel.setHasDelegateBeans(true);
|
||||
}
|
||||
|
||||
Map<Name, MethodFreemarkerModel> methodOverloads = new LinkedHashMap<>();
|
||||
|
||||
for (ExecutableElement methodElement : beandoc.getSortedMethodElements()) {
|
||||
MethodSignatureFreemarkerModel sigModel = this.buildMethodSignatureModel(beandoc, methodElement);
|
||||
DocCommentTree methodCommentTree = docs.getDocCommentTree(methodElement);
|
||||
|
||||
this.logger.debug("Building documentation method model: {}.{}", beandoc.getBeanId(), methodElement);
|
||||
|
||||
MethodFreemarkerModel methodModel = methodOverloads.get(methodElement.getSimpleName());
|
||||
if (methodModel == null) {
|
||||
methodModel = new MethodFreemarkerModel();
|
||||
methodModel.setMethodName(methodElement.getSimpleName().toString());
|
||||
methodModel.setBookmark(this.formatBookmark(methodModel.getMethodName()));
|
||||
|
||||
methodOverloads.put(methodElement.getSimpleName(), methodModel);
|
||||
beanModel.getMethods().add(methodModel);
|
||||
indexModel.setHasMethodBeans(true);
|
||||
}
|
||||
|
||||
if (sigModel.getDocFirstSentence() != null && methodModel.getDocFirstSentence() == null)
|
||||
methodModel.setDocFirstSentence(sigModel.getDocFirstSentence());
|
||||
Map<String, String> paramComments = new HashMap<>();
|
||||
Map<String, String> throwComments = new HashMap<>();
|
||||
|
||||
MethodSignatureFreemarkerModel sigModel = new MethodSignatureFreemarkerModel();
|
||||
if (methodCommentTree != null) {
|
||||
this.logger.debug("Found documentation for method: {}.{}", beandoc.getBeanId(), methodElement);
|
||||
|
||||
if (methodCommentTree.getFirstSentence() != null) {
|
||||
if (methodModel.getDocFirstSentence() == null)
|
||||
methodModel.setDocFirstSentence(methodCommentTree.getFirstSentence().toString());
|
||||
sigModel.setDocFirstSentence(methodCommentTree.getFirstSentence().toString());
|
||||
}
|
||||
if (methodCommentTree.getBody() != null)
|
||||
sigModel.setDocBody(methodCommentTree.getFullBody().toString());
|
||||
for (DocTree tag : methodCommentTree.getBlockTags()) {
|
||||
String tagName = null;
|
||||
if (tag instanceof BlockTagTree) {
|
||||
tagName = ((BlockTagTree)tag).getTagName();
|
||||
} else if (tag instanceof InlineTagTree) {
|
||||
tagName = ((InlineTagTree)tag).getTagName();
|
||||
} else {
|
||||
this.logger.error("A tag comment is not of an expected type: {}", tag.getClass());
|
||||
continue;
|
||||
}
|
||||
|
||||
this.logger.trace("Found tag '{}' for method: {}.{}", tagName, beandoc.getBeanId(), methodElement);
|
||||
|
||||
Matcher matcher;
|
||||
switch (tagName) {
|
||||
case "param":
|
||||
matcher = this.namedTagPattern.matcher(tag.toString());
|
||||
if (matcher.find())
|
||||
paramComments.put(matcher.group(1), matcher.group(2).trim());
|
||||
else this.logger.warn("A @param for the {} bean and {} method is improperly formatted", beanModel.getBeanId(), methodElement);
|
||||
case "throws":
|
||||
matcher = this.namedTagPattern.matcher(tag.toString());
|
||||
if (matcher.find())
|
||||
throwComments.put(matcher.group(1), matcher.group(2).trim());
|
||||
else this.logger.warn("A @throws for the {} bean and {} method is improperly formatted", beanModel.getBeanId(), methodElement);
|
||||
break;
|
||||
default:
|
||||
matcher = this.tagPattern.matcher(tag.toString());
|
||||
if (matcher.find())
|
||||
this.putAdd(sigModel.getTags(), tagName, matcher.group(1).trim());
|
||||
else this.logger.warn("A '@{}' tag for the {} bean and {} method is improperly formatted", tagName, beanModel.getBeanId(), methodElement);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
StringBuilder methodSignature = new StringBuilder(methodElement.getSimpleName()).append("(");
|
||||
|
||||
for (VariableElement varElement : methodElement.getParameters()) {
|
||||
this.logger.trace("Found parameter '{}' for method: {}.{}", varElement.getSimpleName(), beandoc.getBeanId(), methodElement);
|
||||
|
||||
ParamFreemarkerModel paramModel = new ParamFreemarkerModel();
|
||||
paramModel.setName(varElement.getSimpleName().toString());
|
||||
paramModel.setType(varElement.asType().toString());
|
||||
paramModel.setComment(paramComments.get(paramModel.getName()));
|
||||
|
||||
sigModel.getParams().put(paramModel.getName(), paramModel);
|
||||
methodSignature.append(varElement.getSimpleName()).append(": ").append(varElement.asType()).append(", ");
|
||||
}
|
||||
|
||||
for (TypeMirror thrownType : methodElement.getThrownTypes()) {
|
||||
this.logger.trace("Found thrown '{}' for method: {}.{}", thrownType, beandoc.getBeanId(), methodElement);
|
||||
|
||||
ThrowFreemarkerModel throwModel = new ThrowFreemarkerModel();
|
||||
throwModel.setType(thrownType.toString());
|
||||
throwModel.setComment(throwComments.get(throwModel.getType()));
|
||||
|
||||
sigModel.getThrowTypes().put(throwModel.getType(), throwModel);
|
||||
}
|
||||
|
||||
this.logger.trace("Found return '{}' for method: {}.{}", methodElement.getReturnType(), beandoc.getBeanId(), methodElement);
|
||||
if (!"void".equals(methodElement.getReturnType().toString()))
|
||||
sigModel.setReturnType(methodElement.getReturnType().toString());
|
||||
|
||||
if (methodSignature.charAt(methodSignature.length()-1) != '(')
|
||||
methodSignature.delete(methodSignature.length()-2, methodSignature.length());
|
||||
methodSignature.append("): ").append(methodElement.getReturnType());
|
||||
|
||||
this.logger.debug("Found method signature: {}", methodSignature);
|
||||
sigModel.setMethodSignature(methodSignature.toString());
|
||||
|
||||
methodModel.getSignatures().add(sigModel);
|
||||
}
|
||||
@ -179,256 +257,6 @@ class MarkdownWriter {
|
||||
return indexModel;
|
||||
}
|
||||
|
||||
private MethodSignatureFreemarkerModel buildMethodSignatureModel(ActivitiApiBeanDoc beandoc, ExecutableElement methodElement) {
|
||||
String logId = beandoc.getBeanId() + "." + methodElement.toString();
|
||||
DocCommentTree methodCommentTree = this.docenv.getDocTrees().getDocCommentTree(methodElement);
|
||||
|
||||
this.logger.debug("Building documentation method model: {}", logId);
|
||||
|
||||
Map<String, String> paramComments = new HashMap<>();
|
||||
Map<String, String> fieldComments = new LinkedHashMap<>();
|
||||
Map<String, String> varInComments = new LinkedHashMap<>();
|
||||
Map<String, String> varOutComments = new LinkedHashMap<>();
|
||||
Map<String, String> throwComments = new LinkedHashMap<>();
|
||||
Map<String, String> errorComments = new LinkedHashMap<>();
|
||||
|
||||
MethodSignatureFreemarkerModel sigModel = new MethodSignatureFreemarkerModel();
|
||||
if (methodCommentTree != null) {
|
||||
this.logger.debug("Found documentation for '{}'", logId);
|
||||
|
||||
this.buildDocumentation(methodCommentTree, sigModel);
|
||||
for (DocTree tag : methodCommentTree.getBlockTags()) {
|
||||
this.buildTagModel(tag, logId,
|
||||
paramComments, fieldComments, varInComments, varOutComments, throwComments, errorComments, sigModel);
|
||||
}
|
||||
}
|
||||
|
||||
this.buildMethodArguments(methodElement, logId, paramComments, sigModel);
|
||||
this.buildMethodFields(methodElement, logId, fieldComments, sigModel);
|
||||
this.buildMethodVariablesIn(methodElement, logId, varInComments, sigModel);
|
||||
this.buildMethodVariablesOut(methodElement, logId, varOutComments, sigModel);
|
||||
this.buildMethodThrows(methodElement, logId, throwComments, !errorComments.isEmpty(), sigModel);
|
||||
this.buildMethodErrors(methodElement, logId, errorComments, sigModel);
|
||||
this.buildMethodReturns(methodElement, logId, sigModel);
|
||||
this.buildMethodBriefSignature(methodElement, sigModel);
|
||||
this.buildMethodSignature(methodElement, sigModel);
|
||||
|
||||
if (!paramComments.isEmpty())
|
||||
this.logger.warn("'{}' has documented parameters {} that don't exist; ignoring ...", logId, paramComments.keySet());
|
||||
|
||||
return sigModel;
|
||||
}
|
||||
|
||||
private void buildDocumentation(DocCommentTree commentTree, JavadocDocumentable docuable) {
|
||||
if (commentTree.getFirstSentence() != null)
|
||||
docuable.setDocFirstSentence(this.sanitize(commentTree.getFirstSentence()));
|
||||
if (commentTree.getFullBody() != null && !commentTree.getFullBody().isEmpty())
|
||||
docuable.setDocBody(this.sanitize(commentTree.getFullBody()));
|
||||
}
|
||||
|
||||
private void buildTagModel(DocTree tag, String logId,
|
||||
Map<String, String> paramComments,
|
||||
Map<String, String> fieldComments,
|
||||
Map<String, String> varInComments,
|
||||
Map<String, String> varOutComments,
|
||||
Map<String, String> throwComments,
|
||||
Map<String, String> errorComments,
|
||||
JavadocTaggable sigModel) {
|
||||
Matcher matcher = this.tagPattern.matcher(tag.toString());
|
||||
if (!matcher.find()) {
|
||||
this.logger.warn("A tag for '{}' is improperly formatted", logId);
|
||||
return;
|
||||
}
|
||||
|
||||
String tagName = matcher.group(1);
|
||||
String tagComment = matcher.group(2).trim();
|
||||
|
||||
this.logger.trace("Found tag '{}' for '{}'", tagName, logId);
|
||||
|
||||
switch (tagName) {
|
||||
case "param":
|
||||
if (paramComments == null)
|
||||
break;
|
||||
|
||||
matcher = this.namedCommentPattern.matcher(tagComment);
|
||||
if (matcher.find())
|
||||
paramComments.put(matcher.group(1), this.sanitize(matcher.group(2).trim()));
|
||||
else this.logger.warn("A @param for the {} bean and {} method is improperly formatted", logId);
|
||||
return;
|
||||
case "field":
|
||||
if (fieldComments == null)
|
||||
break;
|
||||
|
||||
matcher = this.namedCommentPattern.matcher(tagComment);
|
||||
if (matcher.find())
|
||||
fieldComments.put(matcher.group(1), this.sanitize(matcher.group(2).trim()));
|
||||
else this.logger.warn("A @field for the {} bean and {} method is improperly formatted", logId);
|
||||
return;
|
||||
case "varIn":
|
||||
if (varInComments == null)
|
||||
break;
|
||||
|
||||
matcher = this.namedCommentPattern.matcher(tagComment);
|
||||
if (matcher.find())
|
||||
varInComments.put(matcher.group(1), this.sanitize(matcher.group(2).trim()));
|
||||
else this.logger.warn("A @varIn for the {} bean and {} method is improperly formatted", logId);
|
||||
return;
|
||||
case "varOut":
|
||||
if (varOutComments == null)
|
||||
break;
|
||||
|
||||
matcher = this.namedCommentPattern.matcher(tagComment);
|
||||
if (matcher.find())
|
||||
varOutComments.put(matcher.group(1), this.sanitize(matcher.group(2).trim()));
|
||||
else this.logger.warn("A @varOut for the {} bean and {} method is improperly formatted", logId);
|
||||
return;
|
||||
case "throws":
|
||||
if (throwComments == null)
|
||||
break;
|
||||
|
||||
matcher = this.namedCommentPattern.matcher(tagComment);
|
||||
if (matcher.find()) {
|
||||
if (this.bpmnErrorSet.contains(matcher.group(1).toLowerCase())) {
|
||||
Matcher ecmatcher = this.namedCommentPattern.matcher(matcher.group(2).trim());
|
||||
if (ecmatcher.find()) {
|
||||
errorComments.put(ecmatcher.group(1), this.sanitize(ecmatcher.group(2).trim()));
|
||||
} else {
|
||||
this.logger.warn("A @throws for the {} bean and {} method is improperly formatted", logId);
|
||||
}
|
||||
} else {
|
||||
throwComments.put(matcher.group(1), this.sanitize(matcher.group(2).trim()));
|
||||
}
|
||||
}
|
||||
else this.logger.warn("A @throws for the {} bean and {} method is improperly formatted", logId);
|
||||
return;
|
||||
case "see":
|
||||
matcher = this.seeRefPattern.matcher(tagComment);
|
||||
if (matcher.find()) {
|
||||
ReferenceFreemarkerModel model = new ReferenceFreemarkerModel();
|
||||
model.setBeanId(matcher.group(1));
|
||||
model.setMethodName(matcher.group(2));
|
||||
sigModel.getSeeRefs().add(model);
|
||||
return;
|
||||
}
|
||||
default:
|
||||
}
|
||||
|
||||
this.putAdd(sigModel.getTags(), tagName, this.sanitize(tagComment));
|
||||
}
|
||||
|
||||
private void buildMethodArguments(ExecutableElement methodElement, String logId,
|
||||
Map<String, String> paramComments, MethodSignatureFreemarkerModel sigModel) {
|
||||
for (VariableElement varElement : methodElement.getParameters()) {
|
||||
this.logger.trace("Found parameter '{}' for '{}'", varElement.getSimpleName(), logId);
|
||||
|
||||
ParamFreemarkerModel paramModel = new ParamFreemarkerModel();
|
||||
paramModel.setName(varElement.getSimpleName().toString());
|
||||
paramModel.setType(varElement.asType().toString());
|
||||
if (paramComments != null)
|
||||
paramModel.setComment(paramComments.remove(paramModel.getName()));
|
||||
|
||||
sigModel.getParams().put(paramModel.getName(), paramModel);
|
||||
}
|
||||
}
|
||||
|
||||
private void buildMethodFields(ExecutableElement methodElement, String logId,
|
||||
Map<String, String> fieldComments, MethodSignatureFreemarkerModel sigModel) {
|
||||
for (Entry<String, String> fieldComment : fieldComments.entrySet()) {
|
||||
this.logger.trace("Found BPMN field '{}' for '{}'", fieldComment.getKey(), logId);
|
||||
|
||||
FieldFreemarkerModel fieldModel = new FieldFreemarkerModel();
|
||||
fieldModel.setName(fieldComment.getKey());
|
||||
fieldModel.setComment(fieldComment.getValue());
|
||||
|
||||
sigModel.getBpmnFields().put(fieldModel.getName(), fieldModel);
|
||||
}
|
||||
}
|
||||
|
||||
private void buildMethodVariablesIn(ExecutableElement methodElement, String logId,
|
||||
Map<String, String> varComments, MethodSignatureFreemarkerModel sigModel) {
|
||||
for (Entry<String, String> varComment : varComments.entrySet()) {
|
||||
this.logger.trace("Found input variable '{}' for '{}'", varComment.getKey(), logId);
|
||||
|
||||
VarFreemarkerModel varModel = new VarFreemarkerModel();
|
||||
varModel.setName(varComment.getKey());
|
||||
varModel.setComment(varComment.getValue());
|
||||
|
||||
sigModel.getVariablesIn().put(varModel.getName(), varModel);
|
||||
}
|
||||
}
|
||||
|
||||
private void buildMethodVariablesOut(ExecutableElement methodElement, String logId,
|
||||
Map<String, String> varComments, MethodSignatureFreemarkerModel sigModel) {
|
||||
for (Entry<String, String> varComment : varComments.entrySet()) {
|
||||
this.logger.trace("Found output variable '{}' for '{}'", varComment.getKey(), logId);
|
||||
|
||||
VarFreemarkerModel varModel = new VarFreemarkerModel();
|
||||
varModel.setName(varComment.getKey());
|
||||
varModel.setComment(varComment.getValue());
|
||||
|
||||
sigModel.getVariablesOut().put(varModel.getName(), varModel);
|
||||
}
|
||||
}
|
||||
|
||||
private void buildMethodThrows(ExecutableElement methodElement, String logId,
|
||||
Map<String, String> throwComments, boolean hasBpmnErrorComments, MethodSignatureFreemarkerModel sigModel) {
|
||||
for (TypeMirror thrownType : methodElement.getThrownTypes()) {
|
||||
this.logger.trace("Found thrown '{}' for '{}'", thrownType, logId);
|
||||
|
||||
if (hasBpmnErrorComments && this.bpmnErrorSet.contains(thrownType.toString().toLowerCase()))
|
||||
continue;
|
||||
|
||||
ThrowFreemarkerModel throwModel = new ThrowFreemarkerModel();
|
||||
throwModel.setType(thrownType.toString());
|
||||
throwModel.setComment(throwComments.remove(throwModel.getType()));
|
||||
|
||||
sigModel.getThrowTypes().put(throwModel.getType(), throwModel);
|
||||
}
|
||||
}
|
||||
|
||||
private void buildMethodErrors(ExecutableElement methodElement, String logId,
|
||||
Map<String, String> errorComments, MethodSignatureFreemarkerModel sigModel) {
|
||||
for (Entry<String, String> errorComment : errorComments.entrySet()) {
|
||||
this.logger.trace("Found BPMN error thrown code '{}' for '{}'", errorComment.getKey(), logId);
|
||||
|
||||
ThrowFreemarkerModel errorModel = new ThrowFreemarkerModel();
|
||||
errorModel.setType(errorComment.getKey());
|
||||
errorModel.setComment(errorComment.getValue());
|
||||
|
||||
sigModel.getBpmnErrors().put(errorModel.getType(), errorModel);
|
||||
}
|
||||
}
|
||||
|
||||
private void buildMethodReturns(ExecutableElement methodElement, String logId, MethodSignatureFreemarkerModel sigModel) {
|
||||
this.logger.trace("Found return '{}' for '{}'", methodElement.getReturnType(), logId);
|
||||
if (!"void".equals(methodElement.getReturnType().toString()))
|
||||
sigModel.setReturnType(methodElement.getReturnType().toString());
|
||||
}
|
||||
|
||||
private void buildMethodBriefSignature(ExecutableElement methodElement, MethodSignatureFreemarkerModel sigModel) {
|
||||
StringBuilder methodSignature = new StringBuilder(methodElement.getSimpleName()).append("(");
|
||||
for (ParamFreemarkerModel model : sigModel.getParams().values())
|
||||
methodSignature.append(model.getName()).append(", ");
|
||||
if (methodSignature.charAt(methodSignature.length()-1) != '(')
|
||||
methodSignature.delete(methodSignature.length()-2, methodSignature.length());
|
||||
methodSignature.append(")");
|
||||
|
||||
this.logger.debug("Formulated method brief signature: {}", methodSignature);
|
||||
sigModel.setMethodSignature(methodSignature.toString());
|
||||
}
|
||||
|
||||
private void buildMethodSignature(ExecutableElement methodElement, MethodSignatureFreemarkerModel sigModel) {
|
||||
StringBuilder methodSignature = new StringBuilder(methodElement.getSimpleName()).append("(");
|
||||
for (ParamFreemarkerModel model : sigModel.getParams().values())
|
||||
methodSignature.append(model.getName()).append(": ").append(model.getType()).append(", ");
|
||||
if (methodSignature.charAt(methodSignature.length()-1) != '(')
|
||||
methodSignature.delete(methodSignature.length()-2, methodSignature.length());
|
||||
methodSignature.append("): ").append(methodElement.getReturnType());
|
||||
|
||||
this.logger.debug("Formulated method signature: {}", methodSignature);
|
||||
sigModel.setMethodSignature(methodSignature.toString());
|
||||
}
|
||||
|
||||
private void writeIndexFile(IndexFreemarkerModel model) throws IOException, TemplateException {
|
||||
File mdfile = new File(this.outputDirectory, "index.md");
|
||||
PrintWriter mdwriter = new PrintWriter(mdfile, Charset.forName("utf-8"));
|
||||
@ -451,14 +279,18 @@ class MarkdownWriter {
|
||||
}
|
||||
}
|
||||
|
||||
private String sanitize(List<? extends DocTree> docs) {
|
||||
return this.sanitize(docs.toString());
|
||||
}
|
||||
|
||||
private String sanitize(String str) {
|
||||
for (Entry<Pattern, String> sanitize : this.sanitizations.entrySet())
|
||||
str = sanitize.getKey().matcher(str).replaceAll(sanitize.getValue());
|
||||
return str;
|
||||
private String formatBookmark(String title) {
|
||||
if (this.flavor == null || title == null)
|
||||
return null;
|
||||
|
||||
switch (this.flavor.toLowerCase()) {
|
||||
case "github":
|
||||
return title.toLowerCase().replaceAll(" ", "-");
|
||||
case "bitbucket":
|
||||
return "markdown-header-" + title.toLowerCase().replaceAll(" ", "-");
|
||||
default:
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
private <T> T putAdd(Map<String, List<T>> map, String key, T value) {
|
||||
|
||||
@ -24,6 +24,8 @@ public class MethodFreemarkerModel {
|
||||
|
||||
private String methodName;
|
||||
|
||||
private String bookmark;
|
||||
|
||||
private String docFirstSentence;
|
||||
|
||||
private List<MethodSignatureFreemarkerModel> signatures = new LinkedList<>();
|
||||
@ -36,6 +38,14 @@ public class MethodFreemarkerModel {
|
||||
this.methodName = methodName;
|
||||
}
|
||||
|
||||
public String getBookmark() {
|
||||
return bookmark;
|
||||
}
|
||||
|
||||
public void setBookmark(String bookmark) {
|
||||
this.bookmark = bookmark;
|
||||
}
|
||||
|
||||
public String getDocFirstSentence() {
|
||||
return docFirstSentence;
|
||||
}
|
||||
|
||||
@ -15,36 +15,25 @@
|
||||
package com.inteligr8.activiti.doclet;
|
||||
|
||||
import java.util.LinkedHashMap;
|
||||
import java.util.LinkedList;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
|
||||
public class MethodSignatureFreemarkerModel implements JavadocDocumentable, JavadocTaggable {
|
||||
public class MethodSignatureFreemarkerModel {
|
||||
|
||||
private String methodSignature;
|
||||
|
||||
private Map<String, ParamFreemarkerModel> params = new LinkedHashMap<>();
|
||||
|
||||
private Map<String, FieldFreemarkerModel> bpmnFields = new LinkedHashMap<>();
|
||||
|
||||
private Map<String, VarFreemarkerModel> variablesIn = new LinkedHashMap<>();
|
||||
|
||||
private Map<String, VarFreemarkerModel> variablesOut = new LinkedHashMap<>();
|
||||
|
||||
private String returnType;
|
||||
|
||||
private Map<String, ThrowFreemarkerModel> throwTypes = new LinkedHashMap<>();
|
||||
|
||||
private Map<String, ThrowFreemarkerModel> bpmnErrors = new LinkedHashMap<>();
|
||||
|
||||
private String docFirstSentence;
|
||||
|
||||
private String docBody;
|
||||
|
||||
private Map<String, List<String>> tags = new LinkedHashMap<>();
|
||||
|
||||
private List<ReferenceFreemarkerModel> seeRefs = new LinkedList<>();
|
||||
|
||||
public String getMethodSignature() {
|
||||
return methodSignature;
|
||||
}
|
||||
@ -60,30 +49,6 @@ public class MethodSignatureFreemarkerModel implements JavadocDocumentable, Java
|
||||
public void setParams(Map<String, ParamFreemarkerModel> params) {
|
||||
this.params = params;
|
||||
}
|
||||
|
||||
public Map<String, FieldFreemarkerModel> getBpmnFields() {
|
||||
return bpmnFields;
|
||||
}
|
||||
|
||||
public void setBpmnFields(Map<String, FieldFreemarkerModel> fields) {
|
||||
this.bpmnFields = fields;
|
||||
}
|
||||
|
||||
public Map<String, VarFreemarkerModel> getVariablesIn() {
|
||||
return variablesIn;
|
||||
}
|
||||
|
||||
public void setVariablesIn(Map<String, VarFreemarkerModel> variablesIn) {
|
||||
this.variablesIn = variablesIn;
|
||||
}
|
||||
|
||||
public Map<String, VarFreemarkerModel> getVariablesOut() {
|
||||
return variablesOut;
|
||||
}
|
||||
|
||||
public void setVariablesOut(Map<String, VarFreemarkerModel> variablesOut) {
|
||||
this.variablesOut = variablesOut;
|
||||
}
|
||||
|
||||
public String getReturnType() {
|
||||
return returnType;
|
||||
@ -100,14 +65,6 @@ public class MethodSignatureFreemarkerModel implements JavadocDocumentable, Java
|
||||
public void setThrowTypes(Map<String, ThrowFreemarkerModel> throwTypes) {
|
||||
this.throwTypes = throwTypes;
|
||||
}
|
||||
|
||||
public Map<String, ThrowFreemarkerModel> getBpmnErrors() {
|
||||
return bpmnErrors;
|
||||
}
|
||||
|
||||
public void setBpmnErrors(Map<String, ThrowFreemarkerModel> bpmnErrors) {
|
||||
this.bpmnErrors = bpmnErrors;
|
||||
}
|
||||
|
||||
public String getDocFirstSentence() {
|
||||
return docFirstSentence;
|
||||
@ -132,13 +89,5 @@ public class MethodSignatureFreemarkerModel implements JavadocDocumentable, Java
|
||||
public void setTags(Map<String, List<String>> tags) {
|
||||
this.tags = tags;
|
||||
}
|
||||
|
||||
public List<ReferenceFreemarkerModel> getSeeRefs() {
|
||||
return seeRefs;
|
||||
}
|
||||
|
||||
public void setSeeRefs(List<ReferenceFreemarkerModel> seeRefs) {
|
||||
this.seeRefs = seeRefs;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
@ -1,42 +0,0 @@
|
||||
/*
|
||||
* This program is free software: you can redistribute it and/or modify it
|
||||
* under the terms of the GNU Lesser General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or (at your
|
||||
* option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful, but WITHOUT
|
||||
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
||||
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
|
||||
* more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License along
|
||||
* with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/
|
||||
package com.inteligr8.activiti.doclet;
|
||||
|
||||
/**
|
||||
* @author brian@inteligr8.com
|
||||
*/
|
||||
public class ReferenceFreemarkerModel {
|
||||
|
||||
private String beanId;
|
||||
|
||||
private String methodName;
|
||||
|
||||
public String getBeanId() {
|
||||
return beanId;
|
||||
}
|
||||
|
||||
public void setBeanId(String beanId) {
|
||||
this.beanId = beanId;
|
||||
}
|
||||
|
||||
public String getMethodName() {
|
||||
return methodName;
|
||||
}
|
||||
|
||||
public void setMethodName(String methodName) {
|
||||
this.methodName = methodName;
|
||||
}
|
||||
|
||||
}
|
||||
@ -1,42 +0,0 @@
|
||||
/*
|
||||
* This program is free software: you can redistribute it and/or modify it
|
||||
* under the terms of the GNU Lesser General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or (at your
|
||||
* option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful, but WITHOUT
|
||||
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
||||
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
|
||||
* more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License along
|
||||
* with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/
|
||||
package com.inteligr8.activiti.doclet;
|
||||
|
||||
/**
|
||||
* @author brian@inteligr8.com
|
||||
*/
|
||||
public class VarFreemarkerModel {
|
||||
|
||||
private String name;
|
||||
|
||||
private String comment;
|
||||
|
||||
public String getName() {
|
||||
return name;
|
||||
}
|
||||
|
||||
public void setName(String name) {
|
||||
this.name = name;
|
||||
}
|
||||
|
||||
public String getComment() {
|
||||
return comment;
|
||||
}
|
||||
|
||||
public void setComment(String comment) {
|
||||
this.comment = comment;
|
||||
}
|
||||
|
||||
}
|
||||
@ -1,127 +1,86 @@
|
||||
# ${title}<#if apiName??>: ${apiName}</#if>: `${beanId}`
|
||||
<#if (tags.author?? || tags.since?? || tags.version?? || tags.deprecated??)>
|
||||
|
||||
<#if tags.author??><#list tags.author as author>*Author*: ${author}</#list>
|
||||
</#if><#if tags.since??>*Since Version*: ${tags.since[0]}
|
||||
</#if><#if tags.version??>*Version*: ${tags.version[0]}
|
||||
</#if><#if tags.deprecated??>*Deprecated*</#if></#if>
|
||||
# ${title}<#if apiName??>: ${apiName}</#if>: `${beanId}`
|
||||
|
||||
<#if docBody??>${docBody}<#else>No documentation available.</#if>
|
||||
<#if (tags.see?? || seeRefs?size > 0)>
|
||||
|
||||
<#list seeRefs as seeRef><#if seeRef.methodName == "">
|
||||
*See Also*: [`${seeRef.beanId}`](bean-${seeRef.beanId}.md)
|
||||
<#elseif seeRef.methodName == "delegate">
|
||||
*See Also*: [`${seeRef.beanId}`](bean-${seeRef.beanId}.md#${seeRef.methodName})
|
||||
<#else>
|
||||
*See Also*: [`${seeRef.beanId}.${seeRef.methodName}`](bean-${seeRef.beanId}.md#${seeRef.methodName})
|
||||
</#if></#list><#if tags.see??><#list tags.see as see>
|
||||
<#if (tags.author?? || tags.since?? || tags.see?? || tags.deprecated??)>
|
||||
<#if tags.author??><#list tags.author as author>
|
||||
*Author*: ${author}
|
||||
</#list></#if>
|
||||
<#if tags.since??>*Since*: ${tags.since[0]}</#if>
|
||||
<#if tags.see??><#list tags.see as see>
|
||||
*See Also*: ${see}
|
||||
</#list></#if></#if>
|
||||
<#if hasDelegate>
|
||||
</#list></#if>
|
||||
<#if tags.deprecated??>*Deprecated*</#if>
|
||||
|
||||
## <a name="delegate"></a> Delegate Expression Uses
|
||||
</#if><#if (delegateRoles?size > 0)>
|
||||
## Delegate Uses
|
||||
|
||||
This bean may be used as a *Delegate* using the "Delegate Expression" field as shown in the snippet below.
|
||||
This bean may be used in the following entities and their fields in Activiti. In these cases, the value of the "Delegate Expression" field should be as shown in the snippet below.
|
||||
|
||||
```javascript
|
||||
${r"${"}${beanId}${r"}"}
|
||||
```
|
||||
|
||||
<#if delegateMethod?? || executionListenerMethod?? || taskListenerMethod??>
|
||||
<#assign taskUses = [] />
|
||||
<#if delegateMethod??><#assign taskUses = taskUses + ["**Service Task**"] /><#assign _delegateMethod = delegateMethod /></#if>
|
||||
<#if executionListenerMethod??><#assign taskUses = taskUses + ["**Execution Listener**"] /><#assign _delegateMethod = executionListenerMethod /></#if>
|
||||
<#if taskListenerMethod??><#assign taskUses = taskUses + ["**Task Listener**"] /><#assign _delegateMethod = taskListenerMethod /></#if>
|
||||
You may use it in a ${taskUses?join(" or ")}.
|
||||
<@sigdoc sig=_delegateMethod showParams=false/>
|
||||
</#if></#if><#if (methods?size > 0)>
|
||||
<#if delegateRoles?seq_contains("ServiceTask") >
|
||||
- Any **Non-Listener Delegate Expression** (usually a Service Task)
|
||||
</#if><#if delegateRoles?seq_contains("ExecutionListener") >
|
||||
- Any **Execution Listener Delegate Expression**
|
||||
</#if><#if delegateRoles?seq_contains("TaskListener") >
|
||||
- Any **Task Listener Delegate Expression**
|
||||
</#if>
|
||||
|
||||
## Expression Uses
|
||||
</#if>
|
||||
## Expression Methods
|
||||
|
||||
This bean and its methods may be used in any "Expression" field or script in a Script Task in Activiti.
|
||||
|
||||
| Method Name | Brief Documentation |
|
||||
| -------------------------------- | ------------------------ |
|
||||
<#list methods as method><#assign nameColumn = "[`${method.methodName}`](#${method.methodName})">
|
||||
| Method Name | Brief Documentation |
|
||||
| --------------------------------- | ------------------------ |
|
||||
<#list methods as method>
|
||||
<#assign nameColumn = "[`${method.methodName}`](#${method.bookmark})">
|
||||
| ${nameColumn?right_pad(32)} | <#if method.docFirstSentence??>${method.docFirstSentence?right_pad(24)}<#else>No documentation available.</#if> |
|
||||
</#list>
|
||||
|
||||
<#list methods as method>
|
||||
### <a name="${method.methodName}"></a> `${method.methodName}`
|
||||
### `${method.methodName}`
|
||||
|
||||
<#list method.signatures as sig>
|
||||
**`${beanId}.${sig.methodSignature}`**
|
||||
<@sigdoc sig=sig showParams=true/>
|
||||
</#list></#list></#if>
|
||||
|
||||
---
|
||||
|
||||
[Back to Index](index.md)
|
||||
|
||||
Generated by the [Inteligr8](https://inteligr8.com) [Activiti API Doclet](https://bitbucket.org/inteligr8/activiti-api-doclet).
|
||||
|
||||
<#macro sigdoc sig showParams>
|
||||
<#if (sig.tags.author?? || sig.tags.since?? || sig.tags.version?? || sig.tags.deprecated??)>
|
||||
|
||||
<#if sig.tags.author??><#list sig.tags.author as author>*Author*: ${author}</#list>
|
||||
</#if><#if sig.tags.since??>*Since Version*: ${sig.tags.since[0]}
|
||||
</#if><#if sig.tags.version??>*Version*: ${sig.tags.version[0]}
|
||||
</#if><#if sig.tags.deprecated??>*Deprecated*</#if></#if>
|
||||
|
||||
<#if sig.docBody??>${sig.docBody}<#else>No documentation available.</#if>
|
||||
<#if ((showParams && sig.params?size > 0) || sig.bpmnFields?size > 0 || sig.variablesIn?size > 0)>
|
||||
|
||||
| Input Type | Name | Java Type | Documentation |
|
||||
| ------------------------ | ------------------------ | ------------------------------------------------ | ---------------------------------- |
|
||||
<#if showParams><#list sig.params as paramName, param>
|
||||
| Method Parameter | ${("`" + paramName + "`")?right_pad(24)} | ${("`" + param.type + "`")?right_pad(48)} | <#if (param.comment?? && param.comment?length > 0)>${param.comment?right_pad(32)}<#else>No documentation available.</#if> |
|
||||
</#list></#if>
|
||||
<#if (sig.bpmnFields?size > 0)>
|
||||
<#list sig.bpmnFields as fieldName, field>
|
||||
| BPMN Field | ${("`" + fieldName + "`")?right_pad(24)} | ${("")?right_pad(48)} | <#if (field.comment?? && field.comment?length > 0)>${field.comment?right_pad(32)}<#else>No documentation available.</#if> |
|
||||
<#if (sig.params?size > 0)>
|
||||
| Parameter Name | Java Type | Documentation |
|
||||
| ------------------------ | ------------------------------------------------ | ------------------------ |
|
||||
<#list sig.params as paramName, param>
|
||||
| ${("`" + paramName + "`")?right_pad(24)} | ${("`" + param.type + "`")?right_pad(48)} | <#if param.comment??>${param.comment?right_pad(24)}<#else>No documentation available.</#if> |
|
||||
</#list>
|
||||
</#if>
|
||||
<#if (sig.variablesIn?size > 0)>
|
||||
<#list sig.variablesIn as varName, var>
|
||||
| Activiti Variable | ${("`" + varName + "`")?right_pad(24)} | ${("")?right_pad(48)} | <#if (var.comment?? && var.comment?length > 0)>${var.comment?right_pad(32)}<#else>No documentation available.</#if> |
|
||||
</#list>
|
||||
</#if>
|
||||
</#if>
|
||||
<#if (sig.returnType?? || sig.variablesOut?size > 0 || sig.throwTypes?size > 0)>
|
||||
|
||||
| Result Type | Java Type, Name, or Error Code | Documentation |
|
||||
| ------------------------ | ------------------------------------------------ | -------------------------------- |
|
||||
</#if>
|
||||
<#if (sig.returnType?? || sig.throwTypes?size > 0)>
|
||||
| Result Type | Java Type | Documentation |
|
||||
| ------------------------ | ------------------------------------------------ | ------------------------ |
|
||||
<#if sig.returnType??>
|
||||
| Return Value | ${("`" + sig.returnType + "`")?right_pad(48)} | <#if (sig.tags.return?? && sig.tags.return[0]?length > 0)>${sig.tags.return[0]?right_pad(32)}<#else>No documentation available.</#if> |
|
||||
</#if>
|
||||
<#if (sig.variablesOut?size > 0)>
|
||||
<#list sig.variablesOut as varName, var>
|
||||
| Activiti Variable | ${("`" + varName + "`")?right_pad(48)} | <#if (var.comment?? && var.comment?length > 0)>${var.comment?right_pad(32)}<#else>No documentation available.</#if> |
|
||||
</#list>
|
||||
| Return Value | ${("`" + sig.returnType + "`")?right_pad(48)} | <#if sig.tags.return??>${sig.tags.return[0]?right_pad(24)}<#else>No documentation available.</#if> |
|
||||
</#if>
|
||||
<#if (sig.throwTypes?size > 0)>
|
||||
<#list sig.throwTypes as throwType, throw>
|
||||
| Thrown Exception | ${("`" + throwType + "`")?right_pad(48)} | <#if (throw.comment?? && throw.comment?length > 0)>${throw.comment?right_pad(32)}<#else>No documentation available.</#if> |
|
||||
| Thrown Exception | ${("`" + throwType + "`")?right_pad(48)} | <#if throw.comment??>${throw.comment?right_pad(24)}<#else>No documentation available.</#if> |
|
||||
</#list>
|
||||
</#if>
|
||||
<#if (sig.bpmnErrors?size > 0)>
|
||||
<#list sig.bpmnErrors as errorCode, bpmnError>
|
||||
| Thrown BPMN Error | ${("`" + errorCode + "`")?right_pad(48)} | <#if (bpmnError.comment?? && bpmnError.comment?length > 0)>${bpmnError.comment?right_pad(32)}<#else>No documentation available.</#if> |
|
||||
</#list>
|
||||
</#if>
|
||||
</#if>
|
||||
<#if (sig.tags.see?? || sig.seeRefs?size > 0)>
|
||||
|
||||
<#list sig.seeRefs as seeRef><#if seeRef.methodName == "">
|
||||
*See Also*: [`${seeRef.beanId}`](bean-${seeRef.beanId}.md)
|
||||
<#elseif seeRef.methodName == "delegate">
|
||||
*See Also*: [`${seeRef.beanId}`](bean-${seeRef.beanId}.md#${seeRef.methodName})
|
||||
<#else>
|
||||
*See Also*: [`${seeRef.beanId}.${seeRef.methodName}`](bean-${seeRef.beanId}.md#${seeRef.methodName})
|
||||
</#if></#list><#if sig.tags.see??><#list sig.tags.see as see>
|
||||
</#if>
|
||||
<#if (sig.tags.author?? || sig.tags.since?? || sig.tags.see?? || sig.tags.deprecated??)>
|
||||
<#if sig.tags.author??><#list sig.tags.author as author>
|
||||
*Author*: ${author}
|
||||
</#list></#if>
|
||||
<#if sig.tags.since??>*Since*: ${sig.tags.since[0]}</#if>
|
||||
<#if sig.tags.see??><#list sig.tags.see as see>
|
||||
*See Also*: ${see}
|
||||
</#list></#if>
|
||||
<#if sig.tags.deprecated??>*Deprecated*</#if>
|
||||
|
||||
</#if>
|
||||
</#list>
|
||||
</#list>
|
||||
</#if>
|
||||
</#if>
|
||||
</#macro>
|
||||
@ -17,28 +17,11 @@ Activiti has a set of features that allow a model designer to call these Java-ba
|
||||
|
||||
It is important to note that Activiti expressions use the JUEL language and Activiti scripts use the specified/configured language. Popular configured languages may be JavaScript or Groovy. In any case, the same API notation may be used. It is also worth noting that execution/task listeners may exist on most objects.
|
||||
|
||||
<#if hasDelegateBeans>
|
||||
## Delegates
|
||||
|
||||
| Delegate ID | Brief Documentation |
|
||||
| -------------------------------- | ------------------------- |
|
||||
<#list beans as bean><#if bean.hasDelegate>
|
||||
<#assign idColumn = "[`${bean.beanId}`](bean-${bean.beanId}.md)">
|
||||
| ${idColumn?right_pad(32)} | <#if bean.docFirstSentence??>${bean.docFirstSentence?right_pad(24)}<#else>No documentation available.</#if> |
|
||||
</#if></#list>
|
||||
|
||||
</#if>
|
||||
<#if hasMethodBeans>
|
||||
## Beans
|
||||
|
||||
| Bean ID | Brief Documentation |
|
||||
| -------------------------------- | ------------------------- |
|
||||
<#list beans as bean><#if (bean.methods?size > 0)>
|
||||
<#list beans as bean>
|
||||
<#assign idColumn = "[`${bean.beanId}`](bean-${bean.beanId}.md)">
|
||||
| ${idColumn?right_pad(32)} | <#if bean.docFirstSentence??>${bean.docFirstSentence?right_pad(24)}<#else>No documentation available.</#if> |
|
||||
</#if></#list>
|
||||
|
||||
</#if>
|
||||
---
|
||||
|
||||
Generated by the [Inteligr8](https://inteligr8.com) [Activiti API Doclet](https://bitbucket.org/inteligr8/activiti-api-doclet).
|
||||
</#list>
|
||||
Loading…
x
Reference in New Issue
Block a user