Doxygen处理条件编译

在使用Doxygen生成文档的时候,发现有些内容没有生成。仔细研究程序源代码,发现这部分代码使用了条件编译进行控制,代码如下:

1
2
3
#ifdef HAL_ADC_MODULE_ENABLED
// Code
#endif /* HAL_ADC_MODULE_ENABLED */

而Doxygen是会对宏进行处理的,这样就会跳过这部分代码。
解决方式:在ExpertPreprocessor选项中,找到PREDEFINED,添加需要预定义的宏即可。

使用Doxygen生成高质量代码参考文档

注释和文档是程序的重要组成部分,使用 Doxygen 可以自动将程序中特定格式的注释提取出来,生成一份很漂亮的参考文档。这样只要在编程的时候遵循特定的格式书写注释,程序编好后文档也就自动完成了,不需要专门花时间来写文档,这无疑减少了很多的工作量。

Doxygen支持的语言有很多,常用的有C/C++、Java、Python等;可以生成的文档格式也很丰富,其中以HTML格式和Latex格式最为常用。

关于Doxygen的安装和使用,可参考其官方 参考手册, 这个参考手册本身也是使用Doxygen生成的。网上也可找到很多基础教程,在此不再累述。本文主要介绍在使用C语言编程时该如何写注释,以便使用Doxygen自动生成高质量的文档。

使用JLink为2440 NOR Flash下载程序

以Mini2440开发板为例,通过Jlink将程序下载至NOR Flash中运行。因为CPU可对NOR Flash直接寻址,程序可在NOR Flash中直接运行,故将裸机程序下载至NOR Flash中调试运行较为简单。

使用J-Link Commander和J-Flash ARM均可实现程序下载,不过J-Flash ARM使用起来更为简单直观。

下面总结一下使用J-Flash ARM下载程序的方法。 需要先安装好J-Link驱动,连接好JTAG,并且给目标板上电。2440 OM[1:0]配置为从NOR Flash启动。