diff --git a/src/main/resources/templates/bean.md.ftl b/src/main/resources/templates/bean.md.ftl index feec358..64afec1 100644 --- a/src/main/resources/templates/bean.md.ftl +++ b/src/main/resources/templates/bean.md.ftl @@ -1,21 +1,25 @@ # ${title}<#if apiName??>: ${apiName}: `${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} -<#if tags.since??>*Since Version*: ${tags.since[0]} +<#if tags.author??><#list tags.author as author>*Author*: ${author} +<#if tags.since??>*Since Version*: ${tags.since[0]} <#if tags.version??>*Version*: ${tags.version[0]} -<#if tags.deprecated??>*Deprecated* - +<#if tags.deprecated??>*Deprecated* + <#if docBody??>${docBody}<#else>No documentation available. +<#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}) -<#if tags.see??><#list tags.see as see> +<#if tags.see??><#list tags.see as see> *See Also*: ${see} - - - + <#if hasDelegate> + ## 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 taskListenerMethod??><#assign taskUses = taskUses + ["**Task Listener**"] /> You may use it in a ${taskUses?join(" or ")}. - <@sigdoc sig=delegateMethod showParams=false/> <#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. | ---- - <#list methods as method> -## `${method.methodName}` +### `${method.methodName}` <#list method.signatures as sig> **`${beanId}.${sig.methodSignature}`** - <@sigdoc sig=sig showParams=true/> + +--- + [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} - - -<#if sig.tags.since??>*Since Version*: ${sig.tags.since[0]} -<#if sig.tags.version??>*Version*: ${sig.tags.version[0]} -<#if sig.tags.deprecated??>*Deprecated* - +<#if sig.tags.author??><#list sig.tags.author as author>*Author*: ${author} +<#if sig.tags.since??>*Since Version*: ${sig.tags.since[0]} +<#if sig.tags.version??>*Version*: ${sig.tags.version[0]} +<#if sig.tags.deprecated??>*Deprecated* + <#if sig.docBody??>${sig.docBody}<#else>No documentation available. - <#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 (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 (sig.tags.see?? || sig.seeRefs?size > 0)><#list sig.seeRefs as seeRef> -*See Also*: [`${seeRef.beanId}.${seeRef.methodName}`](bean-${seeRef.beanId}.md#${seeRef.methodName}) -<#if sig.tags.see??><#list sig.tags.see as see> -*See Also*: ${see} - - ---- +<#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 sig.tags.see??><#list sig.tags.see as see> +*See Also*: ${see} + + + \ No newline at end of file