Assembly Doxygen和assembler源文件,带有单独的文档头
我正试图想出一种使用Doxygen来记录纯汇编源文件的方法。一种方法是使用Doxygen的代码块创建头文件,并让Doxygen解析头文件,而不是解析程序集源代码 问题是,我得到了Assembly Doxygen和assembler源文件,带有单独的文档头,assembly,doxygen,Assembly,Doxygen,我正试图想出一种使用Doxygen来记录纯汇编源文件的方法。一种方法是使用Doxygen的代码块创建头文件,并让Doxygen解析头文件,而不是解析程序集源代码 问题是,我得到了警告:没有声明或定义文档化符号NVMLIB\U Close。错误,显然文档中没有这些元素 所以我的问题是:如何强制Doxygen包含所有文档化的成员,即使我在代码中找不到它们 我试着寻找,但这说明在2006年是不可能的 创建虚拟函数头的简单解决方案是dealbreaker,我不能这样做。它使汇编函数看起来像C函数,而事实
警告:没有声明或定义文档化符号NVMLIB\U Close。
错误,显然文档中没有这些元素
所以我的问题是:如何强制Doxygen包含所有文档化的成员,即使我在代码中找不到它们
我试着寻找,但这说明在2006年是不可能的
创建虚拟函数头的简单解决方案是dealbreaker,我不能这样做。它使汇编函数看起来像C函数,而事实并非如此
我也看不出过滤器脚本在这里有什么帮助,因为问题不在于ASM语法,而在于缺少至少一个原型。创建一个虚假的原型也是不可能的(请参见上面的评论)
Doxyfile:
PROJECT_NAME = "Doxygen as an assembly documentation tool"
PROJECT_BRIEF = "Will it work?"
OUTPUT_DIRECTORY = doc_out
INPUT = test.h
GENERATE_TREEVIEW = YES
GENERATE_RTF = NO
GENERATE_LATEX = NO
GENERATE_TAGFILE = tags.txt
OPTIMIZE_OUTPUT_FOR_C = YES
ALIASES += "registermods=\par Register mods^^"
ALIASES += "clockcycles=\par Clock Cycles^^"
ALIASES += "assumptions=\par Assumptions^^"
测试h
/**
* \file test.h
* \brief Simple test
*
* ------------------------------------------------------------------------- */
/**
\fn NVMLIB_Initialize
\brief Initialize the NVM library.
\param[in] b1 SPI speed; use SPI_CLK_PRESCALE_* define
\registermods b1, x1
\assumptions The sources for the SPI interface pads have been configured
\clockcycles Not applicable
*/
/**
\fn NVMLIB_Close
\brief Close the NVM library.
\registermods None
\assumptions None
\clockcycles 6
*/
也被要求加入,但解决方案是添加虚假的原型
这篇文章是相关的,但没有答案:
谢谢 这仍然是不可能的,我认为这里给出的答案“在代码中放置虚拟头”仍然有效。感谢您的回答,但正如我所说的,添加虚拟原型对我来说不是一个选项,我宁愿破解Doxygen的解析器。这仍然是不可能的,我认为这里给出的答案是“在代码中放置虚拟头”仍然有效。感谢您的回答,但正如我所说的,添加虚拟原型对我来说不是一个选项,我宁愿破解Doxygen的解析器。