我想弄清楚如何使用 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 并使用了
Doxyfile
包维护者在 metacpan.org (the link is here) 上提供的配置文件并将其放在与上述脚本相同的目录中。我在
Doxyfile
中更改了一行: INPUT
的值标签从 lib
更改到空字符串,以便仅在当前目录中搜索源文件..我使用的是 Ubuntu 14.04,所以我使用
sudo apt-get install doxygen
安装了 Doxygen , (我还需要安装 graphviz
: sudo apt-get install graphviz
)然后我终于运行$ doxygen
从终端窗口。生成的 HTML 文件
doc/html/index.html
包含关于文件和作者的文档,但不包含任何关于 add_one
的文档子程序。我在这里想念什么?
更新
以下是 Chromium 浏览器中类 View 的外观:
如所见,没有指向
add_one
的引用/链接。子程序。这是文件 View :
最佳答案
所以问题在于处理“我的”变量声明。它将值设置为私有(private):并且 doxygen 从未返回。我在 Perl.pm 中添加了一行来解决这个问题,它现在应该对你有用。由于您使用的是 pl 文件而不是 pm 文件,因此我还对 Doxyfile 进行了更改,因此您将希望从发行版中获取新文件。我已将 1.71 发布到 Github 和 CPAN,并使用您的确切示例对其进行了测试。
关于perl - 如何使用 Doxygen 和 Doxygen::Filter::Perl 为 Perl 子例程生成文档?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/29033768/