documon
Version:
A documentation system for mortals. Use with any language.
36 lines (20 loc) • 547 B
Markdown
# Default Values
Use the @default, @defaultVal or @defaultValue flags:
@default Something
@defaultVal "foo"
@defaultValue 42
In a property
@property foo
@type object
@default "bar"
### Incorporate a Default Value Inline
Include the default value by attaching it to the name with an equal sign.
In a method param tag:
@param {type} arg1=foo - description
In a "quick prop" property:
@property {object} foo="bar" - description
The equal sign must butt-up against the name and the value:
good:
: arg1=foo
bad:
: arg1 = foo