Re: Documenting non-public OO components

[japhy]

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.

[creamygoodness]

How would you label a helper/devel class? Here's one technique I've seen:

=head1 SYNOPSIS

No public interface

However, it would be nice to put something in the SYNOPSIS section, even for a devel class. PRIVATE SYNOPSIS / PUBLIC SYNOPSIS ?

[japhy]

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.