Beefy Boxes and Bandwidth Generously Provided by pair Networks
Do you know where your variables are?
 
PerlMonks  

comment on

( [id://3333]=superdoc: print w/replies, xml ) Need Help??
There are two ways that your module could be using another module.
  1. It directly uses that modules functionality, like Carp or CGI or Exporter. This could either be through function calls or an @ISA relationship.
  2. It is passed an object of a given class.
In the first case, where a user of your module would expect that this given functionality be there automatically, then I would put a use in your module and document that your module depends on other modules being installed.

In the second case, I would not do a use on that module, because you're not actually instantiating that object, but are being given the object. The use has to have already been done for the object to be given to you.

Your initial questions on POD can be answered at perlpod and by reading a number of the submissions in the Code Catacombs.

I'd also like to commend you for actually taking the time to consider these issues. ++!

------
We are the carpenters and bricklayers of the Information Age.

Vote paco for President!


In reply to Re: Documenting a Module by dragonchild
in thread Documenting a Module by jlongino

Title:
Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post; it's "PerlMonks-approved HTML":



  • Are you posting in the right place? Check out Where do I post X? to know for sure.
  • Posts may use any of the Perl Monks Approved HTML tags. Currently these include the following:
    <code> <a> <b> <big> <blockquote> <br /> <dd> <dl> <dt> <em> <font> <h1> <h2> <h3> <h4> <h5> <h6> <hr /> <i> <li> <nbsp> <ol> <p> <small> <strike> <strong> <sub> <sup> <table> <td> <th> <tr> <tt> <u> <ul>
  • Snippets of code should be wrapped in <code> tags not <pre> tags. In fact, <pre> tags should generally be avoided. If they must be used, extreme care should be taken to ensure that their contents do not have long lines (<70 chars), in order to prevent horizontal scrolling (and possible janitor intervention).
  • Want more info? How to link or How to display code and escape characters are good places to start.
Log In?
Username:
Password:

What's my password?
Create A New User
Domain Nodelet?
Chatterbox?
and the web crawler heard nothing...

How do I use this?Last hourOther CB clients
Other Users?
Others surveying the Monastery: (5)
As of 2024-04-16 06:12 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found