Typedoc: Is there a way to generate docs in presence of TypeScript errors?

Created on 17 Jul 2015  路  3Comments  路  Source: TypeStrong/typedoc

Is there a way to generate docs in presence of TypeScript errors?
Sometimes, even often, it is needed to make docs for your team, even when code has a few compile-time glitches.

enhancement

Most helpful comment

Version 0.3.6 is now on NPM which allows you to specify the --ignoreCompilerErrors argument.

All 3 comments

Currently there is no such option, TypeDoc will stop if the compiler emits any errors. We could add an option to let you bypass this check, however I can't guarantee the generated docs will be correct as I don't know in which state the compiler leaves the generated symbols.

Version 0.3.6 is now on NPM which allows you to specify the --ignoreCompilerErrors argument.

Yes, this works through gulp-typescript. Thanks a lot.

Was this page helpful?
0 / 5 - 0 ratings