OOPerlDoc¶
Features¶
Some OOPerlDoc features:
- Generates JavaDoc like documentations from Perl source codes.
- Field-tested: it is actively used in company range professional development for many years now.
- Supports extensive Object Oriented Perl programming: documents class hierarchies and inherited methods, access scopes, attribute hashes etc.
- Automatically generates cross references and converts URLs to clickable links.
- Optionally allows to integrate the source code with the documentation, creating links to the appropriate part of the source code.
- Only comments are used for document generation, allowing to document even incomplete source codes and first drafts.
- Also documents modules and procedural scripts.
- Has special CIPP extensions (see http://search.cpan.org/~jred/CIPP/).
- It is Free Software, published under GNU General Public Licence.
Usage¶
Development¶
Licence¶
OOPerlDoc is distributed under GPL (Gnu Public Licence).
Kudos¶
I have developed OOPerlDoc in the scope of my job. Even though it was primary made for internal documentation purposes, OOPerlDoc was designed for a broad Perl developer audience. Eventually Mr. Halling, CEO of Dimedis GmbH, gave me the permission to publish this work as open software. Thanks!