-
-
16 Apr 2012 21:20:13 UTC
- Distribution: KinoSearch
- Source (raw)
- Browse (raw)
- Changes
- How to Contribute
- Issues (5)
- Testers (536 / 133 / 8)
- Kwalitee
Bus factor: 0- 85.27% Coverage
- License: perl_5
- Activity
24 month- Tools
- Download (852.87KB)
- MetaCPAN Explorer
- Permissions
- Subscribe to distribution
- Permalinks
- This version
- Latest version
and 1 contributors- Marvin Humphrey <marvin at rectangular dot com>
- Dependencies
- JSON::XS
- Lingua::Stem::Snowball
- Lingua::StopWords
- Parse::RecDescent
- and possibly others
- Reverse dependencies
- CPAN Testers List
- Dependency graph
NAME
Clownfish::Function - Metadata describing a function.
METHODS
new
my $type = Clownfish::Function->new( class_name => 'Crustacean::Lobster::LobsterClaw', # required class_cnick => 'LobClaw', # default: special return_type => $int_type, # required param_list => $param_list, # required micro_sym => 'compare', # required docucomment => $docucomment, # default: undef parcel => 'Crustacean', # default: special exposure => 'public', # default: parcel inline => 1, # default: false );
class_name - The full name of the class in whose namespace the function resides.
class_cnick - The C nickname for the class.
return_type - A Clownfish::Type representing the function's return type.
param_list - A Clownfish::ParamList representing the function's argument list.
micro_sym - The lower case name of the function, without any namespacing prefixes.
docucomment - A Clownfish::DocuComment describing the function.
parcel - A Clownfish::Parcel or a parcel name.
exposure - The function's exposure (see Clownfish::Symbol).
inline - Should be true if the function should be inlined by the compiler.
get_return_type get_param_list get_docucomment inline
Accessors.
void
Returns true if the function has a void return type, false otherwise.
full_func_sym
A synonym for full_sym().
short_func_sym
A synonym for short_sym().
COPYRIGHT AND LICENSE
Copyright 2006-2011 Marvin Humphrey
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 KSx::Simple, copy and paste the appropriate command in to your terminal.
cpanm KSx::Simple
perl -MCPAN -e shell install KSx::Simple
For more information on module installation, please visit the detailed CPAN module installation guide.