better delegate @see linking
This commit is contained in:
parent
9b4f7800a3
commit
d24aa54e75
@ -69,7 +69,7 @@ This supports many standard tags used in JavaDoc comments. This includes suppor
|
||||
| `@return` | | ✓ |
|
||||
| `@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`.
|
||||
|
||||
|
@ -68,7 +68,7 @@ class MarkdownWriter {
|
||||
.with(Pattern.compile("\\{ ?(@[^}]+) \\}"), "{$1}")
|
||||
.with(Pattern.compile("\\{@link ([^}]+)\\}"), "[$1]($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 File outputDirectory;
|
||||
|
@ -16,7 +16,7 @@
|
||||
|
||||
</#if>
|
||||
<#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.
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user