Beefy Boxes and Bandwidth Generously Provided by pair Networks
Think about Loose Coupling

Re: On providing documentation with your modules

by gmpassos (Priest)
on Apr 17, 2004 at 16:54 UTC ( #345986=note: print w/replies, xml ) Need Help??

in reply to On providing documentation with your modules

If you can make an automatic insertion of the BASS docs into the POD of your module you could duplicate the data. But if this can't be automatic you should just point to an URL.

In your POD you could add only some simple example, or informations about what is the module and some differences between your interface and the BASS interface, since they are in different languages. You says that wxPerl don't need POD, well, it needs, not about the classes that it wrappes, but about the way that it wrappes.

Graciliano M. P.
"Creativity is the expression of the liberty".

  • Comment on Re: On providing documentation with your modules

Log In?

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

How do I use this? | Other CB clients
Other Users?
Others surveying the Monastery: (7)
As of 2016-10-26 07:37 GMT
Find Nodes?
    Voting Booth?
    How many different varieties (color, size, etc) of socks do you have in your sock drawer?

    Results (336 votes). Check out past polls.