如何描述具有doxygen-markdown风格的文件头

时间:2018-04-05 05:56:40

标签: markdown doxygen

我在Doxygen项目的markdown中编写代码样式指南,并且必须描述新文件中需要哪些信息。我想举一个文件头的例子。但是我没有得到这个例子。

我想要的是什么:

/**
 * @file
 * @brief Provides ...
 * @copyright ...
 */

我明白了:

/**
 * 

我尝试了一些事情,例如屏蔽部分/全部*\。我已经使用~~~```进行了尝试。 <pre>...</pre><code>...</code>以及所有这些变体,但没有成功。

Doxyfile与通过doxygen -s -g生成的默认文件没有太大区别:

+PROJECT_NAME = "Coding Guidlines" -PROJECT_NAME = "My Project" PROJECT_NUMBER = PROJECT_BRIEF = PROJECT_LOGO = @@ -171,7 +171,7 @@ INPUT_FILTER = FILTER_PATTERNS = FILTER_SOURCE_FILES = NO FILTER_SOURCE_PATTERNS = +USE_MDFILE_AS_MAINPAGE = introduction.md -USE_MDFILE_AS_MAINPAGE = #--------------------------------------------------- # Configuration options related to source browsing #--------------------------------------------------- @@ -231,7 +231,7 @@ QHG_LOCATION = GENERATE_ECLIPSEHELP = NO ECLIPSE_DOC_ID = org.doxygen.Project DISABLE_INDEX = NO +GENERATE_TREEVIEW = YES -GENERATE_TREEVIEW = NO

使用的doxygen版本为1.8.14。 Doxyfile和testfile在同一目录中。

有人可以帮助我吗?

0 个答案:

没有答案