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 <cellog@php.net>
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. ?>