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
137
138
139
140
141
142
143
144
145
146
147
148
|
<?php
use MediaWiki\Maintenance\MWDoxygenFilter;
/**
* @covers \MediaWiki\Namespace\MWDoxygenFilter
*/
class MWDoxygenFilterTest extends \PHPUnit\Framework\TestCase {
public static function provideFilter() {
yield 'No @var' => [
<<<'CODE'
<?php class MyClass {
/** Some Words here */
protected $name;
}
CODE
];
yield 'One-line var with type' => [
<<<'CODE'
<?php class MyClass {
/** @var SomeType */
protected $name;
}
CODE
, <<<'CODE'
<?php class MyClass {
/** */
protected SomeType $name;
}
CODE
];
yield 'One-line var with type and description' => [
<<<'CODE'
<?php class MyClass {
/** @var SomeType Some description */
protected $name;
}
CODE
, <<<'CODE'
<?php class MyClass {
/** Some description */
protected SomeType $name;
}
CODE
];
yield 'One-line var with type and description that starts like a variable name' => [
<<<'CODE'
<?php class MyClass {
/** @var array $_GET data from some thing */
protected $name;
}
CODE
, <<<'CODE'
<?php class MyClass {
/** $_GET data from some thing */
protected array $name;
}
CODE
];
yield 'One-line var with type, name, and description' => [
// In this full form, Doxygen understands it just fine.
// No changes made.
<<<'CODE'
<?php class MyClass {
/** @var SomeType $name Some description */
protected $name;
}
CODE
];
yield 'Multi-line var with type' => [
<<<'CODE'
<?php class MyClass {
/**
* @var SomeType
*/
protected $name;
}
CODE
, <<<'CODE'
<?php class MyClass {
/**
*
*/
protected SomeType $name;
}
CODE
];
yield 'Multi-line var with type and description' => [
<<<'CODE'
<?php class MyClass {
/**
* Some description
* @var SomeType
*/
protected $name;
}
CODE
, <<<'CODE'
<?php class MyClass {
/**
* Some description
*
*/
protected SomeType $name;
}
CODE
];
yield 'Multi-line var with type, name, and description' => [
<<<'CODE'
<?php class MyClass {
/**
* Some description
* @var SomeType $name
*/
protected $name;
}
CODE
, <<<'CODE'
<?php class MyClass {
/**
* Some description
* @var SomeType $name
*/
protected $name;
}
CODE
];
}
/**
* @dataProvider provideFilter
*/
public function testFilter( $source, $expected = null ) {
$this->assertSame(
$expected ?? $source,
MWDoxygenFilter::filter( $source ),
'Source code'
);
}
}
|
