Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shred/ooperldoc
API documentation generator for Perl source codes
https://github.com/shred/ooperldoc
documentation-tool perl unmaintained
Last synced: 4 days ago
JSON representation
API documentation generator for Perl source codes
- Host: GitHub
- URL: https://github.com/shred/ooperldoc
- Owner: shred
- Created: 2014-10-28T22:38:52.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2016-01-23T13:25:58.000Z (almost 9 years ago)
- Last Synced: 2024-12-25T19:49:54.304Z (12 days ago)
- Topics: documentation-tool, perl, unmaintained
- Language: Perl
- Homepage:
- Size: 32.2 KB
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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](http://search.cpan.org/~jred/CIPP/) extensions.
* It is Free Software, published under GNU General Public Licence.
## Documentation
See [here](./ooperldoc.txt).
## Licence
`OOPerlDoc` is distributed under GPL ([Gnu Public Licence](http://www.gnu.org/licenses/gpl.html)).
## 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](http://www.dimedis.de), gave me the permission to publish this work as open software. Thanks!