@cppalliance/antora-cpp-tagfiles-extension

cpp:std::vector[]

这将成为一个链接 std::vector 标签文件中的类.

https://en.cppreference.com/w/cpp/container/vector[std::vector,window="_blank"]

也就是说 https://en.cppreference.com/w/cpp/container/vector[std::vector,window="_blank"]。 。 。 .

扩展支持基本类型、自定义标签文件,使用 命名空间指令、模板参数、嵌入符号以及 替换目标名称.

配置

无

安装此扩展名

npm i -D @cppalliance/antora-cpp-tagfiles-extension

游戏本

在您的 antora-playbook.yaml数字 :

antora:
  extensions:
    - require: '@cppalliance/antora-cpp-tagfiles-extension' # 
      cpp-tagfiles:
          files: # 
            - file: ./doc/tagfiles/boost-url-doxygen.tag.xml
              base_url: 'xref:reference:'
            - file: ./doc/tagfiles/boost-system-doxygen.tag.xml
              base_url: https://www.boost.org/doc/libs/master/libs/system/doc/html/
            - file: ./doc/tagfiles/boost-core-doxygen.tag.xml
              base_url: https://www.boost.org/doc/libs/master/libs/core/doc/html/
            - file: ./doc/tagfiles/boost-filesystem-doxygen.tag.xml
              base_url: https://www.boost.org/doc/libs/master/libs/filesystem/doc/
          using-namespaces: 
            - boost::urls
            - boost::urls::grammar
            - boost::system
            - boost::core

• < 1> (韩语) npm 软件包名称 : @cppalliance/antora-cpp-tagfiles-extension (必须)

• <2> 扩展名所用的标签文件列表

• < 3> 扩展使用的名称空间列表

构成部分

组件也可以设置自己的标签文件. 附加以下 antora.yaml数字 :

ext:
  cpp-tagfiles: # 
      files: # 
        - file: ./doc/tagfiles/boost-url-doxygen.tag.xml
          base_url: 'xref:reference:'
        - file: ./doc/tagfiles/boost-system-doxygen.tag.xml
          base_url: https://www.boost.org/doc/libs/master/libs/system/doc/html/
        - file: ./doc/tagfiles/boost-core-doxygen.tag.xml
          base_url: https://www.boost.org/doc/libs/master/libs/core/doc/html/
        - file: ./doc/tagfiles/boost-filesystem-doxygen.tag.xml
          base_url: https://www.boost.org/doc/libs/master/libs/filesystem/doc/
      using-namespaces: 
        - boost::urls
        - boost::urls::grammar
        - boost::system
        - boost::core

• < 1> 播放本需要启用扩展名

• <2> 组件要使用的标签文件列表

• < 3> 组件使用的命名空间列表

这些标签文件只影响其定义所在的组件.

{# }

扩展包括默认的cppreed tagfile. 任何未知事项 自定义标签文件中的符号将在引用标签文件中查找.

使用参考扩展名

何时 @cppalliance/antora-cpp-reference-extension (单位:千美元)https://github.com/cppalliance/antora-cpp-reference-extension 页面存档备份,存于互联网档案馆)为 显示在同一播放簿中的引用标签文件已注册 自动,所以 cpp: 宏可以链接到在 同样的建筑。 如果您通过 module,那个 模块的 xref: 前缀自动随行, 无额外 需要配置 :

antora:
  extensions:
    - require: '@cppalliance/antora-cpp-reference-extension'
    - require: '@cppalliance/antora-cpp-tagfiles-extension'

您仍然可以在游戏本或组件中列出额外的标签文件 如果需要指向其他库,则描述符,但生成 自动取出参考模块.

特征

未知符号

如果扩展名无法在标签文件中找到一个符号,它将会使 符号为纯文本.

cpp:unknown[]

这将使案文变得简单明了:

`unknown`

也就是说 unknown。 。 。 .

缺少符号

默认情况下, 扩展会让缺失的符号沉默地变得简单 单空间输出。 设定 missing-symbol-log-level 到任何 Antora 日志级别 (例如 info, (中文(简体) ), warn,或 error发送日志条目时 保持内线文本不变.

antora:
  extensions:
    - require: '@cppalliance/antora-cpp-tagfiles-extension'
      cpp-tagfiles:
        missing-symbol-log-level: warn
        files:
          - file: ./doc/tagfiles/boost-url-doxygen.tag.xml
            base_url: 'xref:reference:'

有效值为标准 Antora 日志级别 : trace, (中文(简体) ), debug, (中文(简体) ), info, (中文(简体) ), warn, (中文(简体) ), error,以及 fatal启用 silent (或离开选项) unset)完全压制伐木.

* 说明: Antora's (英语) runtime.log.level (默认) warn过滤日志输出 独立选择。 下一级 warn (例如: info 或者说 debug实际上,Antora的日志水平也必须是或 其下为相. 例如,设置 runtime.log.level: warn 财务报告和审定财务报表 missing-symbol-log-level: info 仍然会压制缺失的符号 日志,因为信息级别低于警告的运行时日志级别。 单位 这个案子,设置 runtime.log.level: info 在游戏本或传球中 --log-level info 在命令线上。 如果你想要缺少符号 通知显示时没有额外的 Antora 配置, 使用 warn 因为它是默认的 Antora 日志级别. * :

基本类型

基本类型包括:

cpp:int[]

这将成为一个链接 int 基本类型 参考书目.

`https://en.cppreference.com/w/cpp/language/types#Standard_integer_types[int,window="_blank"]`

也就是说 https://en.cppreference.com/w/cpp/language/types#Standard_integer_types[int,window="_blank"]。 。 。 .

来自 Tag 文件的符号

标签文件的符号作为链接提供:

cpp:std::string[]

这将成为一个链接 std::string 类别 cppreaty 标签文件.

`https://en.cppreference.com/w/cpp/string/basic_string[std::string,window="_blank"]`

也就是说 https://en.cppreference.com/w/cpp/string/basic_string[std::string,window="_blank"]。 。 。 .

支持没有参数的模板类:

cpp:std::vector[]

这将成为一个链接 std::vector 类别 cppreaty 标签文件.

`https://en.cppreference.com/w/cpp/container/vector[std::vector,window="_blank"]`

也就是说 https://en.cppreference.com/w/cpp/container/vector[std::vector,window="_blank"]。 。 。 .

自定义标签文件的符号不包含 window="_blank" 属性,如果 base_url 相对.

cpp:is_charset[]

这将成为一个链接 boost::urls::grammar::is_charset 类别 boost-url-doxygen.tag.xml 标签文件.

`xref:reference:boost/urls/grammar/is_charset.adoc[boost::urls::grammar::is_charset]`

构成部分

当组件定义自己的标签文件时,这些标签文件只影响 定义和优先的成分 游戏本中定义的标签文件.

cpp:boost::urls::string_token::assign_to[]

这将成为一个链接 boost::urls::string_token::assign_to 类别 boost-url-doxygen.tag.xml 标签文件.

`xref:reference:boost/urls/string_token/assign_to.adoc[boost::urls::string_token::assign_to]`

然而,如果其他部分使用 cpp: 对于同一个符号 没有合适的标签文件, 符号会像普通 语句.

`boost::urls::string_token::assign_to`

命名空间

默认名称空间也可以在播放本中或 组件。 当没有匹配的全符号,扩展会 尝试在命名空间中查找符号。 假设 boost::urls::grammar 在游戏本或组件中定义:

cpp:boost::urls::grammar::is_charset[]
cpp:is_charset[]

这将成为一个链接 boost::urls::grammar::is_charset 类别 boost-url-doxygen.tag.xml 标签文件。 然而,链接文本 将会是任何提供给延期.

`xref:reference:boost/urls/grammar/is_charset.adoc[boost::urls::grammar::is_charset]`
`xref:reference:boost/urls/grammar/is_charset.adoc[is_charset]`

和标签文件一样,在一个组件中定义的命名空间只影响 组件。 命名空间 std:: 也可以定义:

cpp:std::string[]
cpp:string[]

这将成为一个链接 std::string 类别 cppreaty 标签文件.

`https://en.cppreference.com/w/cpp/string/basic_string[std::string,window="_blank"]`
`https://en.cppreference.com/w/cpp/string/basic_string[string,window="_blank"]`

模板参数

支持模板参数. 延伸段还将包括链接 从模板参数的标签文件.

cpp:std::vector<int>[]

这将成为一个链接 std::vector<int> 类别 cppreaty 标签文件.

`https://en.cppreference.com/w/cpp/container/vector[std::vector,window="_blank"]<https://en.cppreference.com/w/cpp/language/types#Standard_integer_types[int,window=_blank]>`

也就是说 https://en.cppreference.com/w/cpp/container/vector[std::vector,window="_blank"]<https://en.cppreference.com/w/cpp/language/types#Standard_integer_types[int,window=_blank]>。 。 。 .

自定义标签文件的符号也可以使用模板参数:

cpp:std::vector<url_view>[]

这将成为一个链接 std::vector<url_view> 类别 cppreaty 标签文件.

`https://en.cppreference.com/w/cpp/container/vector[std::vector,window=\"_blank\"]<url_view>`

也就是说 https://en.cppreference.com/w/cpp/container/vector[std::vector,window="blank"]<url_view>。 。 。 .

如果命名空间 boost::urls 它将在上下文中使用 也用于解决 url_view数字 :

cpp:std::vector<url_view>[]

这将成为一个链接 std::vector<url_view> 类别 cppreaty 标签文件.

`https://en.cppreference.com/w/cpp/container/vector[std::vector,window=\"_blank\"]<xref:reference:boost/urls/url_view.adoc[url_view]>`

嵌入符号

扩展支持嵌入符号 :

cpp:boost::urls::url_view_base::segments[]

这将成为一个链接 boost::urls::url_view_base::segments 类别 boost-url-doxygen.tag.xml 标签文件.

`xref:reference:boost/urls/url_view_base/segments.adoc[boost::urls::url_view_base::segments]`

这页是 boost::urls::url_view_base::segments 符号 在标签文件中定义, 而不仅仅是 boost::urls::url_view_base。 。 。 .

有时标签文件中没有嵌入符号的页面,所以 链接将重定向到父符号的页面.

cpp:std::vector::iterator[]

这将成为一个链接 std::vector 类别 引用标签文件 :

`https://en.cppreference.com/w/cpp/container/vector[std::vector::iterator,window=\"_blank\"]`

也就是说 https://en.cppreference.com/w/cpp/container/vector[std::vector::iterator,window="blank"]。 。 。 .

注意,没有页面 std::vector::iterator 在引用中, 因此链接会重定向到父的页面 std::vector 符号.

模板和嵌入式符号也可以合并:

cpp:std::vector<url_view_base::segments>::iterator[]

这将成为一个链接 std::vector<url_view_base::segments>::iterator 类别 cppreaty 标签文件.

`https://en.cppreference.com/w/cpp/container/vector[std::vector,window="_blank"]<xref:reference:boost/urls/url_view_base/segments.adoc[url_view_base::segments]>::https://en.cppreference.com/w/cpp/container/vector[std::vector::iterator,window="_blank"]
`

替换目标名称

扩展可以替换链接的目标名.

cpp:std::vector[sequential container]

这将成为一个链接 std::vector 类别 cppreed tagfile 有文本"序列容器".

`https://en.cppreference.com/w/cpp/container/vector[sequential container,window="_blank"]`

也就是说 https://en.cppreference.com/w/cpp/container/vector[sequential container,window="_blank"]。 。 。 .

当为模板类提供自定义文本时, 扩展将只提供 链接主符号 :

cpp:std::vector<int>[sequential container]

这将成为一个链接 std::vector 类别 cppreed tagfile 有文本"序列容器".

`https://en.cppreference.com/w/cpp/container/vector[sequential container,window="_blank"]`

这也使得 https://en.cppreference.com/w/cpp/container/vector[sequential container,window="_blank"]。 。 。 .

cpp:url_view_base::segments[URL segments]

这将成为一个链接 boost::urls::url_view_base::segments 类别 boost-url-doxygen.tag.xml 带有文字“ URL” 的标签文件 部分。".

`xref:reference:boost/urls/url_view_base/segments.adoc[URL segments]`