User Tools

Site Tools


dev:proposal:perl_module_documentation

Galecia Documentation Proposal

Summary

The Galecia documentation will primarily focus on adding documentation to the Evergreen Perl modules which Catalyst has been involved with through KCLS. Many of these modules are incompletely documented or not documented at all. This effort will add a considerable level of documentation to the proposed sections of code.

Action

The following Perl modules will be fully documented. In-line documentation will follow the POD formatting standard.

Application

  • Search.pm
  • AddedContent.pm
  • Authority.pm
  • Biblio.pm
  • CNBrowse.pm
  • Serial.pm
  • Z3950.pm
  • Zips.pm
Storage
  • Metabib.pm
  • QueryParser.pm
  • /Driver/Pg/QueryParser.pm

WWW

  • EGCatLoader.pm

Deliverable

  1. Fully documented Perl modules as outlined under “Actions”.
  2. In-line documentation for all sub routines in the Perl modules outlined under “Actions”.
dev/proposal/perl_module_documentation.txt · Last modified: 2022/02/10 13:34 by 127.0.0.1

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki

© 2008-2022 GPLS and others. Evergreen is open source software, freely licensed under GNU GPLv2 or later.
The Evergreen Project is a U.S. 501(c)3 non-profit organization.