通过我的团队,我们创建了需要记录的软件。我发现doxygen似乎是一个很好的程序来做到这一点。虽然我们的编程语言不受支持(RAPID)。
昨天我问过这个问题。阿尔伯特非常友好地提供了正确方向的线索。过滤器应该是正确的方式而不是预处理器。
但是我没有提供RAPID代码的语法,可以在这里找到: http://futurecnc.code.arc.cmu.edu/wp/wp-content/uploads/2011/12/RAPID-Reference-Manual-Instructions.pdf
我找到了有关从doxygen网站创建过滤器的帮助指南。我也找到了由Bert Jordan为perl创建的示例过滤器:
http://www.doxygen.nl/helpers.html
有些问题:
我希望,我现在已经给出了清晰的描述:)
编辑:我正在搜索有关如何创建实际过滤器的信息。 有没有人知道这个的好来源?
答案 0 :(得分:2)
在the helpers section下的doxygen网站上,有一些关于其他语言的过滤器的示例。
我为我的一个项目使用过氧过滤器(在那里没有列出)用于Bash。过滤器非常简单,可能是一个很好的例子。此过滤器位于Anvils github。
本质上它只是一个~130行的sed脚本,将bash转换为do-C可以解析的准C语言。您可以为RAPID编写自己的sed脚本。
您应该使用以下命令将其添加到Doxyfile中:
# Tell doxygen to handle files with sh extension as C files
EXTENSION_MAPPING = sh=C
# Tell doxygen to run sh files through the below sed script
FILTER_PATTERNS = *.sh=MY_PATH/doxygen-bash.sed
通过帮助页面here还有一个python示例。
要理解的主要部分是过滤器可以是您想要编写的任何内容。 Python,sed,shell等.Doxygen只调用你的过滤器,通过它运行代码,你的过滤器应输出Doxygen可以解析的语言。