2010-10-27 75 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工具)。你爲什麼不使用它呢?

相關問題