如何解决Doxygen的Markdown文件,两个难题
环境是Microsoft Windows 10中的Doxygen 1.8.7。
我正在一个Doxygen项目中,该项目包括几个markdown文件,所有文件都遵循这种模式:
1 Copyright (c) 2016-2017,XYZ CORP. All rights reserved.
2
3 @page xxx yyy
4 @{
5 Start of text
.
.
.
End of text
对此我有两个问题。
首先,该文件没有@}
来平衡第4行上的@{
,但Doxygen并未发出警告。这只是Doxygen中的错误或怪癖,还是出于某些我不理解的原因有效?
第二,此文件产生(至少)两页输出。其中一个标题为yyy
,其中包含第5行及其后的文本,这很好。另一个标题为md_<d>_<dd>_<ddd>_xxx.html
,
其中<d>_<dd>_<ddd>...
是从存储库主目录到文件的路径中目录的名称。该文件只包含版权声明,它毫无用处,看上去很愚蠢。
有没有办法使此页面消失?
注意,我还没有想出如何通过单击链接从项目主页进入“版权”页面。如果没有办法做到这一点,那么页面的存在就是微不足道的。但是我认为,因为Doxygen生成了页面,所以它提供了显示它们的某种方式,但我还没有找到。
解决方法
正如评论中已经指出的,版本1.8.7有点旧(2014年4月),当前的doxygen版本是1.8.20。 此答案中的解决方案基于多氧1.8.20,因为对于1.8.7,它们将在1.8.7中不起作用(在1.8.17中它们应起作用)
问题中提到了2个问题
-
在
@{
没有关闭@}
的情况下没有警告。这可能是不正确的,但是@{
对于@page
毫无意义。应对此进行进一步调查,可能值得在doxygen问题跟踪器中发布一个新问题:https://github.com/doxygen/doxygen/issues/new/choose。。我刚刚将一个建议的补丁程序推送到了github(请求8060,https://github.com/doxygen/doxygen/pull/8060)。 -
删除“版权”
在降价文件中,当第一个非空白行不是页面命令时(例如@page
\@mainpage
text\n====
),doxygen将添加一个@page
命令,其名称为文件作为标题。有许多可能性可以“克服”此问题。 Doxygen具有许多命令,这些命令使内容的内容与注释的内容一样少,因此不会显示在输出中。这些是:-
<!-- ....->
,即正常的HTML注释符号(还将从其他输出格式中删除该内容) -
\cond [<label>]
...\endcond
,如果`判断为假或不存在,则不会显示该块的内容 -
\if <label>
...\endif
,以防万一`判断为假,未显示块内容 -
\noop ...
不显示命令后的一行文本。
这里的问题是它们不会删除页面引用(由于处理的顺序,命令不会显示为非空行),因此可以找到解决方法:
- 使用“ comment”命令在内部移动内容(至少在第一个
@page
like命令之后的某个位置。)这样的解决方案如下:@page xxx1 yyy1 <!-- Copyright (c) 2016-2017,XYZ CORP. All rights reserved. --> Start of text1
-
好像我之前已经创建了一个有关<!--
:https://github.com/doxygen/doxygen/pull/6909
编辑2020年9月29日:拉取请求https://github.com/doxygen/doxygen/pull/8060已集成到doxygen的主版本中。
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。