OODoc

OODoc is an Object Oriented documentation generator.
Download

OODoc Ranking & Summary

Advertisement

  • Rating:
  • License:
  • Perl Artistic License
  • Price:
  • FREE
  • Publisher Name:
  • Mark Overmeer
  • Publisher web site:
  • http://search.cpan.org/~markov/

OODoc Tags


OODoc Description

OODoc is an Object Oriented documentation generator. OODoc is an Object Oriented documentation generator.SYNOPSIS use OODoc; my $doc = OODoc->new(distribution => 'My Name', version => '0.02'); $doc->processFiles(workdir => $dest); $doc->prepare; $doc->create('pod', workdir => $dest); $doc->create('html', workdir => '/tmp/html');OODoc stands for "Object Oriented Documentation": to produce manual-pages in HTML or the usual man-page UNIX format, describing Perl programs. The OO part refers to two things: this module simplifies writing documentation for Object Oriented programs, and at the same time, it is Object Oriented itself: easily extensible.OODoc has been used for small and for very large modules. It can also be used to integrate manual-pages from many modules into one homogeneous set.The documentation syntax can be changed, by configuring the parser or adding a new one. The OODoc::Parser::Markov parser understands POD and has additional logical markup tags. See OODoc::Parser about what each parser needs to support.The output is produced by formatters. The current implementation contains two POD formatters and one HTML formatter. See OODoc::Format.Do not forget to read the DETAILS section, later on this manual-page to get started. Please contribute ideas. Have a look at the main website of this project at http://perl.overmeer.net/oodoc/. That is also an example of the produced output. Requirements: · Perl


OODoc Related Software