module typedoc
1. function typedoc.Application (options)
2. function typedoc.CliApplication ()
3. function typedoc.Event (name)
4. function typedoc.EventDispatcher ()
5. function typedoc.ProjectReflection (name)
6. function typedoc.normalizePath (path)
7. function typedoc.resetReflectionID ()
8. object typedoc.Application.prototype
9. object typedoc.CliApplication.prototype
10. object typedoc.Event.prototype
11. object typedoc.EventDispatcher.prototype
12. object typedoc.ProjectReflection.prototype
module typedoc.Application
1. function typedoc.Application (options)
2. string typedoc.Application.VERSION
module typedoc.Application.prototype
1. boolean typedoc.Application.prototype.isCLI
2. function typedoc.Application.prototype.bootstrap (options)
3. function typedoc.Application.prototype.constructor (options)
4. function typedoc.Application.prototype.convert (src)
5. function typedoc.Application.prototype.expandInputFiles (inputFiles)
6. function typedoc.Application.prototype.generateDocs (input, out)
7. function typedoc.Application.prototype.generateJson (input, out)
8. function typedoc.Application.prototype.getTypeScriptPath ()
9. function typedoc.Application.prototype.getTypeScriptVersion ()
10. function typedoc.Application.prototype.toString ()
11. object typedoc.Application.prototype._componentOptions
12. object typedoc.Application.prototype.application
13. string typedoc.Application.prototype.componentName
module typedoc.CliApplication
1. function typedoc.CliApplication ()
module typedoc.CliApplication.prototype
1. boolean typedoc.CliApplication.prototype.isCLI
2. function typedoc.CliApplication.prototype.bootstrap (options)
3. function typedoc.CliApplication.prototype.constructor ()
module typedoc.Event
1. function typedoc.Event (name)
module typedoc.Event.prototype
1. function typedoc.Event.prototype.preventDefault ()
2. function typedoc.Event.prototype.stopPropagation ()
module typedoc.EventDispatcher
1. function typedoc.EventDispatcher ()
module typedoc.EventDispatcher.prototype
module typedoc.ProjectReflection
1. function typedoc.ProjectReflection (name)
module typedoc.ProjectReflection.prototype

module typedoc

function typedoc.Application (options)

description and source-code

function Application(options) {
    var _this = _super.call(this, null) || this;
    _this.logger = new index_3.ConsoleLogger();
    _this.converter = _this.addComponent('converter', index_1.Converter);
    _this.renderer = _this.addComponent('renderer', renderer_1.Renderer);
    _this.plugins = _this.addComponent('plugins', index_3.PluginHost);
    _this.options = _this.addComponent('options', index_4.Options);
    _this.bootstrap(options);
    return _this;
}

example usage

...
            break;
        default:
            grunt.verbose.write(message);
            break;
    }
};

var app = new TypeDoc.Application(options);
var project = app.convert(app.expandInputFiles(this.filesSrc));
if (!project) {
    return false;
}

if (out) app.generateDocs(project, out);
if (json) app.generateJson(project, json);
...

function typedoc.CliApplication ()

description and source-code

function CliApplication() {
    return _super !== null && _super.apply(this, arguments) || this;
}

example usage
```
n/a
```

function typedoc.Event (name)

description and source-code

function Event(name) {
    this._name = name;
}

example usage
```
n/a
```

function typedoc.EventDispatcher ()

description and source-code
```
function EventDispatcher() {
}
```
example usage
```
n/a
```

function typedoc.ProjectReflection (name)

description and source-code

function ProjectReflection(name) {
    var _this = _super.call(this, null, name, abstract_1.ReflectionKind.Global) || this;
    _this.reflections = {};
    _this.symbolMapping = {};
    _this.directory = new index_1.SourceDirectory();
    _this.files = [];
    return _this;
}

example usage
```
n/a
```

function typedoc.normalizePath (path)

description and source-code

function normalizePath(path) {
    return path.replace(/\\/g, '/');
}

example usage
```
n/a
```

function typedoc.resetReflectionID ()

description and source-code

function resetReflectionID() {
    REFLECTION_ID = 0;
}

example usage
```
n/a
```

module typedoc.Application

function typedoc.Application (options)

description and source-code

function Application(options) {
    var _this = _super.call(this, null) || this;
    _this.logger = new index_3.ConsoleLogger();
    _this.converter = _this.addComponent('converter', index_1.Converter);
    _this.renderer = _this.addComponent('renderer', renderer_1.Renderer);
    _this.plugins = _this.addComponent('plugins', index_3.PluginHost);
    _this.options = _this.addComponent('options', index_4.Options);
    _this.bootstrap(options);
    return _this;
}

example usage

...
            break;
        default:
            grunt.verbose.write(message);
            break;
    }
};

var app = new TypeDoc.Application(options);
var project = app.convert(app.expandInputFiles(this.filesSrc));
if (!project) {
    return false;
}

if (out) app.generateDocs(project, out);
if (json) app.generateJson(project, json);
...

module typedoc.Application.prototype

function typedoc.Application.prototype.bootstrap (options)

description and source-code

bootstrap = function (options) {
    this.options.read(options, index_4.OptionsReadMode.Prefetch);
    var logger = this.loggerType;
    if (typeof logger === 'function') {
        this.logger = new index_3.CallbackLogger(logger);
    }
    else if (logger === 'none') {
        this.logger = new index_3.Logger();
    }
    this.plugins.load();
    return this.options.read(options, index_4.OptionsReadMode.Fetch);
}

example usage
```
n/a
```

function typedoc.Application.prototype.constructor (options)

description and source-code

function Application(options) {
    var _this = _super.call(this, null) || this;
    _this.logger = new index_3.ConsoleLogger();
    _this.converter = _this.addComponent('converter', index_1.Converter);
    _this.renderer = _this.addComponent('renderer', renderer_1.Renderer);
    _this.plugins = _this.addComponent('plugins', index_3.PluginHost);
    _this.options = _this.addComponent('options', index_4.Options);
    _this.bootstrap(options);
    return _this;
}

example usage
```
n/a
```

function typedoc.Application.prototype.convert (src)

description and source-code

convert = function (src) {
    this.logger.writeln('Using TypeScript %s from %s', this.getTypeScriptVersion(), this.getTypeScriptPath());
    var result = this.converter.convert(src);
    if (result.errors && result.errors.length) {
        this.logger.diagnostics(result.errors);
        if (this.ignoreCompilerErrors) {
            this.logger.resetErrors();
            return result.project;
        }
        else {
            return null;
        }
    }
    else {
        return result.project;
    }
}

example usage

...
        default:
            grunt.verbose.write(message);
            break;
    }
};

var app = new TypeDoc.Application(options);
var project = app.convert(app.expandInputFiles(this.filesSrc));
if (!project) {
    return false;
}

if (out) app.generateDocs(project, out);
if (json) app.generateJson(project, json);
return true;
...

function typedoc.Application.prototype.expandInputFiles (inputFiles)

description and source-code

expandInputFiles = function (inputFiles) {
    var exclude, files = [];
    if (this.exclude) {
        exclude = new minimatch_1.Minimatch(this.exclude);
    }
    function add(dirname) {
        FS.readdirSync(dirname).forEach(function (file) {
            var realpath = Path.join(dirname, file);
            if (FS.statSync(realpath).isDirectory()) {
                add(realpath);
            }
            else if (/\.tsx?$/.test(realpath)) {
                if (exclude && exclude.match(realpath.replace(/\\/g, '/'))) {
                    return;
                }
                files.push(realpath);
            }
        });
    }
    inputFiles.forEach(function (file) {
        file = Path.resolve(file);
        if (FS.statSync(file).isDirectory()) {
            add(file);
        }
        else if (!exclude || !exclude.match(file)) {
            files.push(file);
        }
    });
    return files;
}

example usage

...
        default:
            grunt.verbose.write(message);
            break;
    }
};

var app = new TypeDoc.Application(options);
var project = app.convert(app.expandInputFiles(this.filesSrc));
if (!project) {
    return false;
}

if (out) app.generateDocs(project, out);
if (json) app.generateJson(project, json);
return true;
...

function typedoc.Application.prototype.generateDocs (input, out)

description and source-code

generateDocs = function (input, out) {
    var project = input instanceof index_2.ProjectReflection ? input : this.convert(input);
    if (!project) {
        return false;
    }
    out = Path.resolve(out);
    this.renderer.render(project, out);
    if (this.logger.hasErrors()) {
        this.logger.error('Documentation could not be generated due to the errors above.');
    }
    else {
        this.logger.success('Documentation generated at %s', out);
    }
    return true;
}

example usage

...

        var app = new TypeDoc.Application(options);
        var project = app.convert(app.expandInputFiles(this.filesSrc));
        if (!project) {
            return false;
        }

        if (out) app.generateDocs(project, out);
        if (json) app.generateJson(project, json);
        return true;
    });
};
...

function typedoc.Application.prototype.generateJson (input, out)

description and source-code

generateJson = function (input, out) {
    var project = input instanceof index_2.ProjectReflection ? input : this.convert(input);
    if (!project) {
        return false;
    }
    out = Path.resolve(out);
    index_3.writeFile(out, JSON.stringify(project.toObject(), null, '\t'), false);
    this.logger.success('JSON written to %s', out);
    return true;
}

example usage

...
        var app = new TypeDoc.Application(options);
        var project = app.convert(app.expandInputFiles(this.filesSrc));
        if (!project) {
            return false;
        }

        if (out) app.generateDocs(project, out);
        if (json) app.generateJson(project, json);
        return true;
    });
};
...

function typedoc.Application.prototype.getTypeScriptPath ()

description and source-code

getTypeScriptPath = function () {
    return Path.dirname(require.resolve('typescript'));
}

example usage
```
n/a
```

function typedoc.Application.prototype.getTypeScriptVersion ()

description and source-code

getTypeScriptVersion = function () {
    var tsPath = this.getTypeScriptPath();
    var json = JSON.parse(FS.readFileSync(Path.join(tsPath, '..', 'package.json'), 'utf8'));
    return json.version;
}

example usage
```
n/a
```

function typedoc.Application.prototype.toString ()

description and source-code

toString = function () {
    return [
        '',
        'TypeDoc ' + Application_1.VERSION,
        'Using TypeScript ' + this.getTypeScriptVersion() + ' from ' + this.getTypeScriptPath(),
        ''
    ].join(typescript.sys.newLine);
}

example usage
```
n/a
```

module typedoc.CliApplication

function typedoc.CliApplication ()

description and source-code

function CliApplication() {
    return _super !== null && _super.apply(this, arguments) || this;
}

example usage
```
n/a
```

module typedoc.CliApplication.prototype

function typedoc.CliApplication.prototype.bootstrap (options)

description and source-code

bootstrap = function (options) {
    var result = _super.prototype.bootstrap.call(this, options);
    if (result.hasErrors) {
        process.exit(1);
        return;
    }
    if (this.version) {
        typescript.sys.write(this.toString());
    }
    else if (this.help) {
        typescript.sys.write(help_1.getOptionsHelp(this.options));
    }
    else if (result.inputFiles.length === 0) {
        typescript.sys.write(help_1.getOptionsHelp(this.options));
        process.exit(2);
    }
    else if (!this.out && !this.json) {
        this.logger.error("You must either specify the 'out' or 'json' option.");
        process.exit(3);
    }
    else {
        var src = this.expandInputFiles(result.inputFiles);
        var project = this.convert(src);
        if (project) {
            if (this.out) {
                this.generateDocs(project, this.out);
            }
            if (this.json) {
                this.generateJson(project, this.json);
            }
            if (this.logger.hasErrors()) {
                process.exit(5);
            }
        }
        else {
            process.exit(4);
        }
    }
    return result;
}

example usage
```
n/a
```

function typedoc.CliApplication.prototype.constructor ()

description and source-code

function CliApplication() {
    return _super !== null && _super.apply(this, arguments) || this;
}

example usage
```
n/a
```

module typedoc.Event

function typedoc.Event (name)

description and source-code

function Event(name) {
    this._name = name;
}

example usage
```
n/a
```

module typedoc.Event.prototype

function typedoc.Event.prototype.preventDefault ()

description and source-code

preventDefault = function () {
    this._isDefaultPrevented = true;
}

example usage
```
n/a
```

function typedoc.Event.prototype.stopPropagation ()

description and source-code

stopPropagation = function () {
    this._isPropagationStopped = true;
}

example usage
```
n/a
```

module typedoc.EventDispatcher

function typedoc.EventDispatcher ()

description and source-code
```
function EventDispatcher() {
}
```
example usage
```
n/a
```

module typedoc.EventDispatcher.prototype

function typedoc.EventDispatcher.prototype.internalOn (name, callback, context, priority, listening)

description and source-code

internalOn = function (name, callback, context, priority, listening) {
    if (priority === void 0) { priority = 0; }
    this._events = eventsApi(onApi, this._events || {}, name, callback, {
        context: context,
        ctx: this,
        listening: listening,
        priority: priority
    });
    if (listening) {
        var listeners = this._listeners || (this._listeners = {});
        listeners[listening.id] = listening;
    }
}

example usage
```
n/a
```

function typedoc.EventDispatcher.prototype.listenTo (obj, name, callback, priority)

description and source-code

listenTo = function (obj, name, callback, priority) {
    if (!obj) {
        return this;
    }
    var id = obj._listenId || (obj._listenId = _.uniqueId('l'));
    var listeningTo = this._listeningTo || (this._listeningTo = {});
    var listening = listeningTo[id];
    if (!listening) {
        var thisId = this._listenId || (this._listenId = _.uniqueId('l'));
        listening = listeningTo[id] = {
            obj: obj,
            objId: id,
            id: thisId,
            listeningTo: listeningTo,
            count: 0
        };
    }
    obj.internalOn(name, callback, this, priority, listening);
    return this;
}

example usage
```
n/a
```

function typedoc.EventDispatcher.prototype.listenToOnce (obj, name, callback, priority)

description and source-code

listenToOnce = function (obj, name, callback, priority) {
    var events = eventsApi(onceMap, {}, name, callback, _.bind(this.stopListening, this, obj));
    return this.listenTo(obj, events, void 0, priority);
}

example usage
```
n/a
```

function typedoc.EventDispatcher.prototype.off (name, callback, context)

description and source-code

off = function (name, callback, context) {
    if (!this._events) {
        return this;
    }
    this._events = eventsApi(offApi, this._events, name, callback, {
        context: context,
        listeners: this._listeners
    });
    return this;
}

example usage
```
n/a
```

function typedoc.EventDispatcher.prototype.on (nameOrMap, callback, context, priority)

description and source-code

on = function (nameOrMap, callback, context, priority) {
    this.internalOn(nameOrMap, callback, context, priority);
    return this;
}

example usage
```
n/a
```

function typedoc.EventDispatcher.prototype.once (name, callback, context, priority)

description and source-code

once = function (name, callback, context, priority) {
    var events = eventsApi(onceMap, {}, name, callback, _.bind(this.off, this));
    return this.on(events, void 0, context, priority);
}

example usage
```
n/a
```

function typedoc.EventDispatcher.prototype.stopListening (obj, name, callback)

description and source-code

stopListening = function (obj, name, callback) {
    var listeningTo = this._listeningTo;
    if (!listeningTo) {
        return this;
    }
    var ids = obj ? [obj._listenId] : _.keys(listeningTo);
    for (var i = 0; i < ids.length; i++) {
        var listening = listeningTo[ids[i]];
        if (!listening) {
            break;
        }
        listening.obj.off(name, callback, this);
    }
    if (_.isEmpty(listeningTo)) {
        this._listeningTo = void 0;
    }
    return this;
}

example usage
```
n/a
```

function typedoc.EventDispatcher.prototype.trigger (name)

description and source-code

trigger = function (name) {
    var args = [];
    for (var _i = 1; _i < arguments.length; _i++) {
        args[_i - 1] = arguments[_i];
    }
    if (!this._events) {
        return this;
    }
    if (name instanceof Event) {
        triggerApi(this._events, name.name, void 0, [name], function (events, args) {
            var ev, i = -1, l = events.length;
            while (++i < l) {
                if (name.isPropagationStopped) {
                    return;
                }
                ev = events[i];
                ev.callback.apply(ev.ctx, args);
            }
        });
    }
    else {
        eventsApi(triggerApi, this._events, name, void 0, args);
    }
    return this;
}

example usage
```
n/a
```

module typedoc.ProjectReflection

function typedoc.ProjectReflection (name)

description and source-code

function ProjectReflection(name) {
    var _this = _super.call(this, null, name, abstract_1.ReflectionKind.Global) || this;
    _this.reflections = {};
    _this.symbolMapping = {};
    _this.directory = new index_1.SourceDirectory();
    _this.files = [];
    return _this;
}

example usage
```
n/a
```

module typedoc.ProjectReflection.prototype

function typedoc.ProjectReflection.prototype.constructor (name)

description and source-code

function ProjectReflection(name) {
    var _this = _super.call(this, null, name, abstract_1.ReflectionKind.Global) || this;
    _this.reflections = {};
    _this.symbolMapping = {};
    _this.directory = new index_1.SourceDirectory();
    _this.files = [];
    return _this;
}

example usage
```
n/a
```

function typedoc.ProjectReflection.prototype.findReflectionByName (arg)

description and source-code

findReflectionByName = function (arg) {
    var names = Array.isArray(arg) ? arg : arg.split('.');
    var name = names.pop();
    search: for (var key in this.reflections) {
        var reflection = this.reflections[key];
        if (reflection.name !== name) {
            continue;
        }
        var depth = names.length - 1;
        var target = reflection;
        while (target && depth >= 0) {
            target = target.parent;
            if (target.name !== names[depth]) {
                continue search;
            }
            depth -= 1;
        }
        return reflection;
    }
    return null;
}

example usage
```
n/a
```

function typedoc.ProjectReflection.prototype.getReflectionsByKind (kind)

description and source-code

getReflectionsByKind = function (kind) {
    var values = [];
    for (var id in this.reflections) {
        var reflection = this.reflections[id];
        if (reflection.kindOf(kind)) {
            values.push(reflection);
        }
    }
    return values;
}

example usage
```
n/a
```

function typedoc.ProjectReflection.prototype.isProject ()

description and source-code

isProject = function () {
    return true;
}

example usage
```
n/a
```

api documentation for typedoc (v0.5.10)

Create api documentations for typescript projects.

table of contents