EnsEMBL::Web::Tools::Document::Module

Methods

DESTROY
Desctructor.
View source
EnsEMBL::Web::Tools::Document::Module::DESTROY


_parse_package_file
Opens and parses Perl package files for methods and comments in e! doc format.
View source
EnsEMBL::Web::Tools::Document::Module::_parse_package_file


add_method
Adds a method name to the method array.
View source
EnsEMBL::Web::Tools::Document::Module::add_method


add_subclass
Adds a subclass to the subclass array.
View source
EnsEMBL::Web::Tools::Document::Module::add_subclass


add_superclass
Adds a superclass to the inheritance array.
View source
EnsEMBL::Web::Tools::Document::Module::add_superclass


all_methods
returns all methods from this class, and its superclasses.
View source
EnsEMBL::Web::Tools::Document::Module::all_methods


convert_keyword
Accepts a single abbreviation and returns its long form. This method is called on all lines that contain a single word, and replaces shorcuts with longer descriptions. For example, 'a' is elongates to 'accessor'. Keywords can be specified using {keyword}.
View source
EnsEMBL::Web::Tools::Document::Module::convert_keyword


coverage
Calculates and returns the documentation coverage for all callable methods in a module. This includes any inherited methods. Use module_coverage to calculate the documentation coverage for a module's methods only.
View source
EnsEMBL::Web::Tools::Document::Module::coverage


find_methods
Scans package files for method definitions, and creates new method objects for each one found. Method object references are stored in the methods array.
View source
EnsEMBL::Web::Tools::Document::Module::find_methods


identifier
Accessor.
View source
EnsEMBL::Web::Tools::Document::Module::identifier


inheritance
Accessor.
View source
EnsEMBL::Web::Tools::Document::Module::inheritance


keywords
Accessor. Accepts a string with key-value pairings, a la qw(). For example: 'a accessor c constructor d destructor'.
View source
EnsEMBL::Web::Tools::Document::Module::keywords


lines
Accessor.
View source
EnsEMBL::Web::Tools::Document::Module::lines


location
Accessor.
View source
EnsEMBL::Web::Tools::Document::Module::location


methods
Accessor.
View source
EnsEMBL::Web::Tools::Document::Module::methods


methods_of_type
types. Includes methods inherited from superclasses.Returns all methods of a particular type. Useful when used with
View source
EnsEMBL::Web::Tools::Document::Module::methods_of_type


module_coverage
Calculates and returns the documentation coverage for a module's methods. This does not include inherited methods (see coverage).
View source
EnsEMBL::Web::Tools::Document::Module::module_coverage


name
Accessor.
View source
EnsEMBL::Web::Tools::Document::Module::name


new
Constructor. Inside-out class for representing Perl modules.
View source
EnsEMBL::Web::Tools::Document::Module::new


overview
Accessor.
View source
EnsEMBL::Web::Tools::Document::Module::overview


overview_documentation
Accessor.
View source
EnsEMBL::Web::Tools::Document::Module::overview_documentation


subclasses
Accessor.
View source
EnsEMBL::Web::Tools::Document::Module::subclasses


superclass
Convenience accessor for inheritance
View source
EnsEMBL::Web::Tools::Document::Module::superclass


types
Returns an array of all types of methods.
View source
EnsEMBL::Web::Tools::Document::Module::types