Packageindex Classtrees Modulegroups Elementlist Report XML Files

File: /home/cch/www/pear/PHPDoc/renderer/html/PhpdocHTMLModuleRenderer.php
PEAR Repository - PHPDoc

PhpdocHTMLModuleRenderer

PhpdocObject
   |
  +-- PhpdocRendererObject
     |
    +-- PhpdocHTMLRenderer
       |
      +-- PhpdocHTMLDocumentRenderer
         |
        +-- PhpdocHTMLModuleRenderer

Renders modules.

 

private class PhpdocHTMLModuleRenderer extends PhpdocHTMLDocumentRenderer

Renders modules.

AuthorsUlf Wendel <ulf.wendel@phpdoc.de>
Version1.0beta

 

Methods inherited from PhpdocHTMLDocumentRenderer

renderconstants, renderconstantsummary, renderconstantdetail, renderuses, renderusesdetail, renderusessummary, renderfunctions, renderfunctionsummary, renderfunctiondetail, renderparameterdetail, getparameter, rendersee, renderauthors, renderlinks, renderthrows, renderglobals, rendercommondocfields

Methods inherited from PhpdocHTMLRenderer

setpath, settemplateroot, encode

Methods inherited from PhpdocObject

setflagoutput, out, nametourl, outl, introspection

Public Method Summary

void

PhpdocHTMLModuleRenderer(string $path, string $templateRoot, string $application, string $extension)

Sets the xml and template root directory.
void

renderModule(string $xmlfile, [ string $htmlfile ])

Renders a module

Fields inherited from PhpdocHTMLDocumentRenderer

$undocmented, $functions, $uses, $constants, $accessmodifiers, $simpledocfields, $usestypes

Fields inherited from PhpdocHTMLRenderer

$tpl, $accessor, $templateroot, $path

Fields inherited from PhpdocRendererObject

$file_extension, $warn, $accessor

Fields inherited from PhpdocObject

$err, $flag_output, $application, $warn

Public Method Details

PhpdocHTMLModuleRenderer

public void PhpdocHTMLModuleRenderer( string $path, string $templateRoot, string $application, string $extension )

  Sets the xml and template root directory.

Parameter
string $path
XML file path
string $templateRoot
Template file path
string $application
Name of the current application
string $extension
Returns void

See Also setPath(), setTemplateRoot()

renderModule

public void renderModule( string $xmlfile, [ string $htmlfile ] )

  Renders a module

Parameter
string $xmlfile
XML source file
string $htmlfile = >>""<<
Name of the HTML target file.
Returns void



Packageindex Classtrees Modulegroups Elementlist Report XML Files
PHPDoc 1.0beta