Functions
A great deal of information gets extracted from your code automatically, but there is some information that you can add with metadata.
Component@bDocument
The generator looks for a bDocument tag on components. Components are only included if it is present and set to true.
Component@scopelocation
This component attribute is used when the component is typically loaded into a scope. It allows you to specify an application variable for singletons or factories, and request / session variables for components that are loaded dynamically.
If a component has a scope location defined all of its included functions are added to the dictionaries scope definitions. This means that the functions will be provided as options in the scope inspection drop-down, like application.applicationname, or session.urltoken.
Function@bDocument
Functions are included if they are explicitly defined as public access (and bDocument is not defined), or if bDocument is set to true.
Function@hint
A short explanation of what the function does.
Function@returntype
Defines the return type of the function. Defaults to void (i.e. no return).
Argument@name
The name of the argument
Argument@type
The type of the argument.
Argument@required
Whether the argument is required.
Argument@default
The default value.
Argument@options
A list of the values supported by the argument. Used in CFEclipse to provide a dropdown list of options.
Argument@hint
A short explanation of the argument. Used in CFEclipse tooltips.
