Does Doxygen @file work in markdown files?

2019-06-07 14:16发布

问题:

I have a problem with a mix of markdown and @file in my .md files that I am processing with Doxygen 1.8.5.

If I use:

# Release Notes

@file releases.md
Release notes

@tableofcontents

@section rel_page Release History

Blah blah blah

I get nothing other than the page title (resulting from the first # line) in the HTML. For completeness, this happens with or without the 'releases.md' filename being present (it's optional according to the manual).

However, if I remove the @file line...

# Release Notes

@tableofcontents

@section rel_page Release History

Blah blah blah

It all works perfectly.

Have I got the syntax wrong, is @file not supported as part of Doxygen's markdown support, or is this a bug?

There's nothing in the Doxygen manual in either the @file or markdown sections about any constraints.

There's some similarity with my other (tumbleweed) question about markdown and groups.

回答1:

The commands listed in the section structural indicators in the manual do not work with markdown. You can get the effect of using @file as follows:

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

@tableofcontents

@section rel_page Release History

Blah blah blah