Imports
-
../ast/ast, ../ast/idents, ../ast/wordrecg, ../ast/syntaxes, ../ast/renderer, ../ast/lexer, ../ast/trees, ../ast/typesrenderer, ../ast/astalgo, ../ast/lineinfos, ../ast/renderverbatim, ../modules/nimpaths, ../front/options, ../front/msgs, ../utils/pathutils, ../ast/reports_sem, ../ast/reports_backend, ../ast/reports_cmd, ../ast/reports_internal, ../ast/report_enums, ../utils/nodejs
Procs
proc commandBuildIndex(conf: ConfigRef; dir: string; outFile = RelativeFile"") {....raises: [ OSError, IOError, ValueError, Exception, Exception, ERecoverableError], tags: [ ReadDirEffect, ReadIOEffect, RootEffect, ReadEnvEffect, TimeEffect, WriteIOEffect].}
- Source Edit
proc commandRst2Html(cache: IdentCache; conf: ConfigRef) {....raises: [ValueError, OSError, IOError, Exception, KeyError, ERecoverableError], tags: [ WriteDirEffect, ReadDirEffect, RootEffect, ReadIOEffect, ReadEnvEffect, WriteIOEffect, ExecIOEffect, TimeEffect].}
- Source Edit
proc commandRst2TeX(cache: IdentCache; conf: ConfigRef) {....raises: [ValueError, OSError, IOError, Exception, KeyError, ERecoverableError], tags: [ WriteDirEffect, ReadDirEffect, RootEffect, ReadIOEffect, ReadEnvEffect, WriteIOEffect, ExecIOEffect, TimeEffect].}
- Source Edit
proc commandTags(cache: IdentCache; conf: ConfigRef) {....raises: [Exception, ERecoverableError, IOError, ValueError, KeyError, OSError, Exception, ERecoverableError], tags: [RootEffect, ReadIOEffect, ReadDirEffect, WriteIOEffect, WriteDirEffect].}
- Source Edit
proc documentRaises(cache: IdentCache; n: PNode) {. ...raises: [Exception, KeyError, ValueError], tags: [RootEffect].}
- Source Edit
proc finishGenerateDoc(d: var PDoc) {....raises: [Exception, ValueError], tags: [RootEffect, ReadEnvEffect].}
- Perform 2nd RST pass for resolution of links/footnotes/headings... Source Edit
proc generateDoc(d: PDoc; n, orig: PNode; docFlags: DocFlags = kDefault) {....raises: [ ValueError, KeyError, Exception, ERecoverableError, OSError, IOError], tags: [ RootEffect, ReadDirEffect, ReadIOEffect, ReadEnvEffect, WriteDirEffect, WriteIOEffect].}
- Goes through nim nodes recursively and collects doc comments. Main function for doc command, which is implemented in docgen2.nim. Source Edit
proc generateIndex(d: PDoc) {....raises: [OSError, IOError, Exception, KeyError, ERecoverableError], tags: [ WriteDirEffect, ReadDirEffect, RootEffect, WriteIOEffect].}
- Source Edit
proc generateJson(d: PDoc; n: PNode; includeComments: bool = true) {. ...raises: [KeyError, Exception, ValueError], tags: [RootEffect].}
- Source Edit
proc generateTags(d: PDoc; n: PNode; r: var string) {. ...raises: [KeyError, Exception, ValueError], tags: [RootEffect].}
- Source Edit
proc handleDocOutputOptions(conf: ConfigRef) {....raises: [OSError], tags: [].}
- Source Edit
proc newDocumentor(filename: AbsoluteFile; cache: IdentCache; conf: ConfigRef; outExt: string = HtmlExt; module: PSym = nil; isPureRst = false): PDoc {....raises: [ValueError, OSError, IOError, Exception, KeyError, ERecoverableError], tags: [WriteDirEffect, ReadDirEffect, RootEffect].}
- Source Edit
proc presentationPath(conf: ConfigRef; file: AbsoluteFile): RelativeFile {. ...raises: [Exception, KeyError, ERecoverableError, OSError], tags: [RootEffect, ReadDirEffect].}
- returns a relative file that will be appended to outDir Source Edit
proc writeOutput(d: PDoc; useWarning = false; groupedToc = false) {....raises: [ OSError, ValueError, IOError, Exception, ERecoverableError, KeyError, Exception, ERecoverableError], tags: [ReadEnvEffect, ReadIOEffect, WriteIOEffect, ReadDirEffect, ExecIOEffect, RootEffect, TimeEffect, WriteDirEffect].}
- Source Edit
proc writeOutputJson(d: PDoc; useWarning = false) {....raises: [OSError, ValueError, IOError, Exception, ERecoverableError, KeyError], tags: [ ReadEnvEffect, ReadIOEffect, WriteIOEffect, ReadDirEffect, ExecIOEffect, RootEffect].}
- Source Edit