Yes! Do continue to develop this. ANY contribution to documentation either for yourself or others is certainly a step in the right direction. While I see that your output is POD, you might want to think about other possibilities in addition. At the moment, I am re-writing one of my CPAN modules in Lisp. The dialect I'm using (newLISP) uses a comment embedded mini-language to produce a nicely formatted html page. You might try the same. If you do then I would point out that perltidy can output formatted and colored html text given functions as input; and of course this could be folded back into the documentation. All of this could be kept within the source file; something that could prevent the drift between source and documentation. Enough babble. Go for it. --hsm

--hsm

"Never try to teach a pig to sing...it wastes your time and it annoys the pig."

In reply to Re: Using PPI to document existing modules by hsmyers
in thread Using PPI to document existing modules by AK108

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.