gendoc.generator
Document
generator
Passes module information such as paths or compilation options to the compiler,
and generate JSON and HTML files. And also convert mustache files.
- struct
MustashImportOptions
; -
- string
file
; - string[]
imports
; - string
contents
; - string[string]
map
; - string[]
useSections
;
- struct
MustashCommandOptions
; -
- string[]
args
; - string[string]
env
; - string
workDir
;
- struct
DocumentGenerator
; -
- string
compiler
; - string[]
ddocFiles
; - bool
disableMarkdown
; - string
targetDir
; - string
rootDir
; - void delegate(string dubPkgName, in ModInfo[] modInfo, string[] args)
preGenerateCallback
; - void delegate(string dubPkgName, in ModInfo[] modInfo, int result, string output)
postGenerateCallback
; - void delegate(string src, string dst)
postCopyCallback
; - string delegate(string[] args, string workdir, string[string] env)
executeProcessor
; - string delegate(string args, string workdir, string[string] env)
commandProcessor
; - void
createTemporaryDir
(); - void
removeTemporaryDir
(); - const pure nothrow @nogc @property @safe string
temporaryDir
(); - @property @safe void
combinedDubPackagePatterns
(in string[][string] patternMap); - string
convertFromMustache
(in DubPkgInfo[] info, string dir, string mustacheName); - Convert from mustache fileReturns: Converted file contents
- string
generateFromMustache
(in DubPkgInfo[] info, string dir, string mustacheName); - Generate file from mustache fileReturns: File name of generated
- void
generateDdoc
(in DubPkgInfo[] info, string dir, string mustacheName); - Generate ddoc file from mustache fileThe generated ddoc file is added automatically
- void
generateJson
(ref DubPkgInfo dubpkg); - Generate JSON file from d source file through syntax compilation
- void
generate
(string target, string source, string[] options);
voidgenerate
(ref DubPkgInfo dubpkg, bool singleFile = false);