2013-11-15 25 views
1

我在使用Doxygen 1.8.5处理我的.md文件时遇到了Markdown和@file混合的问题。Doxygen @file是否在降价文件中工作?

如果我使用:

# 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 

这一切都完美。

我得到的语法错误,@file不支持作为Doxygen的markdown支持的一部分,还是这是一个错误?

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

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

回答

2

本手册中的structural indicators部分中列出的命令不适用于减价。你可以得到使用@file的效果,如下所示:

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

@tableofcontents 

@section rel_page Release History 

Blah blah blah 
+1

将这些信息放到手册中会很好。可惜它不起作用,减价和结构doxygen的组合会非常有用 - 这就是为什么我们最初选择doxygen的任务。 – Cheeseminer

+0

如果您可以在错误跟踪器(https://bugzilla.gnome.org/enter_bug.cgi?product=doxygen)中为此提交一个错误报告,并且您希望看到这个例子有效,那么我将拥有一个看看需要什么来支持这个(或者如果结果太困难,请在手册中添加一个注释)。 – doxygen