Commit a97ca48f authored by Brian Long's avatar Brian Long
Browse files

Merge branch 'develop' into stable

parents 60a8b678 20c8adbf

README.md

+4 −4
Original line number Diff line number Diff line
@@ -21,12 +21,12 @@ This library provides a Javadoc Doclet for the generation of Activiti API docume 
							<docletArtifact>

								<groupId>com.inteligr8.activiti</groupId>

								<artifactId>activiti-api-doclet</artifactId>

								<version>1.0.0</version>

								<version>1.0.1</version>

							</docletArtifact>

							<useStandardDocletOptions>false</useStandardDocletOptions>

							<destDir>destDir</destDir>

							<destDir>apidocs</destDir>

							<reportOutputDirectory>${basedir}</reportOutputDirectory>

							<additionalOptions>

								<additionalOption>-d d</additionalOption>

								<additionalOption>--flavor bitbucket</additionalOption>

								<additionalOption>--title 'API Documentation'</additionalOption>

								<additionalOption>--apiName '${project.name}</additionalOption>
@@ -46,4 +46,4 @@ 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.
 
The documentation will be placed in `<reportOutputDirectory>/<destDir>`.

src/it/base/pom.xml

+4 −2
Original line number Diff line number Diff line
@@ -50,10 +50,12 @@ 
								<version>@pom.version@</version>

							</docletArtifact>

							<useStandardDocletOptions>false</useStandardDocletOptions>

							<destDir>destDir</destDir>

							<destDir>apidocs</destDir>

							<reportOutputDirectory>${basedir}</reportOutputDirectory>

							<additionalOptions>

								<additionalOption>-d d</additionalOption>

								<additionalOption>--flavor bitbucket</additionalOption>

								<additionalOption>--title 'Example Title'</additionalOption>

								<additionalOption>--apiName '${project.name}'</additionalOption>

							</additionalOptions>

						</configuration>

					</execution>

src/it/base/src/main/java/TestNamedBean.java

+6 −0
Original line number Diff line number Diff line
@@ -7,6 +7,8 @@ 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

 */
@@ -81,6 +83,10 @@ 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.bean`

	 * @see http://inteligr8.com

	 */

	public String apiMethod8(String param) throws Exception {

		return null;

src/main/java/com/inteligr8/activiti/doclet/ActivitiApiBeanDoc.java

+5 −2
Original line number Diff line number Diff line
@@ -54,9 +54,12 @@ class ActivitiApiBeanDoc { 
		return this;

	}

	

	public List<ExecutableElement> getMethodElements() {

		return new ArrayList<>(this.methodElements.values());

	}

	

	public List<ExecutableElement> getSortedMethodElements() {

		List<ExecutableElement> methodElements = new ArrayList<>(this.methodElements.size());

		methodElements.addAll(this.methodElements.values());

		List<ExecutableElement> methodElements = this.getMethodElements();

		Collections.sort(methodElements, new Comparator<ExecutableElement>() {

			@Override

			public int compare(ExecutableElement methodElement1, ExecutableElement methodElement2) {

src/main/java/com/inteligr8/activiti/doclet/ActivitiDocFilter.java

+0 −1
Original line number Diff line number Diff line
@@ -91,7 +91,6 @@ class ActivitiDocFilter { 


		// getAllTypeElements() will get inherited interfaces

		for (TypeMirror interfaceType : classElement.getInterfaces()) {

			this.logger.info("{} contains {}", beanId, interfaceType);

			this.logger.trace("Found interface '{}' on bean '{}'", interfaceType, beanId);

			

			switch (interfaceType.toString()) {