[ ] [ ] [ ]

Packages:
PhpDocumentor
Converters
Cpdf
HTML_TreeMenu
phpDocumentor
Smarty
tests
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 1.3.2 Tutorial
  - Documentable PHP Elements
  - phpDocumentor Tutorials
- phpDocumentor 1.3.2 Manual
  - phpDocumentor tags
    - @abstract
    - @access
    - @author
    - @category
    - @copyright
    - @deprecated
    - @example
    - @final
    - @filesource
    - @global
    - @ignore
    - @internal
    - @license
    - @link
    - @name
    - @package
    - @param
    - @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
   parserNameTag
   parserParamTag
   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:

actions.php
add_cvs.php
builder.php
Classes.inc
common.inc.php
config.php
create_examples.php
EventStack.inc
file_dialog.php
IntermediateParser.inc
Io.inc
new_phpdoc.php
phpdoc.inc
phpdoc.php
ProceduralPages.inc
Publisher.inc
Setup.inc.php
top.php
utilities.php

subpackage DescHTML

DescHTML.inc

subpackage DocBlockTags

DocBlockTags.inc

subpackage Errors

Errors.inc

subpackage InlineTags

InlineTags.inc

subpackage Links

LinkClasses.inc

subpackage ParserData

ParserData.inc

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

WordParser.inc

File: common.inc.php

Source Location: /PhpDocumentor-1.3.2/phpDocumentor/common.inc.php

Classes:

Page Details:

Common information needed by all portions of the application

phpDocumentor :: automatic documentation generator

PHP versions 4 and 5

LICENSE:

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

Author: Greg Beaver <cellog@php.net>
Version: CVS: $Id: common.inc.php,v 1.7.2.1 2007/04/04 14:31:32 ashnazg Exp $
Copyright: 2001-2006 Gregory Beaver
See: parserDefine, parserFunction, parserMethod, parserVar
See: parserDocBlock, parserInclude, parserPage, parserClass
Link: http://pear.php.net/PhpDocumentor
Link: http://www.phpdoc.org
Since: 1.0rc1
Filesource: Source Code for this file
License: LGPL

Includes:

require_once(dirname(__FILE__).'/clone5.inc.php') [line 65]
require_once('PhpDocumentor/phpDocumentor/clone.inc.php') [line 61]
require_once('PhpDocumentor/phpDocumentor/clone5.inc.php') [line 59]
require_once(dirname(__FILE__).'/clone.inc.php') [line 67]

PATH_DELIMITER [line 52]

PATH_DELIMITER = '/'

[ Top ]

PHPDOCUMENTOR_VER [line 43]

PHPDOCUMENTOR_VER = "@VER@"

phpDocumentor version

[ Top ]

PHPDOCUMENTOR_WEBSITE [line 48]

PHPDOCUMENTOR_WEBSITE = "http://www.phpdoc.org"

phpDocumentor version

[ Top ]

PHPDOCUMENTOR_WINDOWS [line 53]

PHPDOCUMENTOR_WINDOWS = substr(PHP_OS,0,3)=='WIN'

[ Top ]

SMART_PATH_DELIMITER [line 49]

SMART_PATH_DELIMITER = DIRECTORY_SEPARATOR

[ Top ]

tokenizer_ext [line 50]

tokenizer_ext = extension_loaded('tokenizer')&&version_compare(phpversion(),"4.3.0",">=")

[ Top ]

_IN_PHP5 [line 54]

_IN_PHP5 = phpversion()=='5.0.0RC1-dev'||phpversion()=='5.0.0RC2-dev'||version_compare(phpversion(),'5.0.0','ge')

[ Top ]

debug [line 221]

void debug(
 $s)

Debugging output

Parameters

[ Top ]

fancy_debug [line 232]

void fancy_debug(
string $s, mixed $v, mixed $v...)

Returns a formatted var_dump for debugging purposes.

Parameters

string	$s	string to display
mixed	$v	variable to display with var_dump()
mixed	$v...	unlimited number of additional variables to display with var_dump()

[ Top ]

phpDocumentor_ConfigFileList [line 76]

void phpDocumentor_ConfigFileList(
 $directory)

used in phpdoc.php and new_phpdoc.php

Parameters

$directory

[ Top ]

phpDocumentor_get_class [line 254]

void phpDocumentor_get_class(
 $object)

Returns a lower-cased version of get_class for PHP 5

get_class() returns case as declared in the file in PHP 5

Parameters

$object

[ Top ]

phpDocumentor_parse_ini_file [line 124]

array phpDocumentor_parse_ini_file(
string $filename, [boolean $process_sections = false])

Parse an .ini file

Works like http://www.php.net/parse_ini_file, except it will take a section like:

 [MYVAR]
 value1
 value2
 value3

and return an associative array(MYVAR => array(value1, value2, value3))

Parameters

string	$filename	full path to the ini file
boolean	$process_sections	add an associative index for each section [in brackets]

[ Top ]