next up previous contents
Next: Sample configurations Up: Future enhancements to ProtoWrap Previous: Load balancing extra features   Contents


Perl-style (POD) documentation

ProtoWrap has been designed to be used as a Perl module. Although the author has done his best to have the code thoroughly commented, and commented code is often regarded as the best possible form of documentation among programmers, Perl modules implement a very useful and easy documentation format called POD (Plain Old Documentation), which is written in the same file as the code, and when the module gets installed in the system using the standard Makefile.PL A.1 method gets translated into a standard man page.

Perl programmers often take POD documentation as a starting point to begin using a newly installed module. Thus, most of ProtoWrap modules' blocks of comments should be converted to POD. This step was not yet taken because, as it has been repeated throughout this text, ProtoWrap is presently a proof of concept, and emphasis has been put on making the comments illustrate as clearly as possible the inner working of the module, in order to have as much peer review as possible. The POD code format is not as natural to programmers as regular comments are.


next up previous contents
Next: Sample configurations Up: Future enhancements to ProtoWrap Previous: Load balancing extra features   Contents
Gunnar Wolf
2001-03-12