Automatically generate pod sections that detail inherited methods with this software tool. This feature simplifies documentation writing, offering programmers an easier way to document code without duplicating effort.
If you're tired of creating module distributions with base classes and dependencies, and you're having trouble finding the POD documentation for the various methods, Pod::Inherit is the Perl module for you. With its ability to produce inheritable documentation, Pod::Inherit auto-discovers the methods each class provides, locates the actual class in which the method is defined, and produces a list in pod.
When you use Pod::Inherit, resulting documentation is written out to a separate .pod file for each class (.pm) encountered. The new file contains the original POD from the Perl Module file, as well as a section called INHERITED METHODS. The new section lists each class that the current class inherits from, plus each method that can be used in the current class as a result. By default, methods beginning with an underscore (_) are skipped, as these are private methods.
To use Pod::Inherit, simply provide a list of input files or directories (default: @ARGV), and it will do the rest. You can also customize your configuration by specifying an output directory, setting skip_underscored to true, and mapping specific class relationships.
In summary, Pod::Inherit is a powerful tool for creating easy-to-use module distributions with inheritable POD documentation. Whether you're a seasoned Perl developer or just getting started, it's definitely worth checking out.
When you use Pod::Inherit, resulting documentation is written out to a separate .pod file for each class (.pm) encountered. The new file contains the original POD from the Perl Module file, as well as a section called INHERITED METHODS. The new section lists each class that the current class inherits from, plus each method that can be used in the current class as a result. By default, methods beginning with an underscore (_) are skipped, as these are private methods.
To use Pod::Inherit, simply provide a list of input files or directories (default: @ARGV), and it will do the rest. You can also customize your configuration by specifying an output directory, setting skip_underscored to true, and mapping specific class relationships.
In summary, Pod::Inherit is a powerful tool for creating easy-to-use module distributions with inheritable POD documentation. Whether you're a seasoned Perl developer or just getting started, it's definitely worth checking out.
What's New
Version 0.07: N/A