phpDocumentor
[ class tree: phpDocumentor ] [ index: phpDocumentor ] [ all elements ]
Packages:
phpDocumentor
Converters


Tutorials/Manuals:
Package-level: Files:
actions.php
bug-560532.php
bug-772441.php
builder.php
Classes.inc
clone.inc.php
clone5.inc.php
common.inc.php
config.php
EventStack.inc
file_dialog.php
HighlightParserTests.php
IntermediateParser.inc
IntermediateParserTests.php
Io.inc
new_phpdoc.php
ParserClassTests.php
ParserDescCleanup.inc
ParserPageTests.php
phpdoc.inc
phpdoc.php
phpDocumentorSetupTests.php
phpDocumentorTParserTests.php
ProceduralPages.inc
Publisher.inc
Setup.inc.php
top.php
utilities.php

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
bug_772441
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

Source code for sample3.php

phpDocumentor for newbies tutorial

Gregory Beaver

sample3.php

  1. <?php
  2. /**
  3. * Sample File 3, phpDocumentor Quickstart
  4. *
  5. * This file demonstrates the use of the @name tag
  6. * @author Greg Beaver <[email protected]>
  7. * @version 1.0
  8. * @package sample
  9. */
  10. /**
  11. * Special global variable declaration DocBlock
  12. * @global integer $GLOBALS['_myvar']
  13. */
  14. $GLOBALS['_myvar'] = 6;
  15. /**
  16. * Notice that the @name tag does not validate what you give it!
  17. * @global string $GLOBALS['turkey']
  18. * @name $turkify
  19. */
  20. $GLOBALS['turkey'] = 'tester';
  21. /**
  22. * Sample function @global usage
  23. *
  24. * Note that the $turkey variable is not linked to its documentation at
  25. * {@link $turkify} because of the improper @name tag
  26. * @global integer
  27. * @global string this one has the optional description
  28. */
  29. function testit()
  30. {
  31. global $_myvar, $turkey;
  32. }
  33. ?>

Source code for sample2.php phpDocumentor Quickstart phpDocumentor Tutorial

Documentation generated on 2011年12月06日 07:09:29 -0600 by phpDocumentor 1.4.4

AltStyle によって変換されたページ (->オリジナル) /