Re^2: Documenting non-public OO components

by creamygoodness (Curate)

on Sep 06, 2005 at 16:46 UTC ( [id://489605]=note: print w/replies, xml )

Need Help??

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

Comment on Re^2: Documenting non-public OO components Download Code

Replies are listed 'Best First'.
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]

In Section Meditations

Domain Nodelet^?

Node Status^?

node history
Node Type: note [id://489605]
help

Chatterbox^?

How do I use this? • Last hour • Other CB clients

Other Users^?

Others surveying the Monastery: (5)

As of 2024-04-20 00:00 GMT

Sections^?

Information^?

Find Nodes^?

Leftovers^?

Voting Booth^?

No recent polls found