phpDocumentor

[ ] [ ] [ ]

Packages:
PhpDocumentor
apidoc
Converters
HTML_TreeMenu
Pdf-php
PEAR
phpDocumentor
Smarty
tests

Tutorials/Manuals:
Package-level:

phpDocumentor Guide to Creating Fantastic Documentation
- phpDocumentor 1.2.0 Manual
  - phpDocumentor 1.2.0 Tutorial
    - Documentable PHP Elements
    - phpDocumentor Tutorials
  - phpDocumentor tags
    - @access
    - @author
    - @copyright
    - @deprecated
    - @example
    - @filesource
    - @global
    - @ignore
    - @internal
    - @link
    - @name
    - @package
    - @param
    - @return
    - @see
    - @since
    - @static
    - @staticvar
    - @subpackage
    - @todo
    - @tutorial
    - @uses
    - @var
    - @version
  - phpDocumentor Inline tags
    - inline {@id}
    - inline {@internal}}
    - inline {@inheritdoc}
    - inline {@link}
    - inline {@source}
    - inline {@toc}
    - inline {@tutorial}

Files:

Classes.inc
common.inc.php
create_examples.php
EventStack.inc
IntermediateParser.inc
Io.inc
new_phpdoc.php
phpdoc.inc
phpdoc.php
ProceduralPages.inc
Publisher.inc
Template.inc
WordParser.inc

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

Parser.inc
ParserDescCleanup.inc
phpDocumentorTParser.inc
XMLpackagePageParser.inc

subpackage Tutorial

PackagePageElements.inc

Classes:

Classes
EventStack
Io
phpDocumentor_IntermediateParser
phpDocumentor_setup
ProceduralPages
Publisher
Template

DescHTML
   parserB
   parserBr
   parserCode
   parserI
   parserList
   parserPre

PhpDocumentor-1.2.0beta2
   classLink
   defineLink
   DirNode
   functionLink
   globalLink
   methodLink
   pageLink
   parserAccessTag
   parserClass
   parserDefine
   parserElement
   parserExampleTag
   parserFileSourceTag
   parserFunction
   parserGlobal
   parserIdInlineTag
   parserInclude
   parserInheritdocInlineTag
   parserLinkInlineTag
   parserLinkTag
   parserMethod
   parserNameTag
   parserPackagePage
   parserParamTag
   parserReturnTag
   parserSeeTag
   parserSourceInlineTag
   parserSourceTag
   parserStaticvarTag
   parserStringWithInlineTags
   parserTocInlineTag
   parserTutorial
   parserTutorialInlineTag
   parserTutorialTag
   parserUsedByTag
   parserUsesTag
   parserVar
   parserVarTag
   phpDocumentorTWordParser
   RecordException
   tutorialLink
   varLink

DocBlockTags
parserTag

Errors
   ErrorTracker
   RecordError
   RecordWarning

InlineTags
parserInlineTag

Links
abstractLink

Tutorial
parserCData
parserXMLDocBookTag

Parsers
   Parser
   parserDescParser
   phpDocumentorTParser
   ppageParser
   XMLPackagePageParser

ParserData
   parserBase
   parserData
   parserPage

WordParsers
ObjectWordParser
WordParser

ParserDocBlock
parserDesc
parserDocBlock

Class: parserLinkInlineTag

Source Location: /PhpDocumentor-1.2.0beta2/phpDocumentor/InlineTags.inc

Class Overview

parserBase
   |
   --parserInlineTag
      |
      --parserLinkInlineTag

represents inline links

Author(s):

Greg Beaver <mailto:cellog at users.sourceforge.net>

Version:

$Id: InlineTags.inc,v 1.4 2003/01/02 06:28:48 CelloG Exp $

Variables

$linktext

Methods

Child classes:

parserTutorialInlineTag: represents inline links

Inherited Variables

Class: parserInlineTag

parserInlineTag::$inlinetype
parserInlineTag::$type

Class: parserBase

parserBase::$linenum
parserBase::$value

Inherited Methods

Class: parserInlineTag

parserInlineTag::parserInlineTag()
parserInlineTag::getString()
parserInlineTag::Strlen()

Class: parserBase

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

Class Details

[line 66]
represents inline links

Version: $Id: InlineTags.inc,v 1.4 2003/01/02 06:28:48 CelloG Exp $
Since: 1.0rc1
Author: Greg Beaver <mailto:cellog@users.sourceforge.net>

[ Top ]

Class Variables

$linktext = ''

[line 72]

text to display in the link, can be different from the link for standard links like websites

Type:

string

[ Top ]

Method Detail

parserLinkInlineTag (Constructor) [line 78]

parserLinkInlineTag parserLinkInlineTag(
string
$link, string
$text)

Parameters:

string	`$link`	—	stored in $value, see parserBase::$value
string	`$text`	—	see $linktext

[ Top ]

Convert [line 88]

mixed Convert(
Converter
&$c)

Return: returns the converted link or false if not converted successfully

Overridden in child classes as:

parserTutorialInlineTag::Convert()

Parameters:

Converter &$c — converter used to change the abstract link into text for display

[ Top ]

Documentation generated on Fri, 30 Apr 2004 22:10:06 +0200 by phpDocumentor 1.2.3. PEAR Logo Copyright © PHP Group 2004.