Differences

This shows you the differences between two versions of the page.

--- dev:proposal:perl_module_documentation [2012/09/24 13:54] – created acoomes
+++ dev:proposal:perl_module_documentation [2022/02/10 13:34] (current) – external edit 127.0.0.1
@@ Line 1: / Line 1: @@
 ====== 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.
+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 =====
-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:
+The following Perl modules will be fully documented. In-line documentation will follow the POD formatting standard.
-==== Actor ====
+=== Application ===
-  * ClosedDates.pm
-  * Container.pm
-  * Friends.pm
-  * Stage.pm
-  * UserGroups.pm
-==== Cat ====
+  * Search.pm
-  * AssetCommon.pm
+== Search ==
-  * AuthCommon.pm
-  * Authority.pm
-  * BibCommon.pm
-  * Merge.pm
-==== Search ====
   * AddedContent.pm
@@ Line 36: / Line 24: @@
   * Zips.pm
-OpenSRF documentation includes adding any or all of the required fields to complete the method registration.
+== Storage ==
-  * Signature
-  * Params
+  * Metabib.pm
-  * Return
+  * QueryParser.pm
-  * Argc
+  * /Driver/Pg/QueryParser.pm
-  * Package
-  * Api_name
+=== WWW ===
-  * Method
+  * EGCatLoader.pm
 ===== Deliverable =====
-  - Fully documented OpenSRF methods for all Perl modules as outlined under “Actions”.
+  - Fully documented Perl modules as outlined under “Actions”.
   - In-line documentation for all sub routines in the Perl modules outlined under “Actions”.