<?xml version="1.0" encoding="windows-1252"?>
<node id="345939" title="On providing documentation with your modules" created="2004-04-17 01:15:41" updated="2005-08-15 05:48:16">
<type id="120">
perlmeditation</type>
<author id="27919">
Jouke</author>
<data>
<field name="doctext">
When you release a module on CPAN, you provide POD documentation. That has to be one of the first rules of the "CPAN authors club". However: what if your module is just an XS wrapper around an existing C(++) library that is already extensively documented itself?&lt;br /&gt;&lt;br /&gt;
For example, [http://wxperl.sf.net|wxPerl] is a wrapper around [http://www.wxwidgets.org|wxWidgets], which itself is extensively documented. When I started with wxPerl I found it very annoying that I had to use the wxWidgets documentation, because there was no POD documentation on the Perl module itself. However after some time, I began to understand that there was no &lt;b&gt;need&lt;/b&gt; to add POD documentation, because if you were able to read the documenation on one class, you could understand the whole set of documentation. It would just have been overkill&lt;br /&gt;&lt;br /&gt;
Now I'm in the same position Mattia Barbon was in when he started creating wxPerl. I'm creating a wrapper around [http://www.un4seen.com/bass.html|BASS], which will probably appear on CPAN as Audio::BASSXS soon. BASS comes with documentation in Microsoft Help format (CHM), and since it's a Windows DLL (not available on other platforms than Windows), it seems there's no need to provide more documentation.&lt;br /&gt;&lt;br /&gt;
What do &lt;i&gt;you&lt;/i&gt; think? Would it suffice to refer to the CHM documentation that is already in the BASS distribution, or should I copy-and-paste the documentation into POD?
&lt;div class="pmsig"&gt;
&lt;div class="pmsig-27919"&gt;
&lt;br&gt;&lt;br&gt;
&lt;i&gt;Jouke Visser&lt;/i&gt;&lt;br /&gt;
&lt;small&gt;Speaking at the &lt;a href="http://www.oreilly.com/conferences"&gt;2004 O'Reilly Open Source Convention&lt;/a&gt; about &lt;a href="http://www.pvoice.org"&gt;pVoice&lt;/a&gt;
&lt;/small&gt;
&lt;/div&gt;&lt;/div&gt;</field>
</data>
</node>
