tag () documon/src/tag.js 69
xpath documon.tag
file documon/src/tag.js

Processes the following flags

  • property

- package, namespace

  • property
  • method
  • event
  • class

- module

  • private
  • protected
  • static
  • public

- readonly

  • overrides
  • impliments
  • extends

- inherits

  • constructor
  • example
  • param

- return, returns

  • type
  • order
  • optional
  • header
  • defaultVal, default
  • see
  • requires

Fills the flags object

"Source Item", are manufactured from the parseFlag class, and generally provided to many of the methods as the "item" argument, and they contain the following fields:

    Source Item {
        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        // 
    }
Methods
fillFlag (item, obj) documon/src/tag.js 438

[fillFlag description]

Parameters
item
type

description

obj
type

description

Returns type

description description

processItems (Vlist) private documon/src/tag.js 341

Process flags for an entire list of items

Parameters
Vlist
array

Vlist

processOne (item) documon/src/tag.js 281

processOne

Parameters
item
Source Object

the source item as parsed from comments

Returns object

An object containing flag data