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

File: Setup.inc.php

Source Location: /PhpDocumentor-1.5.0a1/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

Includes:

include_once("phpDocumentor/ParserData.inc") [line 52]
include_once("phpDocumentor/EventStack.inc") [line 51]
include_once("phpDocumentor/Io.inc") [line 45]
include_once("phpDocumentor/ParserDocBlock.inc") [line 56]
include_once("phpDocumentor/Publisher.inc") [line 46]
include_once("phpDocumentor/DocBlockTags.inc") [line 54]
include_once("phpDocumentor/common.inc.php") [line 43]
common settings
include_once("phpDocumentor/InlineTags.inc") [line 53]
include_once("phpDocumentor/Classes.inc") [line 47]
include_once("phpDocumentor/DescHTML.inc") [line 55]
include_once("phpDocumentor/Parser.inc") [line 58]
include_once("phpDocumentor/ParserElements.inc") [line 57]
include_once("phpDocumentor/phpDocumentorTWordParser.inc") [line 59]
include_once("phpDocumentor/PackagePageElements.inc") [line 64]
include_once("phpDocumentor/Errors.inc") [line 68]
include_once("phpDocumentor/HighlightParser.inc") [line 61]
include_once("phpDocumentor/TutorialHighlightParser.inc") [line 62]
include_once("phpDocumentor/ParserDescCleanup.inc") [line 63]
include_once("phpDocumentor/phpDocumentorTParser.inc") [line 60]
include_once("phpDocumentor/Converter.inc") [line 67]
include_once("phpDocumentor/WordParser.inc") [line 50]
include_once("phpDocumentor/IntermediateParser.inc") [line 49]
include_once("phpDocumentor/XMLpackagePageParser.inc") [line 65]
include_once("phpDocumentor/LinkClasses.inc") [line 66]
include_once("phpDocumentor/ProceduralPages.inc") [line 48]

array $interface [line 75]

$interface is either 'web' or is not set at all
Default value:   $_GET['interface']


[ Top ]



string $phpDocumentor_DefaultCategoryName [line 95]

default package name, set using -dn --defaultcategoryname
  • Name: $phpDocumentor_DefaultCategoryName
Default value:   'default'


[ Top ]



string $phpDocumentor_DefaultPackageName [line 88]

default package name, set using -dn --defaultpackagename
  • Name: $phpDocumentor_DefaultPackageName
Default value:   'default'


[ Top ]



array $_phpDocumentor_setting [line 80]

$_phpDocumentor_setting is either the value from the web interface, or is set up by Io::parseArgv()
Default value:   $_GET['setting']


[ Top ]



checkForBugCondition [line 977]

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

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


Parameters

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



phpDocumentor_out [line 957]

void phpDocumentor_out( $string)

Print parse information if quiet setting is off


Parameters

   $string  
[ Top ]



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