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

better delegate @see linking

Browse Source
This commit is contained in:
Brian Long 2025-02-10 14:48:23 -05:00
parent 9b4f7800a3
commit d24aa54e75
3 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -69,7 +69,7 @@ This supports many standard tags used in JavaDoc comments. This includes suppor
| `@return` | | ✓ | | `@return` | | ✓ |
| `@throws` | | ✓ | | `@throws` | | ✓ |
If the `@see` tag contains a `#` (e.g. `beanId#method`) then it will hyperlink to the specified bean and method. If the `@see` tag contains a `#` (e.g. `beanId#method`) then it will hyperlink to the specified bean and method documentation. If you use `beanId#` it will hyperlink to the bean documentation. You can use `beanId#delegate` if you want to hyperlink tot he bean and delegate method documentation.
If the `@throws` tag is a `BPMNError`, the next term is expected to be the error code, followed by the standard comment. For example, `@throws BPMNError http-404 Not found`. If the `@throws` tag is a `BPMNError`, the next term is expected to be the error code, followed by the standard comment. For example, `@throws BPMNError http-404 Not found`.

2
src/main/java/com/inteligr8/activiti/doclet/MarkdownWriter.java
View File

@ -68,7 +68,7 @@ class MarkdownWriter {
.with(Pattern.compile("\\{ ?(@[^}]+) \\}"), "{$1}") .with(Pattern.compile("\\{ ?(@[^}]+) \\}"), "{$1}")
.with(Pattern.compile("\\{@link ([^}]+)\\}"), "[$1]($1)") .with(Pattern.compile("\\{@link ([^}]+)\\}"), "[$1]($1)")
.with(Pattern.compile("([A-Za-z0-9\\-\\._]+@[A-Za-z0-9\\-\\._]+)"), "[$1](mailto:$1)"); .with(Pattern.compile("([A-Za-z0-9\\-\\._]+@[A-Za-z0-9\\-\\._]+)"), "[$1](mailto:$1)");
private final Pattern seeRefPattern = Pattern.compile("^([A-Za-z0-9_\\-]+)[\\.#]([A-Za-z0-9_]+)$"); private final Pattern seeRefPattern = Pattern.compile("^([A-Za-z0-9_\\-]+)[\\.#]([A-Za-z0-9_]*)$");
private final DocletEnvironment docenv; private final DocletEnvironment docenv;
private final File outputDirectory; private final File outputDirectory;

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

@ -16,7 +16,7 @@
</#if> </#if>
<#if hasDelegate> <#if hasDelegate>
## Delegate Expression Uses ## <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. This bean may be used as a *Delegate* using the "Delegate Expression" field as shown in the snippet below.