Javadoc tag support
From Docu Wiki
For admins:
For users:
- Usage instructions
- Text formatting
- Javadoc tag support
- Programming language support
- Output engine support
For developers:
The following JavaDoc tags are supported in docu:
| Name | Supported | Single/Multiple | Applies to | Cascades | |||||
|---|---|---|---|---|---|---|---|---|---|
| Files | Classes | Functions | Variables | Interfaces | Constants | ||||
@param
| Yes (v0.1) | Multiple | No | No | Yes | No | No | No | No |
@return
| Yes (v0.1) | Single | No | No | Yes | No | No | No | No |
@package
| Yes (v0.1) | Single | Yes | No | No | No | No | No | Yes |
@author
| Yes (v0.1) | Multiple | Yes | Yes | Yes | Yes | Yes | Yes | Yes |
@since
| Yes (v0.1) | Single | Yes | Yes | Yes | Yes | Yes | Yes | Yes |
@version
| Planned (v0.2) | Single | Yes | Yes | Yes | Yes | Yes | Yes | No |
@deprecated
| Planned (v0.2) | Single | Yes | Yes | Yes | Yes | Yes | Yes | Yes |
@changelog
| Planned (v0.2) | Multiple | Yes | Yes | Yes | Yes | Yes | Yes | No |
@ignore
| Planned (v0.2) | Single | Yes | Yes | Yes | Yes | Yes | Yes | Yes |
@todo
| Planned (v0.2) | Multiple | Yes | Yes | Yes | Yes | Yes | Yes | No |
@bug
| Planned (v0.2) | Multiple | Yes | Yes | Yes | Yes | Yes | Yes | No |
@warning
| Planned (v0.2) | Multiple | Yes | Yes | Yes | Yes | Yes | Yes | No |
@table
| Yes (v0.1.1) | Multiple | Yes | Yes | Yes | No | No | No | No |
@see
| Yes (v0.2) | Multiple | Yes | Yes | Yes | Yes (not visible yet) | Yes | Yes (not visible yet) | No |
[edit]
Inline tags
Inline tags are tags that are used within a description. The inline tag syntax is {@tag}, e.g. {@link ParserItem}
| Name | Supported |
|---|---|
@link
| Yes (v0.2) |
