refactored freemarker spacing (1d4e323c) · Commits · Inteligr8 / activiti-api-doclet

src/main/resources/templates/bean.md.ftl

+36 −32

Original line number	Diff line number	Diff line
		# ${title}<#if apiName??>: ${apiName}</#if>: `${beanId}`
		<#if (tags.author?? \|\| tags.since?? \|\| tags.version?? \|\| tags.deprecated??)>

		<#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 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>
		</#if><#if tags.deprecated??>Deprecated</#if></#if>

		<#if docBody??>${docBody}<#else>No documentation available.</#if>
		<#if (tags.see?? \|\| seeRefs?size > 0)>

		<#if (tags.see?? \|\| seeRefs?size > 0)><#list seeRefs as seeRef>
		<#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})
		</#list><#if tags.see??><#list tags.see as see>
		</#if></#list><#if tags.see??><#list tags.see as see>
		See Also: ${see}
		</#list></#if>

		</#if>
		</#list></#if></#if>
		<#if hasDelegate>

		## <a name="delegate"></a> Delegate Expression Uses

		This bean may be used as a Delegate using the "Delegate Expression" field as shown in the snippet below.
		@@ -30,9 +34,9 @@ ${r"${"}${beanId}${r"}"}
		<#if executionListenerMethod??><#assign taskUses = taskUses + ["Execution Listener"] /></#if>
		<#if taskListenerMethod??><#assign taskUses = taskUses + ["Task Listener"] /></#if>
		You may use it in a ${taskUses?join(" or ")}.

		<@sigdoc sig=delegateMethod showParams=false/>
		</#if></#if><#if (methods?size > 0)>

		## Expression Uses

		This bean and its methods may be used in any "Expression" field or script in a Script Task in Activiti.
		@@ -43,35 +47,31 @@ This bean and its methods may be used in any "Expression" field or script in a S
		\| ${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}`
		### <a name="${method.methodName}"></a> `${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 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>
		@@ -87,9 +87,9 @@ Generated by the [Inteligr8](https://inteligr8.com) [Activiti API Doclet](https:
		\| 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 sig.returnType??>
		@@ -110,14 +110,18 @@ Generated by the [Inteligr8](https://inteligr8.com) [Activiti API Doclet](https:
		\| 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)>

		</#if><#if (sig.tags.see?? \|\| sig.seeRefs?size > 0)><#list sig.seeRefs as seeRef>
		<#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})
		</#list><#if sig.tags.see??><#list sig.tags.see as see>
		</#if></#list><#if sig.tags.see??><#list sig.tags.see as see>
		See Also: ${see}
		</#list></#if>

		</#list>
		</#if>
		</#if>
		---

		</#macro>
		No newline at end of file