phpDocumentor

[ ] [ ] [ ]

Packages:
phpDocumentor
Converters
Cpdf
HTML_TreeMenu
Smarty
tests
XML_Beautifier

Tutorials/Manuals:
В пакете:

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

DescHTML.inc

subpackage DocBlockTags

DocBlockTags.inc

subpackage Errors

Errors.inc

subpackage InlineTags

InlineTags.inc

subpackage Links

LinkClasses.inc

subpackage ParserData

ParserData.inc

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

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

Class: parserExampleInlineTag

Source Location: /phpDocumentor/InlineTags.inc

Class Overview

parserBase
   |
   --parserInlineTag
      |
      --parserSourceInlineTag
         |
         --parserExampleInlineTag

Represents the example inline tag, used to display an example file inside a docblock or tutorial

Author(s):

Gregory Beaver <cellog@php.net>

Version:

Release: @VER@

Copyright:

2002-2008 Gregory Beaver

Methods

Inherited Variables

Inherited Methods

Class: parserSourceInlineTag

parserSourceInlineTag::parserSourceInlineTag(): constructor
parserSourceInlineTag::arrayConvert(): converter helper used in PHP 4.3.0+
parserSourceInlineTag::Convert(): convert the tag
parserSourceInlineTag::getString(): gets the source string
parserSourceInlineTag::setSource(): sets the source tag's value
parserSourceInlineTag::stringConvert(): converter helper used in PHP 4.2.3-
parserSourceInlineTag::Strlen(): only used to determine blank lines. {@source} will not be blank, probably

Class: parserInlineTag

parserInlineTag::parserInlineTag(): sets up the tag
parserInlineTag::getString(): always gets an empty string
parserInlineTag::Strlen(): get length of the tag

Class: parserBase

parserBase::getType(): gets the type
parserBase::getValue(): gets the value
parserBase::setValue(): sets the given value

Class Details

[line 567]
Represents the example inline tag, used to display an example file inside a docblock or tutorial

Tags:

tutorial:	inline {@example}
author:	Gregory Beaver <cellog@php.net>
version:	Release: @VER@
copyright:	2002-2008 Gregory Beaver
see:	parserStringWithInlineTags
link:	http://www.phpdoc.org
link:	http://pear.php.net/PhpDocumentor
todo:	CS cleanup - change classname to PhpDocumentor_*
todo:	CS cleanup - change package to PhpDocumentor
license:	LGPL

[ Top ]

Class Methods

constructor parserExampleInlineTag [line 582]

mixed parserExampleInlineTag(
string
$value, string
$current_path, [bool
$isTutorial = false])

constructor

Tags:

todo:

replace tokenizer_ext constant with TOKENIZER_EXT for CS rule

Parameters:

string	$value	format "filepath[ start [end]]" where start and end are line numbers with the end line number optional
string	$current_path	full path to the current file, used to check relative directory locations
bool	$isTutorial	if true, then this is in a tutorial

[ Top ]

method arrayConvert [line 733]

string arrayConvert(
Converter
&$c)

converter helper for PHP 4.3.0+

Tags:

uses:

phpDocumentor_HighlightParser - Parses the tokenized source

Overrides parserSourceInlineTag::arrayConvert() (converter helper used in PHP 4.3.0+)

Parameters:

Converter

&$c

output converter

[ Top ]

method getProgramListing [line 752]

string getProgramListing(
)

Return the source for the example file, enclosed in a <programlisting> tag to use in a tutorial

[ Top ]

method setSource [line 719]

void setSource(
string|array
$source, [string|bool
$class = false])

sets the source

Overrides parserSourceInlineTag::setSource() (sets the source tag's value)

Parameters:

string\|array	$source	source code
string\|bool	$class	class name if this is a method, boolean in php 4.3.0, if this is a method this will be true

[ Top ]

PHP5

Для web разработчика

Nov 21
Docs For Class parserExampleInlineTag

Class: parserExampleInlineTag

Class Overview

Author(s):

Version:

Copyright:

Methods

Inherited Variables

Class: parserSourceInlineTag

Class: parserInlineTag

Class: parserBase

Inherited Methods

Class: parserSourceInlineTag

Class: parserInlineTag

Class: parserBase

Class Details

Tags:

Class Methods

constructor parserExampleInlineTag [line 582]

Tags:

Parameters:

method arrayConvert [line 733]

Tags:

Parameters:

method getProgramListing [line 752]

method setSource [line 719]

Parameters:

PHP5

Для web разработчика

Nov 21Docs For Class parserExampleInlineTag

Class: parserExampleInlineTag

Class Overview

Author(s):

Version:

Copyright:

Methods

Inherited Variables

Class: parserSourceInlineTag

Class: parserInlineTag

Class: parserBase

Inherited Methods

Class: parserSourceInlineTag

Class: parserInlineTag

Class: parserBase

Class Details

Tags:

Class Methods

constructor parserExampleInlineTag [line 582]

Tags:

Parameters:

method arrayConvert [line 733]

Tags:

Parameters:

method getProgramListing [line 752]

method setSource [line 719]

Parameters:

Nov 21
Docs For Class parserExampleInlineTag