如何使用Doxygen和Doxygen :: Filter :: Perl为Perl子例程生成文
发布时间:2020-12-15 23:25:57 所属栏目:大数据 来源:网络整理
导读:我试图弄清楚如何使用 Doxygen::Filter::Perl 生成Perl文件的文档.我从一个非常简单的文件开始,看看我是否可以让它工作(test_doxygen.pl): #! /usr/bin/env perl#** @file test_doxygen.pl# @brief Testing Doxygen using Doxygen::Filter::Perl## Descript
我试图弄清楚如何使用
Doxygen::Filter::Perl 生成Perl文件的文档.我从一个非常简单的文件开始,看看我是否可以让它工作(test_doxygen.pl):
#! /usr/bin/env perl #** @file test_doxygen.pl # @brief Testing Doxygen using Doxygen::Filter::Perl # # Description of the purpose of this file # # @author H?kon H?gland (hakon.hagland@gmail.com) # # @bug No known bugs. # #* #** @class main # The main class #* use strict; use warnings; my $b = add_one(1); #** @function public add_one ($par1) # @brief A brief description of the function # # A detailed description of the function # @params $par1 required A number # @retval value Input value plus one1 #* sub add_one { my ($par1) = @_; return $par1 + 1; } 然后我安装了Doxygen :: Filter :: Perl并使用了metacpan.org上的软件包维护者提供的Doxyfile配置文件(the link is here) 我使用的是Ubuntu 14.04,所以我用sudo apt-get install doxygen安装了Doxygen,(我还需要安装graphviz:sudo apt-get install graphviz)然后我终于运行了 $doxygen 从终端窗口.生成的HTML文件doc / html / index.html包含有关文件和作者的文档,但它不包含add_one子例程的任何文档. 我在这里错过了什么? 更新 以下是Chromium浏览器中类视图的外观: 如图所示,add_one子例程没有引用/链接. 这是文件视图: 解决方法
所以问题在于处理“我的”变量声明.它将值设置为私有:doxygen永远不会回来.我已经在Perl.pm中添加了一行来修复它,它现在应该适合你.由于您使用的是pl文件而不是pm文件,因此我还对Doxyfile进行了更改,因此您需要从分发中获取新文件.我已经向Github和CPAN发布了1.71,并用您的确切示例对其进行了测试.
(编辑:李大同) 【声明】本站内容均来自网络,其相关言论仅代表作者个人观点,不代表本站立场。若无意侵犯到您的权利,请及时与联系站长删除相关内容! |