# docgen

Dark Mode

- Index

Search:
Group by:

# Imports

ast, options, msgs, ropes, idents, wordrecg, syntaxes, renderer, lexer, trees, types, typesrenderer, astalgo, lineinfos, pathutils, trees, nimpaths, renderverbatim

# Types

    PDoc = ref TDocumentor

  Alias to type less. Source Edit

# Procs

    proc presentationPath(conf: ConfigRef; file: AbsoluteFile; isTitle = false): RelativeFile {...}{.raises: [
        Exception, KeyError, ValueError, IOError, ERecoverableError, OSError], tags: [
        RootEffect, ReadDirEffect, WriteIOEffect, ReadIOEffect, ReadEnvEffect].}

  returns a relative file that will be appended to outDir Source Edit

    proc newDocumentor(filename: AbsoluteFile; cache: IdentCache; conf: ConfigRef;
                       outExt: string = HtmlExt; module: PSym = nil): PDoc {...}{.raises: [
        ValueError, OSError, KeyError, Exception, IOError, ERecoverableError], tags: [
        ReadDirEffect, RootEffect, WriteIOEffect, ReadIOEffect, ReadEnvEffect].}

  Source Edit

    proc documentRaises(cache: IdentCache; n: PNode) {...}{.
        raises: [Exception, ValueError], tags: [RootEffect].}

  Source Edit

    proc generateDoc(d: PDoc; n, orig: PNode; docFlags: DocFlags = kDefault) {...}{.raises: [
        Exception, ValueError, IOError, ERecoverableError, OSError, KeyError], tags: [
        RootEffect, WriteIOEffect, ReadIOEffect, ReadEnvEffect, ReadDirEffect].}

  Source Edit

    proc generateJson(d: PDoc; n: PNode; includeComments: bool = true) {...}{.raises: [
        KeyError, Exception, ValueError, OSError, IOError, ERecoverableError], tags: [
        RootEffect, ReadEnvEffect, ReadDirEffect, WriteIOEffect, ReadIOEffect].}

  Source Edit

    proc generateTags(d: PDoc; n: PNode; r: var Rope) {...}{.
        raises: [Exception, ValueError], tags: [RootEffect].}

  Source Edit

    proc generateIndex(d: PDoc) {...}{.raises: [OSError, Exception, KeyError, ValueError,
                                           IOError, ERecoverableError], tags: [
        RootEffect, ReadDirEffect, WriteIOEffect, ReadIOEffect, ReadEnvEffect].}

  Source Edit

    proc writeOutput(d: PDoc; useWarning = false; groupedToc = false) {...}{.raises: [
        OSError, ValueError, Exception, IOError, ERecoverableError, KeyError], tags: [
        ReadEnvEffect, ReadIOEffect, ExecIOEffect, RootEffect, WriteIOEffect,
        ReadDirEffect, TimeEffect].}

  Source Edit

    proc writeOutputJson(d: PDoc; useWarning = false) {...}{.raises: [OSError,
        ValueError, Exception, IOError, ERecoverableError, KeyError], tags: [
        ReadEnvEffect, ReadIOEffect, ExecIOEffect, RootEffect, WriteIOEffect,
        ReadDirEffect].}

  Source Edit

    proc handleDocOutputOptions(conf: ConfigRef) {...}{.raises: [OSError], tags: [].}

  Source Edit

    proc commandDoc(cache: IdentCache; conf: ConfigRef) {...}{.raises: [OSError,
        Exception, ValueError, IOError, ERecoverableError, KeyError], tags: [
        RootEffect, WriteIOEffect, ReadIOEffect, ReadEnvEffect, ReadDirEffect,
        ExecIOEffect, TimeEffect].}

  Source Edit

    proc commandRst2Html(cache: IdentCache; conf: ConfigRef) {...}{.raises: [ValueError,
        OSError, KeyError, Exception, IOError, ERecoverableError], tags: [
        ReadDirEffect, RootEffect, WriteIOEffect, ReadIOEffect, ReadEnvEffect,
        ExecIOEffect, TimeEffect].}

  Source Edit

    proc commandRst2TeX(cache: IdentCache; conf: ConfigRef) {...}{.raises: [ValueError,
        OSError, KeyError, Exception, IOError, ERecoverableError], tags: [
        ReadDirEffect, RootEffect, WriteIOEffect, ReadIOEffect, ReadEnvEffect,
        ExecIOEffect, TimeEffect].}

  Source Edit

    proc commandJson(cache: IdentCache; conf: ConfigRef) {...}{.raises: [Exception,
        ValueError, IOError, ERecoverableError, KeyError, OSError], tags: [
        RootEffect, WriteIOEffect, ReadIOEffect, ReadEnvEffect, ReadDirEffect].}

  Source Edit

    proc commandTags(cache: IdentCache; conf: ConfigRef) {...}{.raises: [Exception,
        ValueError, IOError, ERecoverableError, KeyError, OSError], tags: [
        RootEffect, WriteIOEffect, ReadIOEffect, ReadEnvEffect, ReadDirEffect].}

  Source Edit

    proc commandBuildIndex(conf: ConfigRef; dir: string; outFile = RelativeFile"") {...}{.
        raises: [OSError, IOError, ValueError, Exception, ERecoverableError], tags: [
        ReadDirEffect, ReadIOEffect, RootEffect, WriteIOEffect, ReadEnvEffect,
        TimeEffect].}

  Source Edit