如何在perlscript中包含doxygen perlmod?

时间:2010-10-27 20:12:38

标签: perl doxygen

如何在perlscript中包含doxygen perlmod?

我注意到你可以生成一个名为perlmod的doxygen替代输出, 但我找不到任何关于如何使用这部分的例子。

我在DoxyDocs.pm和DoxyStructure.pm中找到了2个不错的文件, 它们包含一些代表源代码的漂亮结构 (它看起来像一个数组/哈希码)。

但是由于我的“高级perl”有点生疏,我在开始使用这个小想法时遇到了问题......

有人可以帮我推动正确的方向吗?

由于 约翰


我应该使用-I来perl并“使用”那些.pm?

#!/usr/bin/perl -Icode/doc/perlmod/

use strict;
use warnings;

use DoxyStructure;
use DoxyDocs;

或者我应该以其他方式包含这些文件?也许是这样的?但问题是我无法启用严格和警告,因为我得到了错误...

#!/usr/bin/perl 

#use strict;
#use warnings;

require "code/doc/perlmod/DoxyDocs.pm";

更新

为了在Doxygen中启用perlmod,我在Doxyfile中使用这些标志将其打开:

# If the GENERATE_PERLMOD tag is set to YES Doxygen will
# generate a Perl module file that captures the structure of
# the code including all documentation. Note that this
# feature is still experimental and incomplete at the
# moment.

GENERATE_PERLMOD       = YES

# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
# the necessary Makefile rules, Perl scripts and LaTeX code to be able
# to generate PDF and DVI output from the Perl module output.

PERLMOD_LATEX          = YES

然后doxygen在与html和latex one相同的目录中创建一个名为perlmod的新目录,在perlmod中我们找到我尝试使用的列表。

  • perlmod的/ DoxyDocs.pm
  • perlmod的/ doxyformat.tex
  • perlmod的/ doxylatex.pl
  • perlmod的/ doxylatex-structure.pl
  • perlmod的/ doxylatex.tex
  • perlmod的/ doxyrules.make
  • perlmod的/ DoxyStructure.pm
  • perlmod的/生成文件

1 个答案:

答案 0 :(得分:1)

你的意思是perlpod吗?这比Perxygen更像Perl标准。它可以生成纯文本,HTML或nroff格式的输出(使用pod2textpod2htmlpod2man工具。你为什么不用它呢?