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

Source Location: /phpDocumentor/DocBlockTags.inc

Class Overview

parserBase
   |
   --parserStringWithInlineTags
      |
      --parserTag
         |
         --parserFileSourceTag

represents "@filesource"

Author(s):

Greg Beaver <cellog@php.net>

Version:

Release: @VER@

Copyright:

2002-2008 Gregory Beaver

Variables

Methods

Child classes:

parserExampleTag: represents "@example"

Inherited Variables

Class: parserTag

parserTag::$type

Class: parserStringWithInlineTags

parserStringWithInlineTags::$value

Inherited Methods

Class: parserTag

parserTag::parserTag(): Set up the tag
parserTag::Convert(): Perform the output conversion on this parserTag using the output converter that is passed in
parserTag::getString(): Returns the text minus any inline tags
parserTag::HandleEvent(): Called by the parserDescParser when processing a description.

Class: parserStringWithInlineTags

parserStringWithInlineTags::add(): equivalent to the . operator ($a = $b . $c)
parserStringWithInlineTags::Convert(): Use to convert the string to a real string with all inline tags parsed and linked
parserStringWithInlineTags::getString(): return the string unconverted (all inline tags are taken out - this should only be used in pre-parsing to see if any other text is in the string)
parserStringWithInlineTags::hasInlineTag(): Determine whether the string contains any inline tags
parserStringWithInlineTags::setSource(): Pass source code to any {@source} tags contained within the string for later conversion.
parserStringWithInlineTags::trimmedStrlen(): equivalent to trim(strlen($string))

Class: parserBase

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

Class Details

[line 1061]
represents "@filesource"

Use this to create a link to a highlighted phpxref-style source file listing

Tags:

tutorial:	@filesource
author:	Greg Beaver <cellog@php.net>
version:	Release: @VER@
copyright:	2002-2008 Gregory Beaver
link:	http://pear.php.net/PhpDocumentor
link:	http://www.phpdoc.org
todo:	CS cleanup - change package to PhpDocumentor
todo:	CS cleanup - change classname to PhpDocumentor_*
since:	1.2
license:	LGPL

[ Top ]

Class Variables

$keyword = 'filesource'

[line 1067]

Always "filesource"

Type:	string
Overrides:	Array

[ Top ]

$path =

[line 1075]

Type:

string

[ Top ]

$source =

[line 1071]

Type:

array

[ Top ]

Class Methods

constructor parserFileSourceTag [line 1090]

parserFileSourceTag parserFileSourceTag(
string
$filepath, array
$value)

Set $source to $value, and set up path

Parameters:

string	$filepath	the file's path
array	$value	output from phpDocumentorTWordParser::getFileSource()

[ Top ]

method Convert [line 1106]

string Convert(
Converter
&$c)

Return a link to the highlighted source and generate the source

Tags:

return:	output from getSourceLink()
todo:	CS cleanup - rename to convert for camelCase rule
uses:	parserFileSourceTag::ConvertSource() - generate source code and write it out

Overrides parserTag::Convert() (Perform the output conversion on this parserTag using the output converter that is passed in)

Parameters:

Converter

&$c

the output converter

[ Top ]

method ConvertSource [line 1124]

void ConvertSource(
Converter
&$c)

convert the source code

Tags:

todo:	CS cleanup - rename to convertSource for camelCase rule
todo:	what's up with all the "return" statements? can they _all_ be removed?
usedby:	parserFileSourceTag::Convert() - generate source code and write it out
uses:	parserFileSourceTag::writeSource()
uses:	phpDocumentor_HighlightParser - highlights source code

Overridden in child classes as:

parserExampleTag::ConvertSource(): convert the source code

Parameters:

Converter

&$c

the output converter

[ Top ]

method getSourceLink [line 1158]

output getSourceLink(
Converter
&$c)

gets path to the sourcecode file

Tags:

return:	from getSourceLink()
uses:	Converter::getSourceLink()

Overridden in child classes as:

parserExampleTag::getSourceLink(): Retrieve a converter-specific link to the example

Parameters:

Converter

&$c

the output converter

[ Top ]

method writeSource [line 1145]

void writeSource(
Converter
&$c, string
$source)

have the output converter write the source code

Tags:

usedby:	parserExampleTag::ConvertSource()
usedby:	parserFileSourceTag::ConvertSource()
uses:	Converter::writeSource() - export highlighted file source

Parameters:

Converter	&$c	the output converter
string	$source	highlighted source code

[ Top ]

PHP5

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

Dec 21
Docs For Class parserFileSourceTag

Class: parserFileSourceTag

Class Overview

Author(s):

Version:

Copyright:

Variables

Methods

Child classes:

Inherited Variables

Class: parserTag

Class: parserStringWithInlineTags

Inherited Methods

Class: parserTag

Class: parserStringWithInlineTags

Class: parserBase

Class Details

Tags:

Class Variables

$keyword = 'filesource'

$path =

$source =

Class Methods

constructor parserFileSourceTag [line 1090]

Parameters:

method Convert [line 1106]

Tags:

Parameters:

method ConvertSource [line 1124]

Tags:

Parameters:

method getSourceLink [line 1158]

Tags:

Parameters:

method writeSource [line 1145]

Tags:

Parameters:

PHP5

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

Dec 21Docs For Class parserFileSourceTag

Class: parserFileSourceTag

Class Overview

Author(s):

Version:

Copyright:

Variables

Methods

Child classes:

Inherited Variables

Class: parserTag

Class: parserStringWithInlineTags

Inherited Methods

Class: parserTag

Class: parserStringWithInlineTags

Class: parserBase

Class Details

Tags:

Class Variables

$keyword = 'filesource'

$path =

$source =

Class Methods

constructor parserFileSourceTag [line 1090]

Parameters:

method Convert [line 1106]

Tags:

Parameters:

method ConvertSource [line 1124]

Tags:

Parameters:

method getSourceLink [line 1158]

Tags:

Parameters:

method writeSource [line 1145]

Tags:

Parameters:

Dec 21
Docs For Class parserFileSourceTag