phpDocumentor

[ ] [ ] [ ]

Packages:
Converters
Cpdf
HTML_TreeMenu
phpDocumentor
Smarty
XML_Beautifier

Tutorials/Manuals:
Package-level:

phpDocumentor Guide to Creating Fantastic Documentation
- phpDocumentor Quickstart
  - Source code for sample1.php
  - Source code for sample2.php
  - Source code for sample3.php
- phpDocumentor Tutorial
  - Documentable PHP Elements
  - phpDocumentor Tutorials
- phpDocumentor Manual
  - phpDocumentor tags
    - @abstract
    - @access
    - @author
    - @category
    - @copyright
    - @deprecated
    - @example
    - @final
    - @filesource
    - @global
    - @ignore
    - @internal
    - @license
    - @link
    - @method
    - @name
    - @package
    - @param
    - @property
    - @return
    - @see
    - @since
    - @static
    - @staticvar
    - @subpackage
    - @todo
    - @tutorial
    - @uses
    - @var
    - @version
  - phpDocumentor Inline tags
    - inline {@example}
    - inline {@id}
    - inline {@internal}}
    - inline {@inheritdoc}
    - inline {@link}
    - inline {@source}
    - inline {@toc}
    - inline {@tutorial}

Classes:

Parsers
   Parser
   parserDescParser
   phpDocumentorTParser
   phpDocumentor_HighlightParser
   phpDocumentor_HighlightWordParser
   phpDocumentor_peardoc2_XML_Beautifier
   phpDocumentor_TutorialHighlightParser
   phpDocumentor_XML_Beautifier_Tokenizer
   ppageParser
   XMLPackagePageParser

Classes
EventStack
Io
phpDocumentor_IntermediateParser
phpDocumentor_setup
ProceduralPages
Publisher

DescHTML
   parserB
   parserBr
   parserCode
   parserDescVar
   parserI
   parserKbd
   parserList
   parserPre
   parserSamp

DocBlockTags
   parserAccessTag
   parserExampleTag
   parserFileSourceTag
   parserLicenseTag
   parserLinkTag
   parserMethodTag
   parserNameTag
   parserParamTag
   parserPropertyReadTag
   parserPropertyTag
   parserPropertyWriteTag
   parserReturnTag
   parserSeeTag
   parserStaticvarTag
   parserTag
   parserTutorialTag
   parserUsedByTag
   parserUsesTag
   parserVarTag

Errors
   ErrorTracker
   RecordError
   RecordWarning

InlineTags
   parserExampleInlineTag
   parserIdInlineTag
   parserInheritdocInlineTag
   parserInlineTag
   parserLinkInlineTag
   parserSourceInlineTag
   parserTocInlineTag
   parserTutorialInlineTag

Links
   abstractLink
   classLink
   constLink
   defineLink
   functionLink
   globalLink
   methodLink
   pageLink
   tutorialLink
   varLink

Tutorial
   parserCData
   parserEntity
   parserXMLDocBookTag

ParserData
   parserBase
   parserData
   parserPage
   parserStringWithInlineTags

WordParsers
   ObjectWordParser
   phpDocumentorTWordParser
   WordParser

ParserDocBlock
parserDesc
parserDocBlock

ParserElements
   parserClass
   parserConst
   parserDefine
   parserElement
   parserFunction
   parserGlobal
   parserInclude
   parserMethod
   parserPackagePage
   parserTutorial
   parserVar

Files:

subpackage DescHTML

subpackage DocBlockTags

DocBlockTags.inc

subpackage Errors

subpackage InlineTags

subpackage Links

LinkClasses.inc

subpackage ParserData

subpackage ParserDocBlock

ParserDocBlock.inc

subpackage ParserElements

ParserElements.inc

subpackage Parsers

Beautifier.php
HighlightParser.inc
Parser.inc
ParserDescCleanup.inc
phpDocumentorTParser.inc
phpDocumentorTWordParser.inc
Tokenizer.php
TutorialHighlightParser.inc
XMLpackagePageParser.inc

subpackage setup

find_phpdoc.php

subpackage Tutorial

PackagePageElements.inc

subpackage WordParsers

File: create_examples.php

Source Location: /PhpDocumentor-1.5.0a1/scripts/create_examples.php

Classes:

Page Details:

This file creates example documentation output of all templates.

Filesource: Source Code for this file

string $base_package [line 35]

default package name, used to change all non-included files to this package

Default value:

"phpDocumentor"

[ Top ]

array $output [line 55]

directories to output examples into.

Default value:

array(
   $output_directory.'/docs/phpdoc_default'      => 'HTML:default:default',
   $output_directory.'/docs/phpdoc_l0l33t'         => 'HTML:default:l0l33t',
   $output_directory.'/docs/phpdoc_phpdoc_de'      => 'HTML:default:phpdoc.de',
   $output_directory.'/docs/phpdoc_DOM_default'      => 'HTML:default:DOM/default',
   $output_directory.'/docs/phpdoc_DOM_l0l33t'      => 'HTML:default:DOM/l0l33t',
   $output_directory.'/docs/phpdoc_DOM_phpdoc_de'       => 'HTML:default:DOM/phpdoc.de',
   $output_directory.'/docs/phpdoc_smarty_default'    => 'HTML:Smarty:default',
   $output_directory.'/docs/phpdoc_pdf_default'       => 'PDF:default:default',
   $output_directory.'/docs/phpdoc_chm_default'       => 'CHM:default:default',
   )

[ Top ]

string $output_directory [line 30]

Directory the output should go to.

Change this variable to an output directory on your computer

Default value:

"/tmp"

[ Top ]

string $parse_directory [line 49]

location of the files to parse. Change to a location on your computer.

Example:

 $parse_directory = "/home/jeichorn/phpdoc";

Default value:

"/you-MUST/change-me/to-fit/your-environment"

[ Top ]

string $title [line 40]

Title of the generated documentation

Default value:

"phpDocumentor Generated Documentation"

[ Top ]

Documentation generated on Sun, 02 Sep 2012 00:01:23 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.