NAME

Perl::ModuleInfo - Extract documentation and test cases from a properly annotated file

SYNOPSIS

  use Perl::ModuleInfo;
  my $info = Perl::ModuleInfo->new();
  $info->parse('./lib', 'Local/Example.pm');
  $info->parse('./lib', 'Local/Sample.pm');

EXPORTS

Nothing exported by default

DEPENDENCIES

This module requires these other modules and libraries:

    Perl::Util
    Error::Logical
    Error::Programatic
    Perl::Module
    Data::Hub::FileSystem::File
    Data::Hub::Util
    Data::Hub::Container
    Perl::Class

DESCRIPTION

Extract documentation and test cases from a properly annotated file.

Shortcut POD annotations:

These =pod annotations must begin the line with no leading white space.

  =pod:summary        The part which comes after the package NAME
  =pod:synopsis       The SYNOPSIS section
  =pod:description    The DESCRIPTION section
  =pod:seealso        The SEE ALSO section
  =pod:sub            Documentation for a subroutine

Example:

  package Local::Example;
    
  # say_hello - Print a greeting
  # The normal way to document a method
  sub say_hello {
    printf "%s\n", 'Hello';
  }
    
  sub say_goodbye {
    printf "%s\n", 'Goodbye';
  }
    
  1;
    
  =pod:summary
    
    An example module
    
  =pod:synopsis
    
    use Local::Example;
    
  =pod:description
    
  This example module does nothing of interest.
    
  =pod:seealso
    
  The L<Perl::ModuleInfo> module
    
  =pod:sub say_goodbye - Print a parting
    
  Another way to write the documentation for a method.
    
  =cut

Test cases:

For test written with POD annotations =test and =result, the =result body must begin with two and only two spaces. Any additional leading spaces are considered part of the actual test result.

AUTHORS

    Ryan Gies <ryangies@cpan.org>

COPYRIGHT

    Copyright (C) 2014-2016 by Ryan Gies. All rights reserved.
    Copyright (C) 2006-2013 by Livesite Networks, LLC. All rights reserved.
    Copyright (C) 2000-2005 by Ryan Gies. All rights reserved.
    Redistribution and use in source and binary forms, with or without 
    modification, are permitted provided that the following conditions are met:
    * Redistributions of source code must retain the above copyright notice, 
    this list of conditions and the following disclaimer.
    * The origin of this software must not be misrepresented; you must not 
    claim that you wrote the original software. If you use this software in a 
    product, an acknowledgment in the product documentation would be 
    appreciated but is not required.
    * Altered source versions must be plainly marked as such, and must not be 
    misrepresented as being the original software.
    * The name of the author may not be used to endorse or promote products 
    derived from this software without specific prior written permission.

    THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR IMPLIED 
    WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 
    MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO 
    EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 
    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT 
    OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
    INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
    CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 
    IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY 
    OF SUCH DAMAGE.
    To the best of our knowledge, no patented algorithms have been used. However, we
    do not have the resources to carry out a patent search, and therefore cannot 
    give any guarantee of the above statement.