{
  "name": "Index",
  "shortname": "Index",
  "classitems": [
    {
      "file": "lib/index.js",
      "line": 35,
      "description": "<p>Optional configs pulled from <code>fountainhead.js</code></p>\n",
      "itemtype": "property",
      "name": "fountainheadConfig",
      "type": "{Object}",
      "class": "Index",
      "module": "Lib",
      "srcFileId": "lib_index.js"
    },
    {
      "file": "lib/index.js",
      "line": 40,
      "description": "<p>Package JSON for project. Used to populate project description if not\ndefined in <code>fountainhead.js</code> config.</p>\n",
      "itemtype": "property",
      "name": "packageJSON",
      "type": "{Object}",
      "class": "Index",
      "module": "Lib",
      "srcFileId": "lib_index.js"
    },
    {
      "file": "lib/index.js",
      "line": 78,
      "description": "<p>Raw YUIDoc JSON data generated using constructor exported by <code>yuidocjs</code>.\nCall new with options from config to pass configs to YUIDoc and call <code>run</code>\nto generate JSON</p>\n",
      "itemtype": "property",
      "name": "yuidocJSON",
      "type": "{Object}",
      "class": "Index",
      "module": "Lib",
      "srcFileId": "lib_index.js"
    }
  ],
  "plugins": [],
  "extensions": [],
  "plugin_for": [],
  "extension_for": [],
  "module": "Lib",
  "namespace": "",
  "file": "lib/index.js",
  "line": 9,
  "description": "<p>Fountainhead documentation data generation lib entry. Configuration is set\nthrough <code>fountainhead.js</code> file. (TODO: Add default configs to decorate-config)\nclass and link.</p>\n<p>The entry handles:</p>\n<ol>\n<li>Safe require of <code>package.json</code> &amp;&amp; <code>fountainhead.js</code> files for configs</li>\n<li>Decoration &amp;&amp; validation of project configs</li>\n<li>Generation of raw YUIDoc JSON through YUIDoc module directly</li>\n<li>Decoration of raw data in <code>generate-fountainhead-data</code> module.</li>\n</ol>\n<p>The primary module is the <code>generate-fountainhead-data</code> which handles all of\nthe decoration and file creation required for Fountainhead.</p>\n",
  "is_constructor": 1,
  "uses": [
    "decorateConfig",
    "createDirs",
    "generateFountainheadData"
  ],
  "params": [
    {
      "name": "config",
      "description": "Fountainhead configuration",
      "type": "Object",
      "props": [
        {
          "name": "env",
          "description": "Execution environment",
          "type": "String"
        }
      ]
    }
  ],
  "method": [],
  "property": [
    {
      "file": "lib/index.js",
      "line": 35,
      "description": "<p>Optional configs pulled from <code>fountainhead.js</code></p>\n",
      "itemtype": "property",
      "name": "fountainheadConfig",
      "type": "{Object}",
      "class": "Index",
      "module": "Lib",
      "srcFileId": "lib_index.js"
    },
    {
      "file": "lib/index.js",
      "line": 40,
      "description": "<p>Package JSON for project. Used to populate project description if not\ndefined in <code>fountainhead.js</code> config.</p>\n",
      "itemtype": "property",
      "name": "packageJSON",
      "type": "{Object}",
      "class": "Index",
      "module": "Lib",
      "srcFileId": "lib_index.js"
    },
    {
      "file": "lib/index.js",
      "line": 78,
      "description": "<p>Raw YUIDoc JSON data generated using constructor exported by <code>yuidocjs</code>.\nCall new with options from config to pass configs to YUIDoc and call <code>run</code>\nto generate JSON</p>\n",
      "itemtype": "property",
      "name": "yuidocJSON",
      "type": "{Object}",
      "class": "Index",
      "module": "Lib",
      "srcFileId": "lib_index.js"
    }
  ],
  "event": [],
  "srcFileId": "lib_index.js"
}