PHP_DocBlockGenerator
[ class tree: PHP_DocBlockGenerator ] [ index: PHP_DocBlockGenerator ] [ all elements ]
Packages:
PHP_DocBlockGenerator


Classes:
PHP_DocBlockGenerator
PHP_DocBlockGenerator_Align
PHP_DocBlockGenerator_Block
PHP_DocBlockGenerator_Cli
PHP_DocBlockGenerator_GetoptPlus
PHP_DocBlockGenerator_License
PHP_DocBlockGenerator_Tokens
PHP_DocBlockGenerator_Type
Files:
Align.php
Block.php
Cli.php
DocBlockGenerator.php
GetoptPlus.php
License.php
Tokens.php
Type.php

Element index for package PHP_DocBlockGenerator

[ a ] [ b ] [ c ] [ d ] [ e ] [ g ] [ h ] [ i ] [ l ] [ o ] [ p ] [ r ] [ s ] [ t ] [ u ] [ _ ]

_

__construct
in file Type.php, method PHP_DocBlockGenerator_Type::__construct()
    The class constructor
__construct
in file Tokens.php, method PHP_DocBlockGenerator_Tokens::__construct()
    The class constructor
__construct
in file License.php, method PHP_DocBlockGenerator_License::__construct()
    The class constructor
__construct
in file DocBlockGenerator.php, method PHP_DocBlockGenerator::__construct()
    The class constructor
__construct
in file Block.php, method PHP_DocBlockGenerator_Block::__construct()
    The class constructor
top

a

alignLines
in file GetoptPlus.php, method PHP_DocBlockGenerator_GetoptPlus::alignLines()
    Align a set of lines
alignTags
in file Align.php, method PHP_DocBlockGenerator_Align::alignTags()
    Aligns the tags within a DocBlock
Align.php
procedural page Align.php
top

b

build
in file Block.php, method PHP_DocBlockGenerator_Block::build()
    Builds the DocBlock
Block.php
procedural page Block.php
top

c

Cli.php
procedural page Cli.php
top

d

DocBlockGenerator.php
procedural page DocBlockGenerator.php
top

e

$eol
in file Tokens.php, variable PHP_DocBlockGenerator_Tokens::$eol
    The source code End-Of-Line character
extract
in file Type.php, method PHP_DocBlockGenerator_Type::extract()
    Extracts the type from a list of types
top

g

generate
in file DocBlockGenerator.php, method PHP_DocBlockGenerator::generate()
    Generates the DocBlocks
generate
in file Cli.php, method PHP_DocBlockGenerator_Cli::generate()
    The command line interface for DOS/Unix command
get
in file Tokens.php, method PHP_DocBlockGenerator_Tokens::get()
    Gets the current token
getFullName
in file License.php, method PHP_DocBlockGenerator_License::getFullName()
    Gets the license full name
getopt
in file GetoptPlus.php, method PHP_DocBlockGenerator_GetoptPlus::getopt()
    Gets the options and parameters from the command arguments
getText
in file License.php, method PHP_DocBlockGenerator_License::getText()
    Gets the license text
getURL
in file License.php, method PHP_DocBlockGenerator_License::getURL()
    Gets the license URL
guessConst
in file Type.php, method PHP_DocBlockGenerator_Type::guessConst()
    Guesses the class constant or define statement type
guessReturn
in file Type.php, method PHP_DocBlockGenerator_Type::guessReturn()
    Guesses the type of data the function returns
guessVar
in file Type.php, method PHP_DocBlockGenerator_Type::guessVar()
    Guesses a variable type
GetoptPlus.php
procedural page GetoptPlus.php
top

h

$hasBlock
in file Tokens.php, variable PHP_DocBlockGenerator_Tokens::$hasBlock
    Flag indicating if the current token has a DocBlock or not
top

i

$id
in file Tokens.php, variable PHP_DocBlockGenerator_Tokens::$id
    The current token information, including the token type, access type...
$inClass
in file Tokens.php, variable PHP_DocBlockGenerator_Tokens::$inClass
    Flag indicating if the current token is within a class
$isInterface
in file Tokens.php, variable PHP_DocBlockGenerator_Tokens::$isInterface
    Flag indicating if the class is an interface
init
in file Block.php, method PHP_DocBlockGenerator_Block::init()
    Initializes the Page-level tags
isAVar
in file Type.php, method PHP_DocBlockGenerator_Type::isAVar()
    Checks if the current token(s) is a variable and returns its scope
isValid
in file License.php, method PHP_DocBlockGenerator_License::isValid()
    Verifies the license template is valid
top

l

License.php
procedural page License.php
top

o

OpAfter
in file Type.php, class constant PHP_DocBlockGenerator_Type::OpAfter
    The post-operation variable flag
OpBefore
in file Type.php, class constant PHP_DocBlockGenerator_Type::OpBefore
    The pre-operation variable flag
optionPadding
in file GetoptPlus.php, class constant PHP_DocBlockGenerator_GetoptPlus::optionPadding
    The option name padding within the option descrition
options
in file GetoptPlus.php, class constant PHP_DocBlockGenerator_GetoptPlus::options
    The options section title
top

p

$phpVersion
in file Tokens.php, variable PHP_DocBlockGenerator_Tokens::$phpVersion
    The file PHP version
packageLink
in file Block.php, class constant PHP_DocBlockGenerator_Block::packageLink
    The default path to the package link
packageName
in file Block.php, class constant PHP_DocBlockGenerator_Block::packageName
    The default package name
parameters
in file GetoptPlus.php, class constant PHP_DocBlockGenerator_GetoptPlus::parameters
    The parameter section title
PHP_DocBlockGenerator
in file DocBlockGenerator.php, class PHP_DocBlockGenerator
    Creation of Documentation blocks or DocBlocks in a PHP file
PHP_DocBlockGenerator_Align
in file Align.php, class PHP_DocBlockGenerator_Align
    Alignment of DocBlocks tags in a PHP file
PHP_DocBlockGenerator_Block
in file Block.php, class PHP_DocBlockGenerator_Block
    Creation of DocBlocks for PHP objects : includes, defines, globals, functions, classes, vars
PHP_DocBlockGenerator_Cli
in file Cli.php, class PHP_DocBlockGenerator_Cli
    Command Line Interface to create DocBlocks in a PHP file
PHP_DocBlockGenerator_GetoptPlus
in file GetoptPlus.php, class PHP_DocBlockGenerator_GetoptPlus
    Getopt extension
PHP_DocBlockGenerator_License
in file License.php, class PHP_DocBlockGenerator_License
    License repository: license full name, text template and URL.
PHP_DocBlockGenerator_Tokens
in file Tokens.php, class PHP_DocBlockGenerator_Tokens
    Extraction of the PHP objects/tokens of the source code and creation of the DocBlocks
PHP_DocBlockGenerator_Type
in file Type.php, class PHP_DocBlockGenerator_Type
    Determination of PHP object types for DocBlock tags
process
in file Tokens.php, method PHP_DocBlockGenerator_Tokens::process()
    Processes the source code tokens
top

r

realign
in file Block.php, method PHP_DocBlockGenerator_Block::realign()
    Realignes the DocBlock tags
resetCache
in file Type.php, method PHP_DocBlockGenerator_Type::resetCache()
    Resets the types cache
top

s

set
in file Tokens.php, method PHP_DocBlockGenerator_Tokens::set()
    Sets the token value
setClass
in file Block.php, method PHP_DocBlockGenerator_Block::setClass()
    Sets the class DocBlock
setConst
in file Block.php, method PHP_DocBlockGenerator_Block::setConst()
    Sets the class constant DocBlock
setDefine
in file Block.php, method PHP_DocBlockGenerator_Block::setDefine()
    Sets the define DocBlock
setFunction
in file Block.php, method PHP_DocBlockGenerator_Block::setFunction()
    Sets the function/method DocBlock
setGlobal
in file Block.php, method PHP_DocBlockGenerator_Block::setGlobal()
    Sets the global variable DocBlock
setGLOBALS
in file Block.php, method PHP_DocBlockGenerator_Block::setGLOBALS()
    Sets the GLOBALS variable DocBlock
setHelp
in file GetoptPlus.php, method PHP_DocBlockGenerator_GetoptPlus::setHelp()
    Set the help/usage text
setOptions
in file GetoptPlus.php, method PHP_DocBlockGenerator_GetoptPlus::setOptions()
    Sets the options help text section
setPage
in file Block.php, method PHP_DocBlockGenerator_Block::setPage()
    Sets the Page-level DocBlock
setUsage
in file GetoptPlus.php, method PHP_DocBlockGenerator_GetoptPlus::setUsage()
    Sets the usage help text section
setVar
in file Block.php, method PHP_DocBlockGenerator_Block::setVar()
    Sets the class variable DocBlock
slice
in file Tokens.php, method PHP_DocBlockGenerator_Tokens::slice()
    Slices a subset of tokens
top

t

Tokens.php
procedural page Tokens.php
Type.php
procedural page Type.php
tagLines
in file Align.php, class constant PHP_DocBlockGenerator_Align::tagLines
    Pattern to extract a tag line, excluding the tag first line
tagParts
in file Align.php, class constant PHP_DocBlockGenerator_Align::tagParts
    Pattern to extract a tag with its lines details
tags
in file Align.php, class constant PHP_DocBlockGenerator_Align::tags
    Pattern to extract a tag with its type and its variable, e.g. *
tidyArgs
in file GetoptPlus.php, method PHP_DocBlockGenerator_GetoptPlus::tidyArgs()
    Tidies the command arguments
tidyArray
in file GetoptPlus.php, method PHP_DocBlockGenerator_GetoptPlus::tidyArray()
    Tidies an array
tidyOptions
in file GetoptPlus.php, method PHP_DocBlockGenerator_GetoptPlus::tidyOptions()
    Tydies the options
tidyString
in file GetoptPlus.php, method PHP_DocBlockGenerator_GetoptPlus::tidyString()
    Tidies a string
top

u

usage
in file GetoptPlus.php, class constant PHP_DocBlockGenerator_GetoptPlus::usage
    The usage section title
top
Documentation generated on Mon, 11 Mar 2019 15:46:45 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.