Beefy Boxes and Bandwidth Generously Provided by pair Networks
We don't bite newbies here... much
 
PerlMonks  

Re^3: Documenting non-public OO components

by japhy (Canon)
on Sep 07, 2005 at 12:34 UTC ( #489848=note: print w/replies, xml ) Need Help??


in reply to Re^2: Documenting non-public OO components
in thread Documenting non-public OO components

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
  • Comment on Re^3: Documenting non-public OO components

Log In?
Username:
Password:

What's my password?
Create A New User
Domain Nodelet?
Node Status?
node history
Node Type: note [id://489848]
help
Chatterbox?
and the web crawler heard nothing...

How do I use this? | Other CB clients
Other Users?
Others examining the Monastery: (3)
As of 2022-12-08 03:13 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found

    Notices?