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

Procedural File: Setup.inc.php

Source Location: /phpDocumentor/Setup.inc.php

Page Details

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 <cellog@php.net>
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
Class Description
phpDocumentor_setup
Includes
include_once ("phpDocumentor/ParserData.inc") [line 51]
[ Top ]

include_once ("phpDocumentor/DocBlockTags.inc") [line 53]
[ Top ]

include_once ("phpDocumentor/Io.inc") [line 44]
[ Top ]

include_once ("phpDocumentor/Publisher.inc") [line 45]
[ Top ]

include_once ("phpDocumentor/EventStack.inc") [line 50]
[ Top ]

include_once ("phpDocumentor/DescHTML.inc") [line 54]
[ Top ]

include_once ("phpDocumentor/InlineTags.inc") [line 52]
[ Top ]

[ Top ]

include_once ("phpDocumentor/ParserDocBlock.inc") [line 55]
[ Top ]

include_once ("phpDocumentor/Parser.inc") [line 57]
[ Top ]

include_once ("phpDocumentor/ParserElements.inc") [line 56]
[ Top ]

include_once ("phpDocumentor/common.inc.php") [line 42]

common settings

[ Top ]

include_once ("phpDocumentor/PackagePageElements.inc") [line 63]
[ Top ]

include_once ("phpDocumentor/Errors.inc") [line 67]
[ Top ]

[ Top ]

include_once ("phpDocumentor/HighlightParser.inc") [line 60]
[ Top ]

include_once ("phpDocumentor/phpDocumentorTParser.inc") [line 59]
[ Top ]

include_once ("phpDocumentor/ParserDescCleanup.inc") [line 62]
[ Top ]

include_once ("phpDocumentor/XMLpackagePageParser.inc") [line 64]
[ Top ]

include_once ("phpDocumentor/LinkClasses.inc") [line 65]
[ Top ]

include_once ("phpDocumentor/Converter.inc") [line 66]
[ Top ]

include_once ("phpDocumentor/WordParser.inc") [line 49]
[ Top ]

include_once ("phpDocumentor/IntermediateParser.inc") [line 48]
[ Top ]

include_once ("phpDocumentor/ProceduralPages.inc") [line 47]
[ Top ]

include_once ("phpDocumentor/Classes.inc") [line 46]
[ Top ]


Globals
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

Default value:  'default'
API Tags:
Name:  $phpDocumentor_DefaultCategoryName


[ Top ]

string   $phpDocumentor_DefaultPackageName [line 87]

default package name, set using -dn --defaultpackagename

Default value:  'default'
API Tags:
Name:  $phpDocumentor_DefaultPackageName


[ 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 ]


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)


[ Top ]
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

API Tags:
Return:  our best guess of the value's boolean intent


[ Top ]
phpDocumentor_out  [line 953]

void phpDocumentor_out( $string  )

Print parse information if quiet setting is off

Parameters:
   $string: 


[ Top ]


Documentation generated on Tue, 06 Dec 2011 07:21:14 -0600 by phpDocumentor 1.4.4