Liking cljdoc? Tell your friends :D

dots.typescript.js-doc-parsing-mode


parse-allcljs

Always parse JSDoc comments and include them in the AST.

This is the default if no mode is provided.

Always parse JSDoc comments and include them in the AST.

This is the default if no mode is provided.
sourceraw docstring

parse-for-type-errorscljs

Parse only JSDoc comments which are needed to provide correct type errors.

This will always parse JSDoc in non-TS files, but only parse JSDoc comments containing @see and @link in TS files.

Parse only JSDoc comments which are needed to provide correct type errors.

This will always parse JSDoc in non-TS files, but only parse JSDoc comments
containing `@see` and `@link` in TS files.
sourceraw docstring

parse-for-type-infocljs

Parse only JSDoc comments which are needed to provide correct type info.

This will always parse JSDoc in non-TS files, but never in TS files.

Note: Do not use this mode if you require accurate type errors; use {@link ParseForTypeErrors } instead.

Parse only JSDoc comments which are needed to provide correct type info.

This will always parse JSDoc in non-TS files, but never in TS files.

Note: Do not use this mode if you require accurate type errors; use {@link ParseForTypeErrors } instead.
sourceraw docstring

parse-nonecljs

Never parse JSDoc comments, mo matter the file type.

Never parse JSDoc comments, mo matter the file type.
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close