Commit 0d4d6884 authored by Brian Long's avatar Brian Long
Browse files

@see improvements, bookmarking, and other fixes

parent 20c8adbf

README.md

+1 −2
Original line number Diff line number Diff line
@@ -21,13 +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.1</version>

								<version>1.0.3</version>

							</docletArtifact>

							<useStandardDocletOptions>false</useStandardDocletOptions>

							<destDir>apidocs</destDir>

							<reportOutputDirectory>${basedir}</reportOutputDirectory>

							<additionalOptions>

								<additionalOption>--flavor bitbucket</additionalOption>

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

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

							</additionalOptions>

src/it/base/pom.xml

+0 −1
Original line number Diff line number Diff line
@@ -53,7 +53,6 @@ 
							<destDir>apidocs</destDir>

							<reportOutputDirectory>${basedir}</reportOutputDirectory>

							<additionalOptions>

								<additionalOption>--flavor bitbucket</additionalOption>

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

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

							</additionalOptions>

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

+3 −1
Original line number Diff line number Diff line
@@ -85,7 +85,9 @@ public class TestNamedBean { 
	 * @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 test-sub.apiMethod10

	 * @see {@link http://inteligr8.com}

	 * @see [Inteligr8](http://inteligr8.com)

	 * @see http://inteligr8.com

	 */

	public String apiMethod8(String param) throws Exception {

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

+0 −14
Original line number Diff line number Diff line
@@ -45,7 +45,6 @@ public class ActivitiDoclet implements Doclet { 
	

	private final Logger logger = LoggerFactory.getLogger(this.getClass());

	

	private String flavor;

	private String title;

	private String apiName;
@@ -57,17 +56,6 @@ 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) {
@@ -120,8 +108,6 @@ 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) {

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

+12 −11
Original line number Diff line number Diff line
@@ -24,7 +24,7 @@ import java.util.Set; 
/**

 * @author brian@inteligr8.com

 */

public class BeanFreemarkerModel {

public class BeanFreemarkerModel implements JavadocDocumentable, JavadocTaggable {

	

	private String title;
@@ -32,8 +32,6 @@ public class BeanFreemarkerModel { 
	

	private String beanId;

	

	private String bookmark;

	

	private String docFirstSentence;



	private String docBody;
@@ -42,6 +40,8 @@ public class BeanFreemarkerModel { 


	private Map<String, List<String>> tags = new LinkedHashMap<>();



	private List<ReferenceFreemarkerModel> seeRefs = new LinkedList<>();

	

	private List<MethodFreemarkerModel> methods = new LinkedList<>();



	public String getTitle() {
@@ -68,14 +68,6 @@ public class BeanFreemarkerModel { 
		this.beanId = beanId;

	}



	public String getBookmark() {

		return bookmark;

	}



	public void setBookmark(String bookmark) {

		this.bookmark = bookmark;

	}



	public String getDocFirstSentence() {

		return docFirstSentence;

	}
@@ -108,6 +100,15 @@ public class BeanFreemarkerModel { 
		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;

	}