Matt S Trout > Rakudo-Star-2012.08_001 > Parrot::Headerizer

Download:
Rakudo-Star-2012.08_001.tar.gz

Dependencies

Annotate this POD

Source  

NAME ^

Parrot::Headerizer - Parrot header generation functionality

SYNOPSIS ^

    use Parrot::Headerizer;

    $headerizer = Parrot::Headerizer->new( {
        macro_match => $macro_match, # optional
    } );

    $headerizer->get_sources(@ofiles);
    $headerizer->process_sources();
    $headerizer->print_final_message();
    $headerizer->print_warnings();

    @function_decls = $headerizer->extract_function_declarations($buf);
    $escaped_decl = $headerizer->generate_documentation_signature($function_decl);

DESCRIPTION ^

Parrot::Headerizer knows how to extract all kinds of information out of C-language files. Its methods are used in tools/dev/headerizer.pl and t/codingstd/c_function_docs.t.

METHODS ^

new()

get_sources()

extract_function_declarations()

extract_function_declaration_and_update_source()

function_components_from_declaration($file, $proto)

check_pointer_return_type()

generate_documentation_signature()

valid_macro()

valid_macros()

squawk()

process_sources()

replace_headerized_declarations()

make_function_decls()

attrs_from_args()

print_final_message()

print_headerizer_warnings()

syntax highlighting: