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: parserSourceInlineTag

Source Location: /phpDocumentor/InlineTags.inc

Class Overview

parserBase
   |
   --parserInlineTag
      |
      --parserSourceInlineTag

represents inline source tag, used for function/method source

Author(s):

Gregory Beaver <cellog@php.net>

Version:

Release: @VER@

Copyright:

2002-2008 Gregory Beaver

Variables

Methods

Child classes:

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

Inherited Variables

Class: parserInlineTag

parserInlineTag::$type

Class: parserBase

parserBase::$value

Inherited Methods

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 377]
represents inline source tag, used for function/method source

Tags:

tutorial:	inline {@source}
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 Variables

$end = '*'

[line 395]

Last line to display

Tags:

var:

If '*' then the whole source will be used, otherwise the $start to $end line numbers will be displayed

Type:

'*'|integer

[ Top ]

$inlinetype = 'source'

[line 383]

always 'source'

Type:	string
Overrides:	Array

[ Top ]

$source = false

[line 401]

tokenized source organized by line numbers for php 4.3.0+, the old

{@source} tag used a string

Type:

string|array

[ Top ]

$start = 1

[line 389]

First line of source code to display

Tags:

see:

parserSourceInlineTag::$end

Type:

integer

[ Top ]

Class Methods

constructor parserSourceInlineTag [line 414]

parserSourceInlineTag parserSourceInlineTag(
string
$value)

constructor

Parameters:

string

$value

format "start [end]", where start and end are line numbers with the end line number optional

[ Top ]

method arrayConvert [line 497]

string arrayConvert(
Converter
&$c)

converter helper used in PHP 4.3.0+

Tags:

usedby:	parserSourceInlineTag::Convert() - in PHP 4.3.0+, this method is used to convert
uses:	phpDocumentor_HighlightParser - Parses the tokenized source

Overridden in child classes as:

parserExampleInlineTag::arrayConvert(): converter helper for PHP 4.3.0+

Parameters:

Converter

&$c

the output converter object

[ Top ]

method Convert [line 481]

string Convert(
Converter
&$c)

convert the tag

Tags:

todo:	CS cleanup - rename to convert for camelCase rule
uses:	parserSourceInlineTag::stringConvert() - in PHP 4.2.3-, this method is used to convert
uses:	parserSourceInlineTag::arrayConvert() - in PHP 4.3.0+, this method is used to convert

Parameters:

Converter

&$c

the output converter object

[ Top ]

method getString [line 444]

string getString(
)

gets the source string

Overrides parserInlineTag::getString() (always gets an empty string)

[ Top ]

method setSource [line 459]

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

sets the source tag's value

Overridden in child classes as:

parserExampleInlineTag::setSource(): sets the source

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 ]

method stringConvert [line 520]

string stringConvert(
Converter
&$c)

converter helper used in PHP 4.2.3-

Tags:

deprecated:	in favor of PHP 4.3.0+ arrayConvert()
usedby:	parserSourceInlineTag::Convert() - in PHP 4.2.3-, this method is used to convert
uses:	Converter::unmangle() - remove the extraneous stuff from http://www.php.net/highlight_string

Parameters:

Converter

&$c

the output converter object

[ Top ]

method Strlen [line 434]

int Strlen(
)

only used to determine blank lines. {@source} will not be blank, probably

Overrides parserInlineTag::Strlen() (get length of the tag)

[ Top ]

PHP5

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

Dec 21Docs For Class parserSourceInlineTag

Class: parserSourceInlineTag

Class Overview

Author(s):

Version:

Copyright:

Variables

Methods

Child classes:

Inherited Variables

Class: parserInlineTag

Class: parserBase

Inherited Methods

Class: parserInlineTag

Class: parserBase

Class Details

Tags:

Class Variables

$end = '*'

Tags:

$inlinetype = 'source'

$source = false

$start = 1

Tags:

Class Methods

constructor parserSourceInlineTag [line 414]

Parameters:

method arrayConvert [line 497]

Tags:

Parameters:

method Convert [line 481]

Tags:

Parameters:

method getString [line 444]

method setSource [line 459]

Parameters:

method stringConvert [line 520]

Tags:

Parameters:

method Strlen [line 434]

Dec 21
Docs For Class parserSourceInlineTag