Package SourceDoc
Helper functions to parse source code to build a source code documentation
Example |
my $SourceDoc = DE_EPAGES::SourceDoc::API::SourceDoc->new( TemplateDir => 'Templates', ); $SourceDoc->documentFile( 'MyModule.pm', 'Doc/MyModule.html' ); |
Package DE_EPAGES::SourceDoc::API::SourceDoc
Functions
buildDirectoryPages
Creates 'index.html' pages for each directory that contains at least one HTLM help file. The index file contains links to files and sub directories.
Syntax |
$self->buildDirectoryPages( $hTreeVars, $TargetDir ) |
Input |
|
documentDir
Creates source code documentation for a directory of source files.
Syntax |
$self->documentDir($aProcessDirs, $aExtensions) |
Input |
|
documentFile
Creates source code documentation for a sinlge file
Syntax |
$self->documentFile($SourceFile, $TargetFile); |
Input |
|
getFileTree
Creates the structure of the table of contents tree.
Syntax |
$hTreeVars = $self->getFileTree( $aResult ); |
Input |
|
Return |
|
getIndex
Creates an index that contains all function names and package names.
Syntax |
$aIndex = $self->getIndex( $aResult ); |
Input |
|
Return |
|
languageTypes
returns all supported source code languages as extension => language hash.
Syntax |
$hLanguages = $self->languageTypes; |
Return |
|
new
Creates a new source documentation object.
Syntax |
DE_EPAGES::SourceDoc::API::SourceDoc->new( %Options ); |
Input |
|
Return |
|
parseFile
Parses a source file and returns the syntax tree as TLE structure.
Syntax |
$hVars = parseFile( $SourceFile ); |
Input |
|
Return |
|