dev:proposal:perl_module_documentation
This is an old revision of the document!
Table of Contents
Galecia Documentation Proposal
Summary
The Galecia documentation will primarily focus on adding documentation to the OpenSRF framework of Evergreen. Many of the registered OpenSRF methods are incompletely documented or not documented at all. This effort will fully document the proposed sections of code. The documentation effort also includes in-line documentation at the developer’s discretion.
Action
All OpenSRF methods will be fully documented. In-line documentation will follow the ASCIIdocs formatting standard. Full OpenSRF documentation and in-line commenting will be added in the following Perl modules:
Actor
- ClosedDates.pm
- Container.pm
- Friends.pm
- Stage.pm
- UserGroups.pm
Cat
- AssetCommon.pm
- AuthCommon.pm
- Authority.pm
- BibCommon.pm
- Merge.pm
Search
- AddedContent.pm
- Authority.pm
- Biblio.pm
- CNBrowse.pm
- Serial.pm
- Z3950.pm
- Zips.pm
OpenSRF documentation includes adding any or all of the required fields to complete the method registration.
- Signature
- Params
- Return
- Argc
- Package
- Api_name
- Method
Deliverable
- Fully documented OpenSRF methods for all Perl modules as outlined under “Actions”.
- In-line documentation for all sub routines in the Perl modules outlined under “Actions”.
dev/proposal/perl_module_documentation.1348509248.txt.gz · Last modified: 2022/02/10 13:34 (external edit)