2010-10-27 49 views
1

我如何在我的perlscript中包含doxygen perlmod?我如何在我的perlscript中包含doxygen perlmod?

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

我发现2个漂亮的文件中有DoxyDocs.pm和DoxyStructure.pm, 它们包含某种很好的结构表示源代码 (和它看起来像一个有些阵列/哈希码)。

但因为我的“先进的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"; 

更新

为了使perlmod的在Doxygen的我,打开开关这些标志在的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创建一个名为perlmod的在同一目录中的HTML和乳胶一个新的目录,并在perlmod的我们找到我尝试使用的列表。

  • perlmod的/ DoxyDocs.pm
  • perlmod的/ doxyformat.tex
  • perlmod的/ doxylatex.pl
  • perlmod的/ doxylatex-structure.pl
  • perlmod的/ doxylatex.tex
  • perlmod的/ doxyrules.make
  • perlmod的/ DoxyStructure.pm
  • perlmod/Makefile

回答

1

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

相关问题