Beefy Boxes and Bandwidth Generously Provided by pair Networks
Perl: the Markov chain saw
 
PerlMonks  

Re: Documenting non-public OO components

by xdg (Monsignor)
on Sep 06, 2005 at 16:14 UTC ( #489583=note: print w/replies, xml ) Need Help??


in reply to Documenting non-public OO components

Read the docs for Pod::Coverage. You can easily specify additional items to consider private and not needing coverage with also_private. If you don't want to take that extra step, just document them as public or private in the pod, either inline -- or better yet -- in sections marked "PUBLIC METHODS", "PRIVATE METHODS" etc.

-xdg

Code written by xdg and posted on PerlMonks is public domain. It is provided as is with no warranties, express or implied, of any kind. Posted code may not have been tested. Use of posted code is at your own risk.

Replies are listed 'Best First'.
Re^2: Documenting non-public OO components
by creamygoodness (Curate) on Sep 06, 2005 at 16:36 UTC
    in sections marked "PUBLIC METHODS", "PRIVATE METHODS"

    This, I like. :)

    I will be adopting your suggestion. It solves 90% of the problem, since methods occupy most of the protected/package OO terrain.

    --
    Marvin Humphrey
    Rectangular Research ― http://www.rectangular.com

Log In?
Username:
Password:

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

How do I use this? | Other CB clients
Other Users?
Others chilling in the Monastery: (2)
As of 2022-12-03 23:37 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found

    Notices?