lib/apidox/index.js
function ApiDox() {
  this.settings = {
    input: '',
    inputText: null,
    inputTitle: '',
    output: '',
    fullSourceDescription: false
  };
  this.anchors = {};
  this.comments = [];
  this.curSection = null;
  this.fileComment = {};
  this.lines = [];
  this.params = {};
  this.returns = {};
  this.sees = [];
  this.toc = [];
  this.throws = [];
}
function ApiDox() {
  this.settings = {
    input: '',
    inputText: null,
    inputTitle: '',
    output: '',
    fullSourceDescription: false
  };
  this.anchors = {};
  this.comments = [];
  this.curSection = null;
  this.fileComment = {};
  this.lines = [];
  this.params = {};
  this.returns = {};
  this.sees = [];
  this.toc = [];
  this.throws = [];
}
function ApiDox ( ) { this . settings = { input : '' , inputText : null , inputTitle : '' , output : '' , fullSourceDescription : false } ; this . anchors = { } ; this . comments = [ ] ; this . curSection = null ; this . fileComment = { } ; this . lines = [ ] ; this . params = { } ; this . returns = { } ; this . sees = [ ] ; this . toc = [ ] ; this . throws = [ ] ; }
ApiDox constructor.

Usage:

var dox = require('apidox').create();
var markdown = dox
.set('input', '/path/to/source.js')
.set('output', '/path/to/output.md')
.parse()
.convert();

Configuration:

- `{string} input` Source file to read
- `{string} inputText` Alternative to `input`
- `{string|boolean} [inputTitle=input]` Customize `Source: ...` link text
- `false`: Omit `Source: ...` entirely from markdown
- `string`: Set link text (does not affect link URL)
- `{string} output` Markdown file to write

Properties:

- `{object} anchors` Keys are object paths which already have anchors
- For duplicate prevention
- `{array} comments` Filtered dox-provided objects to convert
- `{string curSection` Current section being converted, ex. 'Klass.prototype'.
- `{object} fileComment` First dox-provided comment found in the file
- `{array} lines` Markdown lines
- `{object} params` Collected `@param` meta indexed by method name
- `{array} types` Type names
- `{string} description` First line
- `{array} overflow` Additional lines
- `{object} returns` Collected `@return` metadata indexed by method name
- `{array} types` Type names
- `{string} description` First line
- `{array} overflow` Additional lines
- `{array} sees` Collected `@see` lines
- `{array} toc` Collected table-of-contents metadata objects
- `{string} title` Link title
- `{string} url` Link URL
- `{array} throws` Collected `@throws` lines
ApiDox constructor .