Phpdoc

PhpdocObject
   |
  +-- PhpdocArgvHandler
     |
    +-- PhpdocSetupHandler
       |
      +-- Phpdoc

Coordinates several Phpdoc Object to parse and render source files.

Coordinates several Phpdoc Object to parse and render source files.

Authors Ulf Wendel <ulf.wendel@phpdoc.de>

Version $Id: $

Public Method Summary
void	Phpdoc() Calls the command line handler if necessary.
bool	parse() Starts the parser.
bool	render([ string $type, string $target, string $template ]) Renders the PHPDoc XML files as HTML files

Private Field Summary
array	$indexer_result Result from the indexer
boolean	$flag_output Print status messages

Public Method Details

public void Phpdoc( )

Calls the command line handler if necessary.

Returns

void

Required global variables

array $argc

, string $PHP_SELF

public bool parse( )

Starts the parser.

Returns

bool $ok

Throws PhpdocError

public bool render( [ string $type, string $target, string $template ] )

Renders the PHPDoc XML files as HTML files

Parameter

string	$type	`= >>"html"<<`
	, currently only "html" is available.

string	$target	`= >>""<<`
	directory for the html files

string	$template	`= >>""<<`
	with the html templates

Returns

bool $ok

Throws PhpdocError

Private Field Details
$indexer_result
private array $indexer_result >>`array()`<< Result from the indexer
See Also	render()

$flag_output
private boolean $flag_output >>`true`<< Print status messages
Since	0.3
See Also	setFlagOutput()