Module luadoc.taglet.standard.tags
Functions
| description (tag, block, text) | |
| name (tag, block, text) | Set the name of the comment block. |
| class (tag, block, text) | Set the class of a comment block. |
| ret (tag, block, text) | |
| see (tag, block, text) | |
| param (tag, block, text) | |
| usage (tag, block, text) | |
| field (tag, block, text) | |
| handle (tag, block, text) |
Functions
- description (tag, block, text)
-
Parameters
- tag:
- block:
- text:
- name (tag, block, text)
-
Set the name of the comment block. If the block already has a name, issue an error and do not change the previous value
Parameters
- tag:
- block:
- text:
- class (tag, block, text)
-
Set the class of a comment block. Classes can be "module", "function", "table". The first two classes are automatic, extracted from the source code
Parameters
- tag:
- block:
- text:
- ret (tag, block, text)
-
Parameters
- tag:
- block:
- text:
- see (tag, block, text)
-
Parameters
- tag:
- block:
- text:
- param (tag, block, text)
-
Parameters
- tag:
- block:
- text:
- usage (tag, block, text)
-
Parameters
- tag:
- block:
- text:
- field (tag, block, text)
-
Parameters
- tag:
- block:
- text:
- handle (tag, block, text)
-
Parameters
- tag:
- block:
- text: