[ class tree: phpDocumentor ] [ index: phpDocumentor ] [ all elements ]

Procedural File:

Source Location: /phpDocumentor/

Page Details:

This was all in, and now encapsulates the complexity

phpDocumentor :: automatic documentation generator

PHP versions 4 and 5

Copyright (c) 2002-2006 Gregory Beaver


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:  Gregory Beaver <[email protected]>
version:  CVS: $Id: 319351 2011-11-16 17:35:30Z ashnazg $
copyright:  2002-2006 Gregory Beaver
since:  1.2
license:  LGPL


include_once("phpDocumentor/") [line 62]
include_once("phpDocumentor/") [line 59]
include_once("phpDocumentor/") [line 60]
include_once("phpDocumentor/") [line 67]
include_once("phpDocumentor/") [line 61]
include_once("phpDocumentor/") [line 64]
include_once("phpDocumentor/") [line 65]
include_once("phpDocumentor/") [line 47]
include_once("phpDocumentor/") [line 63]
include_once("phpDocumentor/") [line 48]
include_once("phpDocumentor/") [line 49]
include_once("phpDocumentor/") [line 66]
include_once("phpDocumentor/") [line 46]
include_once("phpDocumentor/") [line 55]
include_once("phpDocumentor/") [line 45]
include_once("phpDocumentor/") [line 44]
include_once("phpDocumentor/") [line 50]
include_once("phpDocumentor/") [line 51]
include_once("phpDocumentor/") [line 53]
include_once("phpDocumentor/") [line 42]
common settings

include_once("phpDocumentor/") [line 56]
include_once("phpDocumentor/") [line 57]
include_once("phpDocumentor/") [line 54]
include_once("phpDocumentor/") [line 52]
include_once("phpDocumentor/") [line 58]

array $interface [line 74]

$interface is either 'web' or is not set at all

Default value:   $_GET['interface']

[ Top ]

string $phpDocumentor_DefaultCategoryName [line 94]

default package name, set using -dn --defaultcategoryname


name:  $phpDocumentor_DefaultCategoryName
Default value:   'default'

[ Top ]

string $phpDocumentor_DefaultPackageName [line 87]

default package name, set using -dn --defaultpackagename


name:  $phpDocumentor_DefaultPackageName
Default value:   'default'

[ Top ]

array $_phpDocumentor_setting [line 79]

$_phpDocumentor_setting is either the value from the web interface, or is set up by Io::parseArgv()

Default value:   $_GET['setting']

[ Top ]

checkForBugCondition [line 973]

void checkForBugCondition( string $php_version, [string $php_bug_number = 'none'], [string $pear_bug_number = 'none'])

Crash in case of known, dangerous bug condition

Checks the PHP version that is executing PhpDocumentor, in case a known PHP/PEAR bug condition could be triggered by the PhpDocumentor execution.


string   $php_version   the PHP version that contains the bug
string   $php_bug_number   the PHP bug number (if any)
string   $pear_bug_number   the PEAR bug number (if any)
[ Top ]

decideOnOrOff [line 932]

boolean decideOnOrOff( [string $value_to_guess = 'NO VALUE WAS PASSED'])

Fuzzy logic to interpret the boolean args' intent


return:  our best guess of the value's boolean intent


string   $value_to_guess   the command-line option to analyze
[ Top ]

phpDocumentor_out [line 953]

void phpDocumentor_out( $string)

Print parse information if quiet setting is off


[ Top ]

Documentation generated on Tue, 06 Dec 2011 07:15:00 -0600 by phpDocumentor 1.4.4