Skip to content

Commit 4d0a0a2

Browse files
jens1ofelixfbecker
jens1o
authored and
felixfbecker
committed
show anything from a doc comment block (#315)
1 parent 546660f commit 4d0a0a2

File tree

3 files changed

+50
-8
lines changed

3 files changed

+50
-8
lines changed

‎src/DefinitionResolver.php‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,14 @@ public function getDocumentationFromNode(Node $node)
8989
} else {
9090
$docBlock = $node->getAttribute('docBlock');
9191
if ($docBlock !== null) {
92-
return $docBlock->getSummary();
92+
// check wether we have a description, when true, add a new paragraph
93+
// with the description
94+
$description = $docBlock->getDescription()->render();
95+
96+
if (empty($description)) {
97+
return $docBlock->getSummary();
98+
}
99+
return $docBlock->getSummary() . "\n\n" . $description;
93100
}
94101
}
95102
}

‎tests/Server/TextDocument/CompletionTest.php‎

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,12 @@ public function testNewInNamespace()
160160
'TestClass',
161161
CompletionItemKind::CLASS_,
162162
null,
163-
'Pariatur ut laborum tempor voluptate consequat ea deserunt.',
163+
'Pariatur ut laborum tempor voluptate consequat ea deserunt.' . "\n\n" .
164+
'Deserunt enim minim sunt sint ea nisi. Deserunt excepteur tempor id nostrud' . "\n" .
165+
'laboris commodo ad commodo velit mollit qui non officia id. Nulla duis veniam' . "\n" .
166+
'veniam officia deserunt et non dolore mollit ea quis eiusmod sit non. Occaecat' . "\n" .
167+
'consequat sunt culpa exercitation pariatur id reprehenderit nisi incididunt Lorem' . "\n" .
168+
'sint. Officia culpa pariatur laborum nostrud cupidatat consequat mollit.',
164169
null,
165170
null,
166171
'\TestClass'
@@ -179,7 +184,12 @@ public function testNewInNamespace()
179184
'TestClass',
180185
CompletionItemKind::CLASS_,
181186
'TestNamespace',
182-
'Pariatur ut laborum tempor voluptate consequat ea deserunt.',
187+
'Pariatur ut laborum tempor voluptate consequat ea deserunt.' . "\n\n" .
188+
'Deserunt enim minim sunt sint ea nisi. Deserunt excepteur tempor id nostrud' . "\n" .
189+
'laboris commodo ad commodo velit mollit qui non officia id. Nulla duis veniam' . "\n" .
190+
'veniam officia deserunt et non dolore mollit ea quis eiusmod sit non. Occaecat' . "\n" .
191+
'consequat sunt culpa exercitation pariatur id reprehenderit nisi incididunt Lorem' . "\n" .
192+
'sint. Officia culpa pariatur laborum nostrud cupidatat consequat mollit.',
183193
null,
184194
null,
185195
'TestClass'
@@ -209,7 +219,12 @@ public function testUsedClass()
209219
'TestClass',
210220
CompletionItemKind::CLASS_,
211221
'TestNamespace',
212-
'Pariatur ut laborum tempor voluptate consequat ea deserunt.'
222+
'Pariatur ut laborum tempor voluptate consequat ea deserunt.' . "\n\n" .
223+
'Deserunt enim minim sunt sint ea nisi. Deserunt excepteur tempor id nostrud' . "\n" .
224+
'laboris commodo ad commodo velit mollit qui non officia id. Nulla duis veniam' . "\n" .
225+
'veniam officia deserunt et non dolore mollit ea quis eiusmod sit non. Occaecat' . "\n" .
226+
'consequat sunt culpa exercitation pariatur id reprehenderit nisi incididunt Lorem' . "\n" .
227+
'sint. Officia culpa pariatur laborum nostrud cupidatat consequat mollit.'
213228
)
214229
], true), $items);
215230
}
@@ -347,7 +362,12 @@ public function testFullyQualifiedClass()
347362
'TestClass',
348363
CompletionItemKind::CLASS_,
349364
null,
350-
'Pariatur ut laborum tempor voluptate consequat ea deserunt.',
365+
'Pariatur ut laborum tempor voluptate consequat ea deserunt.' . "\n\n" .
366+
'Deserunt enim minim sunt sint ea nisi. Deserunt excepteur tempor id nostrud' . "\n" .
367+
'laboris commodo ad commodo velit mollit qui non officia id. Nulla duis veniam' . "\n" .
368+
'veniam officia deserunt et non dolore mollit ea quis eiusmod sit non. Occaecat' . "\n" .
369+
'consequat sunt culpa exercitation pariatur id reprehenderit nisi incididunt Lorem' . "\n" .
370+
'sint. Officia culpa pariatur laborum nostrud cupidatat consequat mollit.',
351371
null,
352372
null,
353373
'TestClass'

‎tests/Server/TextDocument/HoverTest.php‎

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,12 @@ public function testHoverForClassLike()
2222
)->wait();
2323
$this->assertEquals(new Hover([
2424
new MarkedString('php', "<?php\nclass TestClass implements \\TestInterface"),
25-
'Pariatur ut laborum tempor voluptate consequat ea deserunt.'
25+
'Pariatur ut laborum tempor voluptate consequat ea deserunt.' . "\n\n" .
26+
'Deserunt enim minim sunt sint ea nisi. Deserunt excepteur tempor id nostrud' . "\n" .
27+
'laboris commodo ad commodo velit mollit qui non officia id. Nulla duis veniam' . "\n" .
28+
'veniam officia deserunt et non dolore mollit ea quis eiusmod sit non. Occaecat' . "\n" .
29+
'consequat sunt culpa exercitation pariatur id reprehenderit nisi incididunt Lorem' . "\n" .
30+
'sint. Officia culpa pariatur laborum nostrud cupidatat consequat mollit.'
2631
], $reference->range), $result);
2732
}
2833

@@ -37,7 +42,12 @@ public function testHoverForClassLikeDefinition()
3742
)->wait();
3843
$this->assertEquals(new Hover([
3944
new MarkedString('php', "<?php\nclass TestClass implements \\TestInterface"),
40-
'Pariatur ut laborum tempor voluptate consequat ea deserunt.'
45+
'Pariatur ut laborum tempor voluptate consequat ea deserunt.' . "\n\n" .
46+
'Deserunt enim minim sunt sint ea nisi. Deserunt excepteur tempor id nostrud' . "\n" .
47+
'laboris commodo ad commodo velit mollit qui non officia id. Nulla duis veniam' . "\n" .
48+
'veniam officia deserunt et non dolore mollit ea quis eiusmod sit non. Occaecat' . "\n" .
49+
'consequat sunt culpa exercitation pariatur id reprehenderit nisi incididunt Lorem' . "\n" .
50+
'sint. Officia culpa pariatur laborum nostrud cupidatat consequat mollit.'
4151
], $definition->range), $result);
4252
}
4353

@@ -181,7 +191,12 @@ public function testHoverForThis()
181191
$result = $this->textDocument->hover(new TextDocumentIdentifier($uri), new Position(59, 11))->wait();
182192
$this->assertEquals(new Hover([
183193
new MarkedString('php', "<?php\nclass TestClass implements \\TestInterface"),
184-
'Pariatur ut laborum tempor voluptate consequat ea deserunt.'
194+
'Pariatur ut laborum tempor voluptate consequat ea deserunt.' . "\n\n" .
195+
'Deserunt enim minim sunt sint ea nisi. Deserunt excepteur tempor id nostrud' . "\n" .
196+
'laboris commodo ad commodo velit mollit qui non officia id. Nulla duis veniam' . "\n" .
197+
'veniam officia deserunt et non dolore mollit ea quis eiusmod sit non. Occaecat' . "\n" .
198+
'consequat sunt culpa exercitation pariatur id reprehenderit nisi incididunt Lorem' . "\n" .
199+
'sint. Officia culpa pariatur laborum nostrud cupidatat consequat mollit.'
185200
], new Range(new Position(59, 8), new Position(59, 13))), $result);
186201
}
187202
}

0 commit comments

Comments
 (0)