createDocs
createDocs(
sourcePath,outputPath,repoUrl?,split?):void
Defined in: readme-tsdoc.js:684
Generate reference documentation for a TypeScript source file and write it to an output file.
Parameters
Section titled “Parameters”sourcePath
Section titled “sourcePath”string
Path to the TypeScript source file
outputPath
Section titled “outputPath”string
Path to the output file (will be overwritten)
repoUrl?
Section titled “repoUrl?”string
Optional repository URL for generating deep links
split?
Section titled “split?”boolean
When true, split documentation into multiple files
Returns
Section titled “Returns”void