Documentation Index  (Index/index)

1.1 documenter.pl  (Index/documenter.pl)

1.1.1 global %index_options  (Index/documenter.pl)

1.1.2 global @line_index  (Index/documenter.pl)

1.1.3 global %doc_options  (Index/documenter.pl)

1.1.4 global $htmlfilename  (Index/documenter.pl)

1.1.5 global $documentation  (Index/documenter.pl)

1.1.6 sub perl_code_handler  (Index/documenter.pl)

1.1.7 sub pod_handler  (Index/documenter.pl)

1.1.8 sub comment_handler  (Index/documenter.pl)

1.1.9 sub get_closest_line_anchor  (Index/documenter.pl)

1.1.10 sub index_item_info  (Index/documenter.pl)

1.1.11 sub set_current_line  (Index/documenter.pl)

1.1.12 Literate Programming Automatic Documenter  (Index/documenter.pl)

1.1.12.1 Option parsing  (Index/documenter.pl)

1.1.12.2 File parsing and index generation  (Index/documenter.pl)

1.1.13 Helper functions  (Index/documenter.pl)

1.1.13.1 Handler function to print source code  (Index/documenter.pl)

1.1.13.2 Handler function to print and format PerlPod code  (Index/documenter.pl)

1.1.13.3 Handler function to print and format comments  (Index/documenter.pl)

1.1.13.4 get the line anchor closest to the given line  (Index/documenter.pl)

1.1.13.5 Function to add location info to index items.  (Index/documenter.pl)

1.1.13.6 Function to create line anchors.  (Index/documenter.pl)

1.1.14 Tool usage  (Index/documenter.pl)

1.1.14.1 Commenting guidelines  (Index/documenter.pl)

1.1.14.2 Command line usage  (Index/documenter.pl)

1.2 LICENSE  (Index/LICENSE)

1.3 perlsearch.pl  (Index/perlsearch.pl)

1.3.1 Perl search tool  (Index/perlsearch.pl)

1.4 README.md  (Index/README.md)

1.5 recursivedocumenter.pl  (Index/recursivedocumenter.pl)

1.5.1 global $outputdirectory  (Index/recursivedocumenter.pl)

1.5.2 global $sourcedirectory  (Index/recursivedocumenter.pl)

1.5.3 global $format  (Index/recursivedocumenter.pl)

1.5.4 global $force  (Index/recursivedocumenter.pl)

1.5.5 global @rootdir  (Index/recursivedocumenter.pl)

1.5.6 global $stuff_was_copied  (Index/recursivedocumenter.pl)

1.5.7 sub wanted  (Index/recursivedocumenter.pl)

1.5.8 Recursive documentation generator  (Index/recursivedocumenter.pl)

1.5.8.1 Find filter that runs documenter if the file matches things we can use for  (Index/recursivedocumenter.pl)

1.5.9 NAME  (Index/recursivedocumenter.pl)

1.5.10 SYNOPSIS  (Index/recursivedocumenter.pl)

1.5.11 OPTIONS  (Index/recursivedocumenter.pl)

1.5.12 DESCRIPTION  (Index/recursivedocumenter.pl)

1.6 staticindex.pl  (Index/staticindex.pl)

1.6.1 global @linear_index  (Index/staticindex.pl)

1.6.2 sub by_idx  (Index/staticindex.pl)

1.6.3 sub recurse  (Index/staticindex.pl)

1.6.4 Static Index Generator  (Index/staticindex.pl)

1.6.4.1 Sorting comparator by index id  (Index/staticindex.pl)

1.6.4.2 Recursively process the index tree  (Index/staticindex.pl)

1.7.1 MooseClass.pm  (Index/Test Inputs_MooseClass.pm)

1.7.1.1 class MooseClass  (Index/Test Inputs_MooseClass.pm)

1.7.1.1.1 method some_method  (Index/Test Inputs_MooseClass.pm)

1.7.1.1.2 method not_necessary_to_show_code  (Index/Test Inputs_MooseClass.pm)

1.7.1.1.3 method shown  (Index/Test Inputs_MooseClass.pm)

1.7.1.2 Some class doing stuff in Perl  (Index/Test Inputs_MooseClass.pm)

1.7.1.2.1 This method does cool things.  (Index/Test Inputs_MooseClass.pm)

1.7.1.2.2 Hiding Source Code  (Index/Test Inputs_MooseClass.pm)

1.8.1 CommentSpecials.pm  (Index/Tools_CommentSpecials.pm)

1.8.1.1 package Tools::CommentSpecials  (Index/Tools_CommentSpecials.pm)

1.8.1.1.1 sub markdown_specials  (Index/Tools_CommentSpecials.pm)

1.8.1.2 global @ISA  (Index/Tools_CommentSpecials.pm)

1.8.1.3 global @EXPORT_OK  (Index/Tools_CommentSpecials.pm)

1.8.1.4 Process Special Comments within Markdown/Pod blocks  (Index/Tools_CommentSpecials.pm)

1.8.1.4.1 Process special bits of markup  (Index/Tools_CommentSpecials.pm)

1.8.2 NamedTree.pm  (Index/Tools_NamedTree.pm)

1.8.2.1 class Tools::NamedTree  (Index/Tools_NamedTree.pm)

1.8.2.1.1 has 'name'  (Index/Tools_NamedTree.pm)

1.8.2.1.2 method has_path  (Index/Tools_NamedTree.pm)

1.8.2.1.3 method make_path  (Index/Tools_NamedTree.pm)

1.8.2.1.4 method TO_JSON  (Index/Tools_NamedTree.pm)

1.8.2.1.5 method FROM_JSON  (Index/Tools_NamedTree.pm)

1.8.2.2 Tree with named nodes  (Index/Tools_NamedTree.pm)

1.8.2.2.1 Check if a named path exists in this tree  (Index/Tools_NamedTree.pm)

1.8.2.2.2 Make a child node with a given path (unless it already exists)  (Index/Tools_NamedTree.pm)

1.8.2.2.3 Convert tree to JSON-compatible tree.  (Index/Tools_NamedTree.pm)

1.8.2.2.4 restore parent links and blessings after serializing to JSON  (Index/Tools_NamedTree.pm)

1.8.3 Output.pm  (Index/Tools_Output.pm)

1.8.3.1 class Tools::Output  (Index/Tools_Output.pm)

1.8.3.1.1 has 'result'  (Index/Tools_Output.pm)

1.8.3.1.2 method t  (Index/Tools_Output.pm)

1.8.3.1.3 method xt  (Index/Tools_Output.pm)

1.8.3.1.4 method hr  (Index/Tools_Output.pm)

1.8.3.1.5 method br  (Index/Tools_Output.pm)

1.8.3.1.6 method p  (Index/Tools_Output.pm)

1.8.3.1.7 method h  (Index/Tools_Output.pm)

1.8.3.1.8 method b  (Index/Tools_Output.pm)

1.8.3.1.9 method i  (Index/Tools_Output.pm)

1.8.3.1.10 method tt  (Index/Tools_Output.pm)

1.8.3.1.11 method x  (Index/Tools_Output.pm)

1.8.3.1.12 method a  (Index/Tools_Output.pm)

1.8.3.1.13 method l  (Index/Tools_Output.pm)

1.8.3.1.14 method style  (Index/Tools_Output.pm)

1.8.3.1.15 method code  (Index/Tools_Output.pm)

1.8.3.2 Abstraction class for outputting pretty-printed stuff  (Index/Tools_Output.pm)

1.8.3.2.1 Append text and other things to output  (Index/Tools_Output.pm)

1.8.3.2.2 Decorators  (Index/Tools_Output.pm)

1.8.3.2.3 Pretty-print code  (Index/Tools_Output.pm)

1.8.4 PerlIndex.pm  (Index/Tools_PerlIndex.pm)

1.8.4.1 package Tools::PerlIndex  (Index/Tools_PerlIndex.pm)

1.8.4.1.1 sub new  (Index/Tools_PerlIndex.pm)

1.8.4.1.2 sub splitPath  (Index/Tools_PerlIndex.pm)

1.8.4.1.3 sub getReferences  (Index/Tools_PerlIndex.pm)

1.8.4.1.4 sub getDependencies  (Index/Tools_PerlIndex.pm)

1.8.4.1.5 sub searchIdentifiers  (Index/Tools_PerlIndex.pm)

1.8.4.2 Perl Library Indexer  (Index/Tools_PerlIndex.pm)

1.8.4.3 Constructor  (Index/Tools_PerlIndex.pm)

1.8.4.4 Split a perl identifier name into a path, a file name and a declaration  (Index/Tools_PerlIndex.pm)

1.8.4.5 Get all references to an identifier  (Index/Tools_PerlIndex.pm)

1.8.4.5.1 Search find all module dependencies  (Index/Tools_PerlIndex.pm)

1.8.4.6 Search for identifiers using regular expressions  (Index/Tools_PerlIndex.pm)

1.8.5 PerlParser.pm  (Index/Tools_PerlParser.pm)

1.8.5.1 package Tools::PerlParser  (Index/Tools_PerlParser.pm)

1.8.5.1.1 sub setHandler  (Index/Tools_PerlParser.pm)

1.8.5.1.2 sub flushcurrent  (Index/Tools_PerlParser.pm)

1.8.5.1.3 sub parse  (Index/Tools_PerlParser.pm)

1.8.5.1.4 sub get_contents_tree  (Index/Tools_PerlParser.pm)

1.8.5.1.5 sub declarations  (Index/Tools_PerlParser.pm)

1.8.5.1.6 sub get_declarations  (Index/Tools_PerlParser.pm)

1.8.5.1.7 sub get_ppi_document  (Index/Tools_PerlParser.pm)

1.8.5.1.8 sub get_title_and_type  (Index/Tools_PerlParser.pm)

1.8.5.1.9 sub get_documentation  (Index/Tools_PerlParser.pm)

1.8.5.1.10 sub dump  (Index/Tools_PerlParser.pm)

1.8.5.2 global $state  (Index/Tools_PerlParser.pm)

1.8.5.3 global $current  (Index/Tools_PerlParser.pm)

1.8.5.4 global $everything  (Index/Tools_PerlParser.pm)

1.8.5.5 global $lineno  (Index/Tools_PerlParser.pm)

1.8.5.6 global $last_lineno  (Index/Tools_PerlParser.pm)

1.8.5.7 global $ppidoc  (Index/Tools_PerlParser.pm)

1.8.5.8 global $countents_tree  (Index/Tools_PerlParser.pm)

1.8.5.9 global $declarations_node  (Index/Tools_PerlParser.pm)

1.8.5.10 global %handlers  (Index/Tools_PerlParser.pm)

1.8.5.11 global $has_moose  (Index/Tools_PerlParser.pm)

1.8.5.12 global $contents_tree  (Index/Tools_PerlParser.pm)

1.8.5.13 Perl Parser   (Index/Tools_PerlParser.pm)

1.8.5.13.1 Add a handler for a parser state.  (Index/Tools_PerlParser.pm)

1.8.5.13.2 Function to write out parsed source code, comment or POD comments  (Index/Tools_PerlParser.pm)

1.8.5.13.3 Main parser function  (Index/Tools_PerlParser.pm)

1.8.5.13.4 Get a tree of significant content elements  (Index/Tools_PerlParser.pm)

1.8.5.13.5 PPI::Find filter for declarations  (Index/Tools_PerlParser.pm)

1.8.5.13.6 Get all method, class, package and variable declaration nodes  (Index/Tools_PerlParser.pm)

1.8.5.13.7 Get the PPI Parser document  (Index/Tools_PerlParser.pm)

1.8.5.13.8 Get the type and title of a PPI element  (Index/Tools_PerlParser.pm)

1.8.5.13.9 Get the documentation directly preceding a PPI Element  (Index/Tools_PerlParser.pm)

1.8.6 Tree.pm  (Index/Tools_Tree.pm)

1.8.6.1 class Tools::Tree  (Index/Tools_Tree.pm)

1.8.6.1.1 has 'parent'  (Index/Tools_Tree.pm)

1.8.6.1.2 has 'children'  (Index/Tools_Tree.pm)

1.8.6.1.3 has 'value'  (Index/Tools_Tree.pm)

1.8.6.1.4 method add_child  (Index/Tools_Tree.pm)

1.8.6.1.5 method delete_children  (Index/Tools_Tree.pm)

1.8.6.1.6 method add_child_node  (Index/Tools_Tree.pm)

1.8.6.1.7 method traverse  (Index/Tools_Tree.pm)

1.8.6.1.8 method traverse_update  (Index/Tools_Tree.pm)

1.8.6.1.9 method TO_JSON  (Index/Tools_Tree.pm)

1.8.6.1.10 method FROM_JSON  (Index/Tools_Tree.pm)

1.8.6.2 Tree class  (Index/Tools_Tree.pm)

1.8.6.2.1 add a child node  (Index/Tools_Tree.pm)

1.8.6.2.2 remove all children with a certain value  (Index/Tools_Tree.pm)

1.8.6.2.3 add a tree as a child node  (Index/Tools_Tree.pm)

1.8.6.2.4 Traverse tree top to bottom  (Index/Tools_Tree.pm)

1.8.6.2.5 Traverse tree top to bottom, passing the value by reference  (Index/Tools_Tree.pm)

1.8.6.2.6 Convert tree to JSON-compatible tree.  (Index/Tools_Tree.pm)

1.8.6.2.7 restore parent links and blessings after serializing to JSON  (Index/Tools_Tree.pm)

1.8.7.1 HTML.pm  (Index/Tools_Output_HTML.pm)

1.8.7.1.1 class Tools::Output::HTML  (Index/Tools_Output_HTML.pm)

1.8.7.1.1.1 method t  (Index/Tools_Output_HTML.pm)

1.8.7.1.1.2 method xt  (Index/Tools_Output_HTML.pm)

1.8.7.1.1.3 method hr  (Index/Tools_Output_HTML.pm)

1.8.7.1.1.4 method br  (Index/Tools_Output_HTML.pm)

1.8.7.1.1.5 method p  (Index/Tools_Output_HTML.pm)

1.8.7.1.1.6 method h  (Index/Tools_Output_HTML.pm)

1.8.7.1.1.7 method b  (Index/Tools_Output_HTML.pm)

1.8.7.1.1.8 method i  (Index/Tools_Output_HTML.pm)

1.8.7.1.1.9 method tt  (Index/Tools_Output_HTML.pm)

1.8.7.1.1.10 method x  (Index/Tools_Output_HTML.pm)

1.8.7.1.1.11 method a  (Index/Tools_Output_HTML.pm)

1.8.7.1.1.12 method l  (Index/Tools_Output_HTML.pm)

1.8.7.1.1.13 method style  (Index/Tools_Output_HTML.pm)

1.8.7.1.1.14 method code  (Index/Tools_Output_HTML.pm)

1.8.7.1.2 HTML Output Package  (Index/Tools_Output_HTML.pm)

1.8.7.1.2.1 Decorators  (Index/Tools_Output_HTML.pm)

1.8.7.1.2.2 Pretty-print code  (Index/Tools_Output_HTML.pm)

1.8.8.1 Declaration.pm  (Index/Tools_PerlParser_Declaration.pm)

1.8.8.1.1 package Tools::PerlParser::Declaration  (Index/Tools_PerlParser_Declaration.pm)

1.8.8.1.1.1 sub new  (Index/Tools_PerlParser_Declaration.pm)

1.8.8.1.1.2 sub is_declaration  (Index/Tools_PerlParser_Declaration.pm)

1.8.8.1.1.3 sub rename  (Index/Tools_PerlParser_Declaration.pm)

1.8.8.1.1.4 sub get_start_and_end_tokens  (Index/Tools_PerlParser_Declaration.pm)

1.8.8.1.2 global @moose_keywords  (Index/Tools_PerlParser_Declaration.pm)

1.8.8.1.3 Declaration class  (Index/Tools_PerlParser_Declaration.pm)

1.8.8.1.3.1 Constructor for a new declaration element  (Index/Tools_PerlParser_Declaration.pm)

1.8.8.1.3.2 Static: Check if a PPI node is a declaration  (Index/Tools_PerlParser_Declaration.pm)

1.8.8.1.3.3 Change the name of a declaration  (Index/Tools_PerlParser_Declaration.pm)

1.8.8.1.3.4 Get the starting location of the declaration  (Index/Tools_PerlParser_Declaration.pm)