Author image Marvin Humphrey
and 1 contributors

NAME

Boilerplater::Function - Metadata describing a function.

METHODS

new

    my $type = Boilerplater::Function->new(
        class_name   => 'MyProject::FooFactory',    # required
        class_cnick  => 'FooFact ',                 # required
        param_list   => $param_list,                # required
        micro_sym    => 'count',                    # required
        docu_comment => $docu_comment,              # default: undef
    );
  • class_name - The full name of the class in whose namespace the function resides.

  • class_cnick - The nickname of the class. Used for deriving the global C symbol for the function.

  • param_list - A Boilerplater::ParamList object representing the function's argument list.

  • micro_sym - The lower case name of the function, without any namespacing prefixes.

  • docu_comment - A Boilerplater::DocuComment describing the function.

COPYRIGHT AND LICENSE

Copyright 2006-2009 Marvin Humphrey

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.