图片缩略图

使用Doxygen与Matlab

version 1.8.0.0 (87.4 KB) by 法布里斯
使用Doxygen自动从Matlab .m文件中提取注释来生成文档

9.2 k下载

更新06年4月2011年

查看许可协议

编者按:这个文件被选为MATLAB中心本周精选

这个包允许您使用Doxygen从Matlab .m文件中自动提取注释来生成文档。

此包提供:
-一个perl脚本(m2cppp .pl),用于过滤.m文件,以便Doxygen能够理解它们
- Doxyfile文件的模板(Doxyfile的配置文件),必须根据代码的位置进行修改
——documentationGuidelines。m,一个描述如何注释代码的.m文件,这样Doxygen就可以提取代码并创建良好的文档
——classDocumentationExample。一个描述类可能注释的。M文件
- Doxygen从两个.m文件(参见Doc/html/index.html)自动生成的所有文档(html格式),其中提供了关于安装和如何编写Doxygen注释的信息。

安装细节:
-你需要安装Doxygen软件(版本1.5.9或更新(测试版本1.7.1))
-你需要安装perl (perl是与Matlab一起提供的,通常位于$matlabroot\sys\perl\win32\bin)
-将DoxygenMatlab.zip解压到C:\DoxygenMatlbab(例如)
-从C:\DoxygenMatlbab目录获取Doxyfile文件,并替换Doxygen提供的默认Doxyfile
-编辑Doxyfile文件(或使用DoxyWizard工具提供的Doxyfile)来修改一些设置:
o EXTENSION_MAPPING = m = c++
o FILTER_PATTERN = * m = C: \ DoxygenMatlbab \ m2cpp.pl
o PERL_PATH=< perl版本>的路径
o INPUT=<您的文档代码所在目录>
o OUTPUT_DIRECTORY=<要生成文档的目录
o STRIP_FORM_PATH=<您的文档代码所在的目录>

Windows用户注意事项:
在某些情况下,.pl文件和perl可执行文件之间的关联没有很好地配置,导致运行doxygen时“Argument must contain filename -1 at C:\DoxygenMatlab\m2cpp.pl line 4”。要解决这个问题,你应该在Windows命令提示符("cmd")中执行以下行:

”assoc . pl = PerlScript
ftype PerlScript=C: Program Files\MATLAB\R2010b\sys\perl\win32\bin\perl.exe % 1% *
(不要忘记在上面的行中用你的路径替换perl.exe文件)

引用作为

法布里斯(2021)。使用Doxygen与Matlab(//www.tianjin-qmedu.com/matlabcentral/fileexchange/25925-using-doxygen-with-matlab), MATLAB中央文件交换。检索

MATLAB版本兼容性
创建R2008a
与任何版本兼容
平台的兼容性
窗户 macOS Linux

社区寻宝

在MATLAB中心找到宝藏,并发现社区如何可以帮助你!

开始狩猎!