/ 
grok-0.09
River stage one • 1 direct dependent • 1 total dependent
/ App::Grok

NAME

App::Grok - Does most of grok's heavy lifting

DESCRIPTION

This class provides the main functionality needed by grok. It has some methods you can use if you need to hook into grok.

METHODS

new

This is the constructor. It takes no arguments.

run

If you call this method, it will look at the command line arguments in @ARGV and act accordingly. This is basically what the grok program does. Takes no arguments.

target_index

Takes no arguments. Returns a list of all the targets known to grok.

detect_source

Takes a filename as an argument. Returns the name of the appropriate App::Grok::* class to parse it. Returns nothing if the file doesn't contain any Pod.

find_target

Takes a valid grok target as an argument. If found, it will return a path to a matching file, otherwise it returns nothing.

find_synopsis

Takes the name (or a substring of a name) of a Synopsis as an argument. Returns a path to a matching file if one is found, otherwise returns nothing. Note: this method is called by find_target.

find_module_or_program

Takes the name of a module or a program. Returns a path to a matching file if one is found, otherwise returns nothing.

render_file

Takes two arguments, a filename and the name of an output format. Returns a string containing the rendered document. It will die if there is an error.

AUTHOR

Hinrik Örn Sigurðsson, hinrik.sig@gmail.com

LICENSE AND COPYRIGHT

Copyright 2009 Hinrik Örn Sigurðsson

grok is distributed under the terms of the Artistic License 2.0. For more details, see the full text of the license in the file LICENSE that came with this distribution.