24. 文档生成器

RST 模块提供一系列辅助例程，用于自动生成 Daslang reStructuredText 文档。

所有函数和符号都在 “rst ”模块中，使用 require 可以访问该模块。:

require daslib/rst
DocGroup

DocGroup 字段是

name

string

func

array< ast::Function ?>

hidden

bool

具有共享类别的功能组。

24.1. Document writers

document(name: string const; mod: Module? const; fname: string const; substname: string const; groups: array<DocGroup> const)

argument

argument type

name

string const

mod

rtti::Module ? const

fname

string const

substname

string const

groups

array< rst::DocGroup > const

为给定的 DocGropus 列表中的单个模块编写文档。 这将生成包含模块文档的 RST 文件。 与任何 DocGroup 不匹配的函数将被归入 Uncategorized 组。

24.2. Group operations

group_by_regex(name: string const; mod: Module? const; reg: Regex)

group_by_regex returns rst::DocGroup

argument

argument type

name

string const

mod

rtti::Module ? const

reg

regex::Regex

创建具有共享类别的函数组。 符合正则表达式的函数将被添加到组中。

hide_group(group: DocGroup)

hide_group returns rst::DocGroup

argument

argument type

group

rst::DocGroup

将组标记为隐藏。

24.3. 未分类

function_file_name(value: smart_ptr<Function> const|Function? const const)

function_file_name returns auto

argument

argument type

value

option const

获取函数的文件名。