-
-
30 Aug 2019 08:12:04 UTC
- Distribution: Devel-PerlySense
- Module version: 0.0221
- Source (raw)
- Browse (raw)
- Changes
- How to Contribute
- Issues (5)
- Testers (87 / 110 / 0)
- Kwalitee
Bus factor: 1- % Coverage
- License: perl_5
- Activity
24 month- Tools
- Download (433.75KB)
- MetaCPAN Explorer
- Permissions
- Subscribe to distribution
- Permalinks
- This version
- Latest version
- Dependencies
- App::Ack
- Cache::Cache
- Cache::FileCache
- Carp
- Cwd
- Data::Dumper
- Digest::SHA
- Exporter
- File::Basename
- File::Find
- File::Find::Rule
- File::Path
- File::Slurp
- File::Spec::Functions
- File::chdir
- Getopt::Long
- Graph::Easy
- HTTP::Date
- IO::String
- List::AllUtils
- List::MoreUtils
- List::Util
- Module::Pluggable
- Module::Runtime
- Moo
- POSIX
- PPI
- PPI::Document
- PPI::Dumper
- Params::Util
- Path::Class
- Path::Tiny
- Perl::Critic
- Perl::Tidy
- Pod::Text
- Pod::Usage
- Spiffy
- Storable
- Sub::Exporter
- Text::Table
- Time::HiRes
- Tree::Parser
- YAML::Tiny
- base
- lib
- strict
- utf8
- warnings
- Reverse dependencies
- CPAN Testers List
- Dependency graph
NAME
Devel::PerlySense::Document::Api::Method - A method/sub
DESCRIPTION
An Api::Method is a sub name and a location (possibly with a defined row, etc).
The Method has a documentation string and possibly POD.
PROPERTIES
name
The method name
Default: "".
oLocationDocumented
A Document::Location object specifying where the method is documented, or undef if that is unknown.
Default: undef.
oDocument
A PerlySense::Document object specifying in which the method belongs to. This does not have to be the Document where it's declared.
Default: undef.
signature
Return doc string with the signature of the method, according to found documentation, usage, etc.
Readonly.
API METHODS
new(oDocument, name)
Create new Method with $name belonging to $oDocument.
Set oLocationDocumented according to the found documentation.
signatureCall($oLocationDeclaration)
Return doc string with the call signature of the method, according to the $oLocationDeclaration, etc.
The call signature is the signature with a call arrow, either -> or \> .
AUTHOR
Johan Lindstrom,
<johanl@cpan.org>
BUGS
Please report any bugs or feature requests to
bug-devel-perlysense@rt.cpan.org
, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Devel-PerlySense. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.ACKNOWLEDGEMENTS
COPYRIGHT & LICENSE
Copyright 2005 Johan Lindstrom, All Rights Reserved.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
Module Install Instructions
To install Devel::PerlySense, copy and paste the appropriate command in to your terminal.
cpanm Devel::PerlySense
perl -MCPAN -e shell install Devel::PerlySense
For more information on module installation, please visit the detailed CPAN module installation guide.