...
Variable | Description |
|---|---|
hint | A short description of what the tag does. Used in CFEclipse as a tooltip. |
description | A longer explanation of the tag. Will be used in HTML documentation, and can contain HTML code. |
examples | Examples of tag usage. Will be used in HTML documentation, and can contain HTML code. |
single | A boolean value that indicates whether this is a single element tag (i.e. <abcd>) or not (i.e. <efgh>...</efgh>. Defaults to true. |
xmlstyle | If this is a single tag, this boolean value indicates whether the tag needs to be used XML style, i.e. <abcd /> |
bDocument | Must be set to true for the tag to be included in documentation |
bDeprecated | Set to true to indicate that use of this tag is discouraged. The description and examples should include further information about preferred usage. |
| Code Block |
|---|
<!---
@@hint: This does does stuff!
@@single: false
--->
|
Attribute Information
Attribute information is extracted from CFParam'ed attribute variables. Comment variables should be included in a comment IMMEDIATELY after the CFParam tag (no spaces or line breaks). To include an attribute that can't be CFParam'ed (e.g. attributes that are used in isDefined checks) you can comment out the CFParam tag defining the attribute, and include another comment immediately after it for comment variables.
...