Как я могу включить doxygen perlmod в мой perlscript? - PullRequest
Новая
       5

Как я могу включить doxygen perlmod в мой perlscript?

1 голос
/ 28 октября 2010

Как я могу включить doxygen perlmod в свой perlscript?

Я заметил, что вы можете создать альтернативный вывод с помощью doxygen, который называется perlmod, но я не могу найти примеров того, как его использоватьpart.

Я нашел там 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 и latex, и в 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 Ответ

1 голос
/ 28 октября 2010

Вы имеете в виду perlpod ? Это скорее стандарт Perl, чем Doxygen. Он может выводить простой текст, HTML или nroff (с помощью инструментов pod2text, pod2html и pod2man) Почему бы тебе не использовать это вместо этого?

...