some sample docs

[Wade Hampton <whampton@staffnet.com>]

I finally got the CVS archive and looked at the PHP3 -- 
looks like some great stuff there.  

One of the things I always do when I first get involved with
other's code is to do some docs -- great way to learn the code
before changing it....

I tend toward rather formal documentation having worked on some
large projects (and still maintain a system I wrote nearly 15 
years ago on a XENIX box).   I have a sample module header, 
class header, procedure (function) header, and 
an example of a re-documented module.  See the attached.

Any comments are welcomed.  I could start documenting some of the
code if what I am doing looks good.  

If there are performance problems with a lot of docs in php3, I would
suggest having them in the source, but stripping the docs prior
to installing them on the running system.  This could also be
used to strip blank lines, extra spaces, etc. to create an 
optimized version?????

Cheers,
-- 
W. Wade, Hampton  <whampton@staffnet.com>  

Linux is new, it's come out of nowhere, it's free. Hard to beat that 
price. And it's taking marketshare left and right.  

--Microsoft's lawyer, in closing argument, Bristol v. Microsoft,
http://www.microsoft.com/presspass/bti/07-15closing.htm

docsample.tgz