phpDocumentor

[ ] [ ] [ ]

Packages:
phpDocumentor
Converters

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 Tutorial
  - Documentable PHP Elements
  - phpDocumentor Tutorials
- phpDocumentor Manual
  - phpDocumentor tags
    - @abstract
    - @access
    - @author
    - @category
    - @copyright
    - @deprecated
    - @example
    - @final
    - @filesource
    - @global
    - @ignore
    - @internal
    - @license
    - @link
    - @method
    - @name
    - @package
    - @param
    - @property
    - @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}

Files:

subpackage DescHTML

subpackage DocBlockTags

DocBlockTags.inc

subpackage Errors

subpackage InlineTags

subpackage Links

LinkClasses.inc

subpackage ParserData

subpackage ParserDocBlock

ParserDocBlock.inc

subpackage ParserElements

ParserElements.inc

subpackage Parsers

Beautifier.php
HighlightParser.inc
Parser.inc
phpDocumentorTParser.inc
Tokenizer.php
TutorialHighlightParser.inc
XMLpackagePageParser.inc

subpackage setup

find_phpdoc.php

subpackage Tutorial

PackagePageElements.inc

subpackage WordParsers

phpDocumentorTWordParser.inc
WordParser.inc

Classes:

Parsers
   Parser
   parserDescParser
   phpDocumentorTParser
   phpDocumentor_HighlightParser
   phpDocumentor_HighlightWordParser
   phpDocumentor_peardoc2_XML_Beautifier
   phpDocumentor_TutorialHighlightParser
   phpDocumentor_XML_Beautifier_Tokenizer
   ppageParser
   XMLPackagePageParser

bug_772441
Classes
EventStack
Io
phpDocumentor_IntermediateParser
phpDocumentor_setup
ProceduralPages
Publisher
tests_HighlightParserTests
tests_IntermediateParserTests
tests_ParserClassTests
tests_ParserPageTests
tests_phpDocumentorSetupTests
tests_phpDocumentorTParserTests

DescHTML
   parserB
   parserBr
   parserCode
   parserDescVar
   parserI
   parserKbd
   parserList
   parserPre
   parserSamp

DocBlockTags
   parserAccessTag
   parserExampleTag
   parserFileSourceTag
   parserLicenseTag
   parserLinkTag
   parserMethodTag
   parserNameTag
   parserParamTag
   parserPropertyReadTag
   parserPropertyTag
   parserPropertyWriteTag
   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

Procedural File: utilities.php

Source Location: /docbuilder/includes/utilities.php

Page Details:

phpDocumentor :: docBuilder Web Interface

PHP versions 4 and 5

Copyright (c) 2003-2006 Andrew Eddie, Greg 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

Tags:

author:	Greg Beaver <[email protected]>
author:	Andrew Eddie
version:	CVS: $Id: utilities.php 212211 2006-04-30 22:18:14Z cellog $
copyright:	2003-2006 Andrew Eddie, Greg Beaver
license:	LGPL

Includes:

include_once('PhpDocumentor/HTML_TreeMenu-1.1.2/TreeMenu.php') [line 36]
include_once(dirname(realpath(__FILE__))."/../../HTML_TreeMenu-1.1.2/TreeMenu.php") [line 38]

getDir [line 74]

void getDir(
 $path,  &$node)

Parameters

	$path
	&$node

[ Top ]

htmlArraySelect [line 63]

void htmlArraySelect(
 &$arr, string $select_name, string $select_attribs, string $selected, array $arr)

Returns a select box based on an key,value array where selected is based on key

Parameters

array	$arr	array of the key-text pairs
string	$select_name	The name of the select box
string	$select_attribs	Additional attributes to insert into the html select tag
string	$selected	The key value of the selected eleme
	&$arr

[ Top ]

recurseDir [line 96]

void recurseDir(
 $path,  &$node)

Parameters

	$path
	&$node

[ Top ]

showImage [line 48]

void showImage(
string $src, [int $wid = ''], [int $hgt = ''], [string $alt = ''])

Allows png's with alpha transparency to be displayed in IE 6

Parameters

string	$src	path to the source image
int	$wid	width on the image [optional]
int	$hgt	height on the image [optional]
string	$alt	hover text for the image [optional]

[ Top ]

switchDirTree [line 125]

void switchDirTree(
 $path,  &$node)

Parameters

	$path
	&$node

[ Top ]

vdump_par [line 205]

void vdump_par(
 $tree)

Parameters

$tree

[ Top ]

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