[ ] [ ] [ ]

Packages:
PhpDocumentor
Converters
Cpdf
HTML_TreeMenu
phpDocumentor
Smarty
tests
XML_Beautifier

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

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

DescHTML
   parserB
   parserBr
   parserCode
   parserDescVar
   parserI
   parserKbd
   parserList
   parserPre
   parserSamp

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

Files:

actions.php
add_cvs.php
builder.php
Classes.inc
common.inc.php
config.php
create_examples.php
EventStack.inc
file_dialog.php
IntermediateParser.inc
Io.inc
new_phpdoc.php
phpdoc.inc
phpdoc.php
ProceduralPages.inc
Publisher.inc
Setup.inc.php
top.php
utilities.php

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
ParserDescCleanup.inc
phpDocumentorTParser.inc
phpDocumentorTWordParser.inc
Tokenizer.php
TutorialHighlightParser.inc
XMLpackagePageParser.inc

subpackage setup

find_phpdoc.php

subpackage Tutorial

PackagePageElements.inc

subpackage WordParsers

Class: parserInlineTag

Source Location: /PhpDocumentor-1.3.2/phpDocumentor/InlineTags.inc

Class Overview

parserBase
   |
   --parserInlineTag

Use this element to represent an {@inline tag} like {@link}

Author(s):

Greg Beaver <cellog at users.sourceforge.net>

Version:

$Revision: 1.6 $

Variables

Methods

Child classes:

parserLinkInlineTag: represents inline links

parserSourceInlineTag: represents inline source tag, used for function/method source

parserInheritdocInlineTag: Represents the inheritdoc inline tag, used by classes/methods/vars to inherit

parserIdInlineTag: Represents the inline {@id} tag for tutorials

parserTocInlineTag: Represents {@toc} for table of contents generation in tutorials

Inherited Variables

Class: parserBase

parserBase::$value

Inherited Methods

Class: parserBase

parserBase::getType()
parserBase::getValue()
parserBase::setValue()

Class Details

[line 49]
Use this element to represent an {@inline tag} like {@link}

Tutorial: phpDocumentor Inline tags
Author: Greg Beaver <cellog@users.sourceforge.net>
Version: $Revision: 1.6 $
See: parserStringWithInlineTags
Since: 1.0rc1

[ Top ]

Class Variables

$inlinetype = ''

[line 67]

the name of the inline tag (like link)

Type:

string

[ Top ]

$type = 'inlinetag'

[line 62]

Element type

Type is used by many functions to skip the hassle of

 if phpDocumentor_get_class($blah) == 'parserBlah'

always "inlinetag"

Type:	string
Overrides:	Array

[ Top ]

Method Detail

parserInlineTag (Constructor) [line 73]

parserInlineTag parserInlineTag(
string
$type, string
$value)

Parameters:

string	`$type`	—	tag type (example: link)
string	`$value`	—	tag value (example: what to link to)

[ Top ]

getString [line 99]

string getString(
)

Return: always '', used by Parser::handleDocBlock() to calculate the short description of a DocBlock
See: parserStringWithInlineTags::getString()
See: parserStringWithInlineTags::trimmedStrlen()
Usedby: parserStringWithInlineTags::getString() - removes inline tag length, as it is indeterminate until conversion.

Overridden in child classes as:

parserSourceInlineTag::getString()

[ Top ]

Strlen [line 82]

integer Strlen(
)

Return: length of the tag

Overridden in child classes as:

parserSourceInlineTag::Strlen(): only used to determine blank lines. {@source} will not be blank,

[ Top ]

Documentation generated on Mon, 11 Mar 2019 14:58:50 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.