Doxygen @file在markdown文件中有效吗?

时间:2013-11-15 09:57:03

标签: documentation markdown doxygen

我在使用Doxygen 1.8.5处理的@file文件中混合使用markdown和.md时出现问题。

如果我使用:

# Release Notes

@file releases.md
Release notes

@tableofcontents

@section rel_page Release History

Blah blah blah

除了HTML中的页面标题(由第一个#行产生)之外,我什么都没得到。为了完整起见,无论是否存在'releases.md'文件名都会发生这种情况(根据手册可选)。

但是,如果我删除 @file行...

# Release Notes

@tableofcontents

@section rel_page Release History

Blah blah blah

一切都很完美。

我的语法是否有问题,Doxygen的降价支持不支持@file,还是这个错误?

@file或降价部分的Doxygen手册中没有关于任何约束的内容。

与我的其他人(风滚草)question about markdown and groups有一些相似之处。

1 个答案:

答案 0 :(得分:2)

本手册中structural indicators部分中列出的命令不适用于降价操作。您可以使用@file获得如下效果:

Release notes {#releases}
=============

@tableofcontents

@section rel_page Release History

Blah blah blah