Skip to content

API documentation generator for Perl source codes

Notifications You must be signed in to change notification settings

shred/ooperldoc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 

Repository files navigation

OOPerlDoc

A tool that generates JavaDoc like documentations from Perl source codes.

Features

Some OOPerlDoc features:

  • 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.
  • It is Free Software, published under GNU General Public Licence.

Documentation

See here.

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!

About

API documentation generator for Perl source codes

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages