Packageindex Classtrees Modulegroups Elementlist Report XML Files
a b c C e f g H h i n N o p P r s t w

a

$application Variable in Class PhpdocSetupHandler
Name of the application parsed
$application Variable in Class PhpdocObject
Default applicationname for the generated HTML files.

b

$basedir Variable in Class PhpdocSetupHandler
Basedir for all file operations

c

checkStatus Function in class PhpdocSetupHandler
Checks the current status of the object. Are all necessary informations to start parsing available?

C

$COMMANDS Variable in Class PhpdocArgvHandler
Message explaining the usage of phpdoc on the command line.

e

$err Variable in Class PhpdocObject
Variable containing the latest exceptions.

f

$flag_output Variable in Class Phpdoc
Print status messages
$flag_output Variable in Class PhpdocObject
Flag determining wheter to print some status messages or not (default: false)

g

getCheckedDirname Function in class PhpdocSetupHandler
Adds a slash at the end of the given filename if neccessary.
getArgvHelpMessage Function in class PhpdocArgvHandler
Returns the current help message of phpdoc

H

Hello Class Hello.

h

handleArgv Function in class PhpdocArgvHandler
Handle the command line values

i

$indexer_result Variable in Class Phpdoc
Result from the indexer
introspection Function in class PhpdocObject
Dumps objects and arrays.

n

nameToUrl Function in class PhpdocObject
Encodes an element name so that it can be used as a file name.

N

No Package specified Package

o

out Function in class PhpdocObject
Print a string and flushes the output buffer
outl Function in class PhpdocObject
Print a string, the specified HTML line break sign and flushes the output buffer

p

print Function in class Hello
文字列を指定回数だけ表示します。
parse Function in class Phpdoc
Starts the parser.

P

Phpdoc Class Phpdoc.
Coordinates several Phpdoc Object to parse and render source files.
Phpdoc Function in class Phpdoc
Calls the command line handler if necessary.
PhpdocSetupHandler Class PhpdocSetupHandler.
Handles the "setup".
PhpdocArgvHandler Class PhpdocArgvHandler.
Handles command line arguments.
PhpdocObject Class PhpdocObject.
Common base class of all phpdoc classes
PHPDoc Package

r

render Function in class Phpdoc
Renders the PHPDoc XML files as HTML files

s

setSourceDirectory Function in class PhpdocSetupHandler
Sets the name of the directory with the source to scan.
setTemplateDirectory Function in class PhpdocSetupHandler
Sets the name of the directory with the templates.
setApplication Function in class PhpdocSetupHandler
Sets the name of your application.
setTargetFileSuffix Function in class PhpdocSetupHandler
Suffix for all rendered files in the application (not for the xml files)
setSourceFileSuffix Function in class PhpdocSetupHandler
Suffix of all source code files in the application
setTarget Function in class PhpdocSetupHandler
Sets the target where the generated files are saved.
$sourceFileSuffix Variable in Class PhpdocSetupHandler
Suffix of all source code files in the application
$sourceDirectory Variable in Class PhpdocSetupHandler
Directory with the php sources to parse.
setFlagOutput Function in class PhpdocObject
Sets the output flag - if set to true out() and outl() print messages

t

$target Variable in Class PhpdocSetupHandler
Name of the target directory.
$targetFileSuffix Variable in Class PhpdocSetupHandler
Suffix for all rendered files in the application (except for the xml files).

w

$warn Variable in Class PhpdocObject
Use to save warnings.
Packageindex Classtrees Modulegroups Elementlist Report XML Files
PHPDoc 1.0beta