如何为 Doxygen 的 ileinfo 命令指定选项?

问题描述 投票:0回答:1

文档中的所有命令均以反斜杠 () 或 at 符号 (@) 开头。如果您愿意,可以将下面所有以反斜杠开头的命令替换为以 at 符号开头的对应命令。
https://www.doxygen.nl/manual/commands.html

\fileinfo['{'option'}']

显示放置此命令的文件名(部分)。该选项可以是名称、扩展名、文件名、目录或完整、带有

  • 命名文件名,不带扩展名
  • 扩展文件的扩展名
  • filename 文件名,即名称加扩展名
  • directory 给定文件的目录 full 给定文件的完整路径和文件名。

如果未指定选项,则使用文件名,除非 FULL_PATH_NAMES 设置为 YES,在这种情况下使用 full。
https://www.doxygen.nl/manual/commands.html#cmdfileinfo

我的 Doxyfile:

PROJECT_NAME = hello-world
PROJECT_NUMBER = 0.1.0

INPUT = "C:/dev/hello-world/src" 
INPUT += "C:/dev/hello-world/doc/mainpage.txt"

OUTPUT_DIRECTORY = "C:/dev/hello-world/build/doc"

OUTPUT_LANGUAGE = English

FILE_PATTERNS = *.c *.h
RECURSIVE = YES

我尝试的主页,

mainpage.txt

/**
  @mainpage Main page
  @page My test main page
  Generated from @fileinfo['{'directory'}']
*/

Here is some normal text.

生成的 HTML 页面中的文本:

从 C:/dev/hello-world/doc/mainpage.txt ['{'directory'}'] 生成

使用其广告选项操作 Doxygen 的

\fileinfo
命令的正确语法是什么?
我希望能够根据需要使用文件名、扩展名、文件名和目录来操作生成的 HTML,并且如宣传的那样应该是可以实现的。

我尝试了

\fileinfo['{'option'}']
命令的以下变体:

  • @fileinfo['{'directory'}']
    结果:
    Generated from C:/dev/hello-world/doc/mainpage.txt ['{'directory'}']
  • @fileinfo['{directory}']
    结果:
    Generated from C:/dev/hello-world/doc/mainpage.txt ['{directory}']
  • @fileinfo[{directory}]
    结果:
    Generated from C:/dev/hello-world/doc/mainpage.txt [{directory}]
  • @fileinfo[directory]
    结果:
    Generated from C:/dev/hello-world/doc/mainpage.txt [directory]
  • @fileinfo[{'directory'}]
    结果:
    Generated from C:/dev/hello-world/doc/mainpage.txt [{'directory'}]
  • @fileinfodirectory
    结果:
    Generated from @fileinfodirectory

引号、大括号和方括号的神奇组合是什么来使这个工作成功?

doxygen
1个回答
0
投票

@fileinfo{directory}
结果:
Generated from C:/dev/hello-world/doc

© www.soinside.com 2019 - 2024. All rights reserved.