Hinrik Örn Sigurðsson > grok > App::Grok::Resource::Functions

Download:
grok-0.26.tar.gz

Dependencies

Annotate this POD

Website

CPAN RT

New  1
Open  0
View/Report Bugs
Module Version: 0.26   Source  

NAME ^

App::Grok::Resource::Functions - S29/S32 functions resource for grok

SYNOPSIS ^

 use strict;
 use warnings;
 use App::Grok::Resource::Functions qw<:ALL>;

 # a list of all functions
 my @index = func_index();

 # documentation for a specific functions
 my $pod = func_fetch('split');

 # the file where the function was found
 my $file = func_locate('split');

DESCRIPTION ^

This resource reads Synopses 29 and 32, and allows you to look up the functions therein.

FUNCTIONS ^

func_index

Takes no arguments. Returns a list of all known function names.

func_fetch

Takes the name of a function as an argument. Returns the documentation for that function.

func_locate

Takes the same argument as func_fetch. Returns the path to the Synopsis file where the given function was found.

syntax highlighting: