1: <?php
 2: 
 3: /**
 4:  * ApiGenerator.org
 5:  * Copyright (C) 2013 Tristan Lins
 6:  *
 7:  * PHP version 5
 8:  *
 9:  * @copyright  bit3 UG 2013
10:  * @author     Tristan Lins <tristan.lins@bit3.de>
11:  * @package    apigenerator
12:  * @license    LGPL-3.0+
13:  * @filesource
14:  */
15: 
16: /**
17:  * This is an example class.
18:  */
19: class Example
20: {
21:     /**
22:      * Return the input value $bar.
23:      *
24:      * @param string $bar
25:      *
26:      * @return string
27:      */
28:     public function foo($bar = 'zap')
29:     {
30:         return $bar;
31:     }
32:     
33:     /**
34:      * Return the opposite of bar.
35:      *
36:      * @return string
37:      */
38:     protected function bar()
39:     {
40:         return 'foo';
41:     }
42:     
43:     /**
44:      * Give you a "Hello world!".
45:      *
46:      * @param string $return
47:      */
48:     private function zap(&$return)
49:     {
50:         $return = 'Hello world!';
51:     }
52:     
53:     /**
54:      * This is an internal method!
55:      *
56:      * @internal
57:      */
58:     public function internal()
59:     {
60:         throw new Exception('I\'m internal!');
61:     }
62:     
63:     /**
64:      * This is a deprecated method!
65:      *
66:      * @deprecated
67:      */
68:     public function deprecated()
69:     {
70:         throw new Exception('I\'m deprecated!');
71:     }
72:     
73:     /**
74:      * This is a incomplete method!
75:      *
76:      * @todo I'm incomplete
77:      * @incomplete
78:      */
79:     public function incomplete()
80:     {
81:         // TODO I'm incomplete
82:     }
83: }
84: