Typedocinc API

Functions

createIncludes(source, includes, options)

Create includes files for an original typedoc documentation.

buildIncludes(source, includes, destination, options)

Merge includes files into original documentation.

Creates a copy of the source documentation containing the includes file for each source file as indicated in the specified folder. Saves resulting documentation in provided folder.

getDefaultIncludesContent(options) ⇒ string | undefined

Load default includes files as specified in provided keys.

createIncludes(source, includes, options)

Create includes files for an original typedoc documentation.

Kind: global function

Param	Type	Description
source	string	Path of source (original) documentation.
includes	string	Path to includes folder. Create before and after includes files for each source file.
options	object	Object with key-value pairs

buildIncludes(source, includes, destination, options)

Merge includes files into original documentation.

Creates a copy of the source documentation containing the includes file for each source file as indicated in the specified folder. Saves resulting documentation in provided folder.

Kind: global function

Param	Type	Description
source	string	Path to source documentation.
includes	string	Path to folder with includes files.
destination	string	Path to resulting documentation, with original and includes files.
options	object	Object with options for building files.

getDefaultIncludesContent(options) ⇒ string | undefined

Load default includes files as specified in provided keys.

Kind: global function
Returns: string | undefined - If file exists, the content of the file, or undefined otherwise.

Param	Type	Description
options	object	Object whose keys are role for files and values are filenames {'beforeIncludes: 'path/to/file/to/include/before'}