• NAME
• DESCRIPTION
• PROPERTIES
  • name
  • oLocationDocumented
  • oDocument
  • signature
• API METHODS
  • new(oDocument, name)
  • signatureCall($oLocationDeclaration)
• AUTHOR
• BUGS
• ACKNOWLEDGEMENTS
• COPYRIGHT & LICENSE

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.