Packageindex Classtrees Modulegroups Elementlist Report XML Files

File: /home/cch/www/pear/PHPDoc/core/Phpdoc.php
PEAR Repository - PHPDoc

Phpdoc

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

Coordinates several Phpdoc Object to parse and render source files.

 

public class Phpdoc extends PhpdocSetupHandler

Coordinates several Phpdoc Object to parse and render source files.

AuthorsUlf Wendel <ulf@redsys.de>
Version0.2alpha

 

Methods inherited from PhpdocSetupHandler

setsourcedirectory, settemplatedirectory, setapplication, settargetfilesuffix, setsourcefilesuffix, settarget, checkstatus, getcheckeddirname

Methods inherited from PhpdocArgvHandler

handleargv, getargvhelpmessage

Methods inherited from PhpdocObject

setflagoutput, out, nametourl, outl, introspection

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

Fields inherited from PhpdocSetupHandler

$target, $application, $basedir, $targetfilesuffix, $sourcefilesuffix, $sourcedirectory

Fields inherited from PhpdocArgvHandler

$commands

Fields inherited from PhpdocObject

$err, $application, $warn

Private Field Summary

array

$indexer_result

Result from the indexer
boolean

$flag_output

Print status messages

Public Method Details

Phpdoc

public void Phpdoc( )

  Calls the command line handler if necessary.

Returns void


parse

public bool parse( )

  Starts the parser.

Returns bool $ok

Throws PhpdocError

render

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

  Renders the PHPDoc XML files as HTML files

Parameter
string $type = >>"html"<<
Targetformat, currently only "html" is available.
string $target = >>""<<
Target directory for the html files
string $template = >>""<<
Directory with the html templates
Returns bool $ok

Throws PhpdocError

Private Field Details

$indexer_result

private array $indexer_result

>>array()<<

See Also render()

$flag_output

private boolean $flag_output

>>true<<

Since 0.3
See Also setFlagOutput()


Packageindex Classtrees Modulegroups Elementlist Report XML Files
PHPDoc 1.0beta