Re: Documenting non-public OO components

I put my POD at the end of all my code, so I can document things in an order not necessarily found in my code. To this end, I would document the public methods in one group, then the protected in another.

Jeff japhy Pinyan, P.L., P.M., P.O.D, X.S.: Perl, regex, and perl hacker
How can we ever be the sold short or the cheated, we who for every service have long ago been overpaid? ~~ Meister Eckhart

Comment on Re: Documenting non-public OO components

Replies are listed 'Best First'.
Re^2: Documenting non-public OO components by creamygoodness (Curate) on Sep 06, 2005 at 16:46 UTC
How would you label a helper/devel class? Here's one technique I've seen: `=head1 SYNOPSIS No public interface` [download] However, it would be nice to put something in the SYNOPSIS section, even for a devel class. PRIVATE SYNOPSIS / PUBLIC SYNOPSIS ? -- Marvin Humphrey Rectangular Research ― http://www.rectangular.com	[reply] [d/l]
Re^3: Documenting non-public OO components by japhy (Canon) on Sep 07, 2005 at 12:34 UTC
In the synopsis, I would probably be just about as terse as your example; but perhaps a small example would help. I would at least explain the class's purpose in its description, though. Jeff `japhy` Pinyan, P.L., P.M., P.O.D, X.S.: Perl, regex, and `perl` hacker How can we ever be the sold short or the cheated, we who for every service have long ago been overpaid? ~~ Meister Eckhart	[reply]