parseFlags ()
documon/src/parseFlag.js
192
Fills the output object with the following properties (if they exist)
object {
source // Entire first line inlcuding the @flag (only first line)
after // Everything after the @flag
name // One word following {type}. Or first word after the @flag definition when no {type}.
children // name.kid - Array of children
parent // if am a child, this is my parent.
flag // @flag token with @ stripped
defaultVal // name=val
afterType // first line after
text //
}
Here's an expanded and exmple'd definition list
- source
The entire comment block
- after
Everything after the @flag token "as is" (kinda like source)
source : The entire comment block
after : Everything after the @flag token "as is" (kinda like source)
e.g. in this line: