Description
This was all in phpdoc.inc, and now encapsulates the complexity
phpDocumentor :: automatic documentation generator
PHP versions 4 and 5
Copyright (c) 2002-2006 Gregory Beaver
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: - Gregory Beaver <[email protected]>
- version: - CVS: $Id: Setup.inc.php 319351 2011-11-16 17:35:30Z ashnazg $
- copyright: - 2002-2006 Gregory Beaver
- link: - http://pear.php.net/PhpDocumentor
- link: - http://www.phpdoc.org
- since: - 1.2
- license: - LGPL
Classes defined in this file
CLASS NAME | DESCRIPTION |
| phpDocumentor_setup |
Include/Require Statements
"phpDocumentor/ParserDescCleanup.inc" (line 62)
include_once : "phpDocumentor/ParserDescCleanup.inc"
"phpDocumentor/IntermediateParser.inc" (line 48)
include_once : "phpDocumentor/IntermediateParser.inc"
"phpDocumentor/phpDocumentorTParser.inc" (line 59)
include_once : "phpDocumentor/phpDocumentorTParser.inc"
"phpDocumentor/XMLpackagePageParser.inc" (line 64)
include_once : "phpDocumentor/XMLpackagePageParser.inc"
"phpDocumentor/TutorialHighlightParser.inc" (line 61)
include_once : "phpDocumentor/TutorialHighlightParser.inc"
"phpDocumentor/phpDocumentorTWordParser.inc" (line 58)
include_once : "phpDocumentor/phpDocumentorTWordParser.inc"
"phpDocumentor/common.inc.php" (line 42)
include_once : "phpDocumentor/common.inc.php"
common settings
"phpDocumentor/PackagePageElements.inc" (line 63)
include_once : "phpDocumentor/PackagePageElements.inc"
Global Variables
$interface (line 74)
array $interface : $_GET['interface']
$interface is either 'web' or is not set at all
$phpDocumentor_DefaultCategoryName (line 94)
string $phpDocumentor_DefaultCategoryName : 'default'
default package name, set using -dn --defaultcategoryname
- name: - $phpDocumentor_DefaultCategoryName
$phpDocumentor_DefaultPackageName (line 87)
string $phpDocumentor_DefaultPackageName : 'default'
default package name, set using -dn --defaultpackagename
- name: - $phpDocumentor_DefaultPackageName
$_phpDocumentor_setting (line 79)
array $_phpDocumentor_setting : $_GET['setting']
$_phpDocumentor_setting is either the value from the web interface, or is set up by Io::parseArgv()
Functions
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.
Parameters
- 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)
Info
decideOnOrOff (line 932)
boolean decideOnOrOff( [string $value_to_guess = 'NO VALUE WAS PASSED'])
Fuzzy logic to interpret the boolean args' intent
Parameters
- string $value_to_guess: the command-line option to analyze
Info
- return - our best guess of the value's boolean intent
phpDocumentor_out (line 953)
void phpDocumentor_out( $string)
Print parse information if quiet setting is off
Parameters
- $string: