I've written simple Perl bindings to a C++ library using XS++ and Module::Build::WithXSpp. The XS++ code is a single file that defines six classes - nothing fancy, just 80 lines of class and method definitions that directly mirror the C++ API.

My question regards how best to document the distribution using POD. The upper namespace is 'Compress::DSRC'. I currently have a single, auto-generated 'Compress/DSRC.pm' that loads the XS and contains skeleton POD, and clearly I can add documentation here (I've seen POD in XS). However, the classes that users will actually use are e.g. 'Compress::DSRC::Reader' or 'Compress::DSRC::Writer'. Should I create '*.pm' files for each class that contain nothing but POD (other than package declaration, etc?) or is there an acceptable way to document each class within the single 'Compress/DSRC.pm' file?

In reply to Organizing POD for an XS++ module by jdv

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


  • Posts are HTML formatted. Put <p> </p> tags around your paragraphs. Put <code> </code> tags around your code and data!
  • Titles consisting of a single word are discouraged, and in most cases are disallowed outright.
  • Read Where should I post X? if you're not absolutely sure you're posting in the right place.
  • Please read these before you post! —
  • Posts may use any of the Perl Monks Approved HTML tags:
    a, abbr, b, big, blockquote, br, caption, center, col, colgroup, dd, del, details, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, ins, li, ol, p, pre, readmore, small, span, spoiler, strike, strong, sub, summary, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr
  • You may need to use entities for some characters, as follows. (Exception: Within code tags, you can put the characters literally.)
            For:     Use:
    & &amp;
    < &lt;
    > &gt;
    [ &#91;
    ] &#93;
  • Link using PerlMonks shortcuts! What shortcuts can I use for linking?
  • See Writeup Formatting Tips and other pages linked from there for more info.