inteligr8/activiti-api-doclet
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

better delegate docs; minor formatting tweaks

Browse Source
This commit is contained in:
Brian Long 2025-02-10 14:29:51 -05:00
parent 1fe2bdf92c
commit 12c80ad087
1 changed files with 23 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

57
src/main/resources/templates/bean.md.ftl
View File

@ -1,12 +1,10 @@
# ${title}<#if apiName??>: ${apiName}</#if>: `${beanId}`
<#if (tags.author?? || tags.since?? || tags.deprecated??)><#if tags.author??><#list tags.author as author>
<#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>
<#if docBody??>${docBody}<#else>No documentation available.</#if>
@ -26,27 +24,14 @@ This bean may be used as a *Delegate* using the "Delegate Expression" field as s
${r"${"}${beanId}${r"}"}
```
<#if delegateMethod??>
You may use it in a **Service Task**.
<#if delegateMethod.docBody??>${delegateMethod.docBody}<#else>No additional documentation available.</#if>
---
</#if><#if executionListenerMethod??>
You may use it in an **Execution Listener**.
<#if executionListenerMethod.docBody??>${executionListenerMethod.docBody}<#else>No additional documentation available.</#if>
---
</#if><#if taskListenerMethod??>
You may use it in a **Task Listener**.
<#if taskListenerMethod.docBody??>${taskListenerMethod.docBody}<#else>No additional documentation available.</#if>
---
<#if delegateMethod?? || executionListenerMethod?? || taskListenerMethod??>
<#assign taskUses = [] />
<#if delegateMethod??><#assign taskUses = taskUses + ["**Service Task**"] /></#if>
<#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
@ -66,7 +51,14 @@ This bean and its methods may be used in any "Expression" field or script in a S
<#list method.signatures as sig>
**`${beanId}.${sig.methodSignature}`**
<#if (sig.tags.author?? || sig.tags.since?? || sig.tags.deprecated??)>
<@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}
@ -79,12 +71,12 @@ This bean and its methods may be used in any "Expression" field or script in a S
</#if>
<#if sig.docBody??>${sig.docBody}<#else>No documentation available.</#if>
<#if (sig.params?size > 0)>
<#if ((showParams && sig.params?size > 0) || sig.bpmnFields?size > 0 || sig.variablesIn?size > 0)>
| Input Type | Name | Java Type | Documentation |
| ------------------------ | ------------------------ | ------------------------------------------------ | ---------------------------------- |
<#list sig.params as paramName, param>
<#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>
</#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> |
@ -92,12 +84,12 @@ This bean and its methods may be used in any "Expression" field or script in a S
</#if>
<#if (sig.variablesIn?size > 0)>
<#list sig.variablesIn as varName, var>
| APS 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> |
| 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.throwTypes?size > 0)>
<#if (sig.returnType?? || sig.variablesOut?size > 0 || sig.throwTypes?size > 0)>
| Result Type | Java Type, Name, or Error Code | Documentation |
| ------------------------ | ------------------------------------------------ | -------------------------------- |
<#if sig.returnType??>
@ -105,7 +97,7 @@ This bean and its methods may be used in any "Expression" field or script in a S
</#if>
<#if (sig.variablesOut?size > 0)>
<#list sig.variablesOut as varName, var>
| APS Variable | ${("`" + varName + "`")?right_pad(48)} | <#if (var.comment?? && var.comment?length > 0)>${var.comment?right_pad(32)}<#else>No documentation available.</#if> |
| Activiti Variable | ${("`" + varName + "`")?right_pad(48)} | <#if (var.comment?? && var.comment?length > 0)>${var.comment?right_pad(32)}<#else>No documentation available.</#if> |
</#list>
</#if>
<#if (sig.throwTypes?size > 0)>
@ -128,7 +120,4 @@ This bean and its methods may be used in any "Expression" field or script in a S
</#if>
---
</#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>