I have some 36 Perl modules to document, with one subroutine in them each. This particular project is for my use only, but it should be documented for my sanity (and so Devel::Cover likes me better).

I was planning on adding stub documentation automatically, but then I realized I could have it prompt me for the documentation. This code tries to see if a subroutine is already documented, but not with Pod::Coverage.

If nothing else like this exists and there is sufficient interest, I might expand it into a real module to help build documentation.

Warning: This code does not make backup copies.

#!/usr/bin/perl

use strict;
use warnings;
use PPI;

foreach my $filename (@ARGV) {
    print "Opening up $filename...\n";
    my $doc = PPI::Document->new($filename);
    foreach my $sub (@{$doc->find('PPI::Statement::Sub')}) {
        my $subname = $sub->name;
        my $previous = $sub->previous_sibling;
        $previous = $previous->previous_sibling while $previous && !$p
+revious->isa('PPI::Token::Pod');

        if($previous && $previous->isa('PPI::Token::Pod') && $previous
+->{'content'} =~ /=(?:head\d|item)\s+$subname/i) {
            print "skipping $subname; already documented\n";
            next;
        }
        my $pod = PPI::Token::Pod->new;
        print "Enter documentation for $subname (ctrl+D when done, lea
+ve blank to skip):\n";
        my $text = join '', <STDIN>;
        $text =~ s/^\n+|\n+$//g;
        unless($text) {print "skipping $subname; no text provided"; ne
+xt}
        $pod->{'content'} = "=head2 $subname()\n\n$text\n\n=cut\n\n";
        $sub->insert_before($pod);
    }
    print "Writing code to $filename...\n";
    $doc->save($filename);
#     print $doc->serialize;
}

[download]

In reply to 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.