forked from phpDocumentor/phpDocumentor
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathDocBlockFixture.php
More file actions
136 lines (122 loc) · 3.19 KB
/
Copy pathDocBlockFixture.php
File metadata and controls
136 lines (122 loc) · 3.19 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
<?php
/**
* phpDocumentor
*
* PHP Version 5
*
* @category phpDocumentor
* @package Transformer
* @subpackage Unit_tests
* @author Mike van Riel <mike.vanriel@naenius.com>
* @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com)
* @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org
*/
/**
* Fixture file for different DocBlock tests.
*
* @category phpDocumentor
* @package Transformer
* @subpackage Unit_tests
* @author Mike van Riel <mike.vanriel@naenius.com>
* @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org
*/
class phpDocumentor_Tests_Data_DocBlockFixture
{
/*
* The class docblock has two lines of short description AND the short description ends with a space.
*/
/**
*
*/
public static function EmptyDocBlock(ArrayObject $object)
{
// test a method with an empty docblock
}
/** */
public static function ReallyEmptyDocBlock(ArrayObject $object)
{
// test a method with the smallest thinkable docblock
}
/**
* Single line docblock.
*/
public static function SingleLineDocBlock(ArrayObject $object)
{
// test a method with an empty docblock
}
/** Single line docblock. */
public static function SingleLineDocBlock2(ArrayObject $object)
{
// test a method with an empty docblock
}
/**
* Single line docblock.
* Long description.
*/
public static function SimpleDocBlockWithLD(ArrayObject $object)
{
// test a method with an empty docblock
}
/**
* This docblock is the ideal situation, short descriptions are single line and closed with a point.
*
* The long description is separated a whiteline away and has a trailing whiteline. After which each
* tag 'group' is separated by a whiteline.
*
* @static
*
* @param ArrayObject $object Ideally.
*
* @return string
*/
public static function IdealDocBlock(ArrayObject $object)
{
}
/**
* This docblock is invalid because the short description 'does not end'
* @static
* @param ArrayObject $object
* @return string
*/
public static function DocBlockWithInvalidShortDescription($object)
{
/*
* This Docblock's short description does not end with a . or with a double space and thus
* should be invalid. We allow it by noticing that there are tags following.
*/
}
/**
* This DocBlock tests whether the @link tag is correctly taken and shown.
*
* @link http://www.phpdoc.org
*
* @return void
*/
public static function DocBlockWithLinkTag()
{
}
/**
* This tests whether a custom tag with hypen is interpreted
*
* @custom-tag This is a custom tag
*
* @return void
*/
public static function DocBlockWithTagWithHyphen()
{
}
/**
* This docblock will contain an inline tag to test whether it still crashes.
*
* This is a test {@link} with an inline tag.
*
* @static
*
* @return void
*/
public static function DocBlockWithInlineTag()
{
}
}