.. _stdlib_rst:

=======================
文档生成器
=======================

.. include:: detail/rst.rst

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

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

    require daslib/rst


.. _struct-rst-DocGroup:

.. das:attribute:: DocGroup



DocGroup 字段是

+------+----------------------------------------------------+
+name  +string                                              +
+------+----------------------------------------------------+
+func  +array< :ref:`ast::Function <handle-ast-Function>` ?>+
+------+----------------------------------------------------+
+hidden+bool                                                +
+------+----------------------------------------------------+


具有共享类别的功能组。

++++++++++++++++
Document writers
++++++++++++++++

  *  :ref:`document (name:string const;mod:rtti::Module? const;fname:string const;substname:string const;groups:array\<rst::DocGroup\> const) : void <function-_at_rst_c__c_document_Cs_C1_ls_H_ls_rtti_c__c_Module_gr__gr__qm__Cs_Cs_C1_ls_S_ls_rst_c__c_DocGroup_gr__gr_A>` 

.. _function-_at_rst_c__c_document_Cs_C1_ls_H_ls_rtti_c__c_Module_gr__gr__qm__Cs_Cs_C1_ls_S_ls_rst_c__c_DocGroup_gr__gr_A:

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

+---------+---------------------------------------------------------+
+argument +argument type                                            +
+=========+=========================================================+
+name     +string const                                             +
+---------+---------------------------------------------------------+
+mod      + :ref:`rtti::Module <handle-rtti-Module>` ? const        +
+---------+---------------------------------------------------------+
+fname    +string const                                             +
+---------+---------------------------------------------------------+
+substname+string const                                             +
+---------+---------------------------------------------------------+
+groups   +array< :ref:`rst::DocGroup <struct-rst-DocGroup>` > const+
+---------+---------------------------------------------------------+


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

++++++++++++++++
Group operations
++++++++++++++++

  *  :ref:`group_by_regex (name:string const;mod:rtti::Module? const;reg:regex::Regex -const) : rst::DocGroup <function-_at_rst_c__c_group_by_regex_Cs_C1_ls_H_ls_rtti_c__c_Module_gr__gr__qm__S_ls_regex_c__c_Regex_gr_>` 
  *  :ref:`hide_group (group:rst::DocGroup -const) : rst::DocGroup <function-_at_rst_c__c_hide_group_S_ls_rst_c__c_DocGroup_gr_>` 

.. _function-_at_rst_c__c_group_by_regex_Cs_C1_ls_H_ls_rtti_c__c_Module_gr__gr__qm__S_ls_regex_c__c_Regex_gr_:

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

group_by_regex returns  :ref:`rst::DocGroup <struct-rst-DocGroup>` 

+--------+-------------------------------------------------+
+argument+argument type                                    +
+========+=================================================+
+name    +string const                                     +
+--------+-------------------------------------------------+
+mod     + :ref:`rtti::Module <handle-rtti-Module>` ? const+
+--------+-------------------------------------------------+
+reg     + :ref:`regex::Regex <struct-regex-Regex>`        +
+--------+-------------------------------------------------+


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

.. _function-_at_rst_c__c_hide_group_S_ls_rst_c__c_DocGroup_gr_:

.. das:function:: hide_group(group: DocGroup)

hide_group returns  :ref:`rst::DocGroup <struct-rst-DocGroup>` 

+--------+--------------------------------------------+
+argument+argument type                               +
+========+============================================+
+group   + :ref:`rst::DocGroup <struct-rst-DocGroup>` +
+--------+--------------------------------------------+


将组标记为隐藏。

+++++++++++++
未分类
+++++++++++++

.. _function-_at_rst_c__c_function_file_name_C0_ls_CY_ls_FunctionPtr_gr_1_ls_H_ls_ast_c__c_Function_gr__gr__qm_M;C1_ls_H_ls_ast_c__c_Function_gr__gr__qm__gr_|:

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

function_file_name returns auto

+--------+-------------+
+argument+argument type+
+========+=============+
+value   +option const +
+--------+-------------+


获取函数的文件名。