From a646ef8cdc05f56f8ea23290616707341642c9e8 Mon Sep 17 00:00:00 2001 From: Jens Hausdorf Date: Fri, 24 Feb 2017 12:59:02 +0100 Subject: [PATCH 01/10] show anything from a doc comment block --- src/DefinitionResolver.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/DefinitionResolver.php b/src/DefinitionResolver.php index ec295a53..3d9f117a 100644 --- a/src/DefinitionResolver.php +++ b/src/DefinitionResolver.php @@ -89,7 +89,7 @@ public function getDocumentationFromNode(Node $node) } else { $docBlock = $node->getAttribute('docBlock'); if ($docBlock !== null) { - return $docBlock->getSummary(); + return $docBlock->getDescription(); } } } From f22cfddf9f9a43130ad3f6590efb8380b6e9628d Mon Sep 17 00:00:00 2001 From: Jens Hausdorf Date: Fri, 24 Feb 2017 13:04:14 +0100 Subject: [PATCH 02/10] concat, not just the description --- src/DefinitionResolver.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/DefinitionResolver.php b/src/DefinitionResolver.php index 3d9f117a..5bb1d0c3 100644 --- a/src/DefinitionResolver.php +++ b/src/DefinitionResolver.php @@ -89,7 +89,7 @@ public function getDocumentationFromNode(Node $node) } else { $docBlock = $node->getAttribute('docBlock'); if ($docBlock !== null) { - return $docBlock->getDescription(); + return $docBlock->getSummary() . "\n" . $docBlock->getDescription(); } } } From ebcfcd978da537345628e277615540c3db2eb72d Mon Sep 17 00:00:00 2001 From: Jens Hausdorf Date: Fri, 24 Feb 2017 13:08:52 +0100 Subject: [PATCH 03/10] double line break --- src/DefinitionResolver.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/DefinitionResolver.php b/src/DefinitionResolver.php index 5bb1d0c3..645654ca 100644 --- a/src/DefinitionResolver.php +++ b/src/DefinitionResolver.php @@ -89,7 +89,7 @@ public function getDocumentationFromNode(Node $node) } else { $docBlock = $node->getAttribute('docBlock'); if ($docBlock !== null) { - return $docBlock->getSummary() . "\n" . $docBlock->getDescription(); + return $docBlock->getSummary() . "\n\n" . $docBlock->getDescription(); } } } From 49187c18aef859cf1c824b171ddff6db96d1f6e4 Mon Sep 17 00:00:00 2001 From: Jens Hausdorf Date: Fri, 24 Feb 2017 13:18:17 +0100 Subject: [PATCH 04/10] only insert newlines when there actually is a description --- src/DefinitionResolver.php | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/src/DefinitionResolver.php b/src/DefinitionResolver.php index 645654ca..42089694 100644 --- a/src/DefinitionResolver.php +++ b/src/DefinitionResolver.php @@ -89,7 +89,11 @@ public function getDocumentationFromNode(Node $node) } else { $docBlock = $node->getAttribute('docBlock'); if ($docBlock !== null) { - return $docBlock->getSummary() . "\n\n" . $docBlock->getDescription(); + if (empty($docBlock->getDescription()->render())) { + return $docBlock->getSummary(); + } else { + return $docBlock->getSummary() . "\n\n" . $docBlock->getDescription(); + } } } } From 3346c5c63be9995df69b1bb1b58bd9c0876c1018 Mon Sep 17 00:00:00 2001 From: jens1o Date: Fri, 24 Feb 2017 13:44:10 +0100 Subject: [PATCH 05/10] code style --- src/DefinitionResolver.php | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/src/DefinitionResolver.php b/src/DefinitionResolver.php index 42089694..90a573e6 100644 --- a/src/DefinitionResolver.php +++ b/src/DefinitionResolver.php @@ -89,10 +89,14 @@ public function getDocumentationFromNode(Node $node) } else { $docBlock = $node->getAttribute('docBlock'); if ($docBlock !== null) { - if (empty($docBlock->getDescription()->render())) { + // check wether we have a description, when true, add a new paragraph + // with the description + $description = $docBlock->getDescription()->render(); + + if (empty(($description))) { return $docBlock->getSummary(); } else { - return $docBlock->getSummary() . "\n\n" . $docBlock->getDescription(); + return $docBlock->getSummary() . "\n\n" . $description; } } } From 33d339f17c95709de4bf207c51d01b08bfee3fcf Mon Sep 17 00:00:00 2001 From: jens1o Date: Fri, 24 Feb 2017 14:04:17 +0100 Subject: [PATCH 06/10] fix code style --- src/DefinitionResolver.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/DefinitionResolver.php b/src/DefinitionResolver.php index 90a573e6..818eae0f 100644 --- a/src/DefinitionResolver.php +++ b/src/DefinitionResolver.php @@ -93,7 +93,7 @@ public function getDocumentationFromNode(Node $node) // with the description $description = $docBlock->getDescription()->render(); - if (empty(($description))) { + if (empty($description)) { return $docBlock->getSummary(); } else { return $docBlock->getSummary() . "\n\n" . $description; From 8ba19887d660f7c43c53f9c2538fad42a2ca92ac Mon Sep 17 00:00:00 2001 From: jens1o Date: Fri, 24 Feb 2017 14:46:18 +0100 Subject: [PATCH 07/10] fix tests --- tests/Server/TextDocument/CompletionTest.php | 28 +++++++++++++++++--- tests/Server/TextDocument/HoverTest.php | 21 ++++++++++++--- 2 files changed, 42 insertions(+), 7 deletions(-) diff --git a/tests/Server/TextDocument/CompletionTest.php b/tests/Server/TextDocument/CompletionTest.php index dd9e6804..6d0ef238 100644 --- a/tests/Server/TextDocument/CompletionTest.php +++ b/tests/Server/TextDocument/CompletionTest.php @@ -160,7 +160,12 @@ public function testNewInNamespace() 'TestClass', CompletionItemKind::CLASS_, null, - 'Pariatur ut laborum tempor voluptate consequat ea deserunt.', + 'Pariatur ut laborum tempor voluptate consequat ea deserunt.' . "\n\n" . + 'Deserunt enim minim sunt sint ea nisi. Deserunt excepteur tempor id nostrud +laboris commodo ad commodo velit mollit qui non officia id. Nulla duis veniam +veniam officia deserunt et non dolore mollit ea quis eiusmod sit non. Occaecat +consequat sunt culpa exercitation pariatur id reprehenderit nisi incididunt Lorem +sint. Officia culpa pariatur laborum nostrud cupidatat consequat mollit.', null, null, '\TestClass' @@ -179,7 +184,12 @@ public function testNewInNamespace() 'TestClass', CompletionItemKind::CLASS_, 'TestNamespace', - 'Pariatur ut laborum tempor voluptate consequat ea deserunt.', + 'Pariatur ut laborum tempor voluptate consequat ea deserunt.' . "\n\n" . + 'Deserunt enim minim sunt sint ea nisi. Deserunt excepteur tempor id nostrud +laboris commodo ad commodo velit mollit qui non officia id. Nulla duis veniam +veniam officia deserunt et non dolore mollit ea quis eiusmod sit non. Occaecat +consequat sunt culpa exercitation pariatur id reprehenderit nisi incididunt Lorem +sint. Officia culpa pariatur laborum nostrud cupidatat consequat mollit.', null, null, 'TestClass' @@ -209,7 +219,12 @@ public function testUsedClass() 'TestClass', CompletionItemKind::CLASS_, 'TestNamespace', - 'Pariatur ut laborum tempor voluptate consequat ea deserunt.' + 'Pariatur ut laborum tempor voluptate consequat ea deserunt.' . "\n\n" . + 'Deserunt enim minim sunt sint ea nisi. Deserunt excepteur tempor id nostrud +laboris commodo ad commodo velit mollit qui non officia id. Nulla duis veniam +veniam officia deserunt et non dolore mollit ea quis eiusmod sit non. Occaecat +consequat sunt culpa exercitation pariatur id reprehenderit nisi incididunt Lorem +sint. Officia culpa pariatur laborum nostrud cupidatat consequat mollit.' ) ], true), $items); } @@ -347,7 +362,12 @@ public function testFullyQualifiedClass() 'TestClass', CompletionItemKind::CLASS_, null, - 'Pariatur ut laborum tempor voluptate consequat ea deserunt.', + 'Pariatur ut laborum tempor voluptate consequat ea deserunt.' . "\n\n" . + 'Deserunt enim minim sunt sint ea nisi. Deserunt excepteur tempor id nostrud +laboris commodo ad commodo velit mollit qui non officia id. Nulla duis veniam +veniam officia deserunt et non dolore mollit ea quis eiusmod sit non. Occaecat +consequat sunt culpa exercitation pariatur id reprehenderit nisi incididunt Lorem +sint. Officia culpa pariatur laborum nostrud cupidatat consequat mollit.', null, null, 'TestClass' diff --git a/tests/Server/TextDocument/HoverTest.php b/tests/Server/TextDocument/HoverTest.php index 7d61354a..f829440a 100644 --- a/tests/Server/TextDocument/HoverTest.php +++ b/tests/Server/TextDocument/HoverTest.php @@ -22,7 +22,12 @@ public function testHoverForClassLike() )->wait(); $this->assertEquals(new Hover([ new MarkedString('php', "range), $result); } @@ -37,7 +42,12 @@ public function testHoverForClassLikeDefinition() )->wait(); $this->assertEquals(new Hover([ new MarkedString('php', "range), $result); } @@ -181,7 +191,12 @@ public function testHoverForThis() $result = $this->textDocument->hover(new TextDocumentIdentifier($uri), new Position(59, 11))->wait(); $this->assertEquals(new Hover([ new MarkedString('php', " Date: Fri, 24 Feb 2017 15:22:20 +0100 Subject: [PATCH 08/10] fix indention --- tests/Server/TextDocument/CompletionTest.php | 40 ++++++++++---------- tests/Server/TextDocument/HoverTest.php | 20 +++++----- 2 files changed, 30 insertions(+), 30 deletions(-) diff --git a/tests/Server/TextDocument/CompletionTest.php b/tests/Server/TextDocument/CompletionTest.php index 6d0ef238..786fb559 100644 --- a/tests/Server/TextDocument/CompletionTest.php +++ b/tests/Server/TextDocument/CompletionTest.php @@ -161,11 +161,11 @@ public function testNewInNamespace() CompletionItemKind::CLASS_, null, 'Pariatur ut laborum tempor voluptate consequat ea deserunt.' . "\n\n" . - 'Deserunt enim minim sunt sint ea nisi. Deserunt excepteur tempor id nostrud -laboris commodo ad commodo velit mollit qui non officia id. Nulla duis veniam -veniam officia deserunt et non dolore mollit ea quis eiusmod sit non. Occaecat -consequat sunt culpa exercitation pariatur id reprehenderit nisi incididunt Lorem -sint. Officia culpa pariatur laborum nostrud cupidatat consequat mollit.', + 'Deserunt enim minim sunt sint ea nisi. Deserunt excepteur tempor id nostrud' . "\n" . + 'laboris commodo ad commodo velit mollit qui non officia id. Nulla duis veniam' . "\n" . + 'veniam officia deserunt et non dolore mollit ea quis eiusmod sit non. Occaecat' . "\n" . + 'consequat sunt culpa exercitation pariatur id reprehenderit nisi incididunt Lorem' . "\n" . + 'sint. Officia culpa pariatur laborum nostrud cupidatat consequat mollit.', null, null, '\TestClass' @@ -185,11 +185,11 @@ public function testNewInNamespace() CompletionItemKind::CLASS_, 'TestNamespace', 'Pariatur ut laborum tempor voluptate consequat ea deserunt.' . "\n\n" . - 'Deserunt enim minim sunt sint ea nisi. Deserunt excepteur tempor id nostrud -laboris commodo ad commodo velit mollit qui non officia id. Nulla duis veniam -veniam officia deserunt et non dolore mollit ea quis eiusmod sit non. Occaecat -consequat sunt culpa exercitation pariatur id reprehenderit nisi incididunt Lorem -sint. Officia culpa pariatur laborum nostrud cupidatat consequat mollit.', + 'Deserunt enim minim sunt sint ea nisi. Deserunt excepteur tempor id nostrud' . "\n" . + 'laboris commodo ad commodo velit mollit qui non officia id. Nulla duis veniam' . "\n" . + 'veniam officia deserunt et non dolore mollit ea quis eiusmod sit non. Occaecat' . "\n" . + 'consequat sunt culpa exercitation pariatur id reprehenderit nisi incididunt Lorem' . "\n" . + 'sint. Officia culpa pariatur laborum nostrud cupidatat consequat mollit.', null, null, 'TestClass' @@ -220,11 +220,11 @@ public function testUsedClass() CompletionItemKind::CLASS_, 'TestNamespace', 'Pariatur ut laborum tempor voluptate consequat ea deserunt.' . "\n\n" . - 'Deserunt enim minim sunt sint ea nisi. Deserunt excepteur tempor id nostrud -laboris commodo ad commodo velit mollit qui non officia id. Nulla duis veniam -veniam officia deserunt et non dolore mollit ea quis eiusmod sit non. Occaecat -consequat sunt culpa exercitation pariatur id reprehenderit nisi incididunt Lorem -sint. Officia culpa pariatur laborum nostrud cupidatat consequat mollit.' + 'Deserunt enim minim sunt sint ea nisi. Deserunt excepteur tempor id nostrud' . "\n" . + 'laboris commodo ad commodo velit mollit qui non officia id. Nulla duis veniam' . "\n" . + 'veniam officia deserunt et non dolore mollit ea quis eiusmod sit non. Occaecat' . "\n" . + 'consequat sunt culpa exercitation pariatur id reprehenderit nisi incididunt Lorem' . "\n" . + 'sint. Officia culpa pariatur laborum nostrud cupidatat consequat mollit.' ) ], true), $items); } @@ -363,11 +363,11 @@ public function testFullyQualifiedClass() CompletionItemKind::CLASS_, null, 'Pariatur ut laborum tempor voluptate consequat ea deserunt.' . "\n\n" . - 'Deserunt enim minim sunt sint ea nisi. Deserunt excepteur tempor id nostrud -laboris commodo ad commodo velit mollit qui non officia id. Nulla duis veniam -veniam officia deserunt et non dolore mollit ea quis eiusmod sit non. Occaecat -consequat sunt culpa exercitation pariatur id reprehenderit nisi incididunt Lorem -sint. Officia culpa pariatur laborum nostrud cupidatat consequat mollit.', + 'Deserunt enim minim sunt sint ea nisi. Deserunt excepteur tempor id nostrud' . "\n" . + 'laboris commodo ad commodo velit mollit qui non officia id. Nulla duis veniam' . "\n" . + 'veniam officia deserunt et non dolore mollit ea quis eiusmod sit non. Occaecat' . "\n" . + 'consequat sunt culpa exercitation pariatur id reprehenderit nisi incididunt Lorem' . "\n" . + 'sint. Officia culpa pariatur laborum nostrud cupidatat consequat mollit.', null, null, 'TestClass' diff --git a/tests/Server/TextDocument/HoverTest.php b/tests/Server/TextDocument/HoverTest.php index f829440a..87d8f0e2 100644 --- a/tests/Server/TextDocument/HoverTest.php +++ b/tests/Server/TextDocument/HoverTest.php @@ -43,11 +43,11 @@ public function testHoverForClassLikeDefinition() $this->assertEquals(new Hover([ new MarkedString('php', "range), $result); } @@ -192,11 +192,11 @@ public function testHoverForThis() $this->assertEquals(new Hover([ new MarkedString('php', " Date: Sun, 19 Mar 2017 11:46:30 +0100 Subject: [PATCH 09/10] fix code style 1/21 --- src/DefinitionResolver.php | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/src/DefinitionResolver.php b/src/DefinitionResolver.php index 818eae0f..6bfceb0d 100644 --- a/src/DefinitionResolver.php +++ b/src/DefinitionResolver.php @@ -95,9 +95,8 @@ public function getDocumentationFromNode(Node $node) if (empty($description)) { return $docBlock->getSummary(); - } else { - return $docBlock->getSummary() . "\n\n" . $description; } + return $docBlock->getSummary() . "\n\n" . $description; } } } From bbb74d1f09cef073148263ab603adc7a39a7c857 Mon Sep 17 00:00:00 2001 From: Jens Hausdorf Date: Sun, 19 Mar 2017 11:47:39 +0100 Subject: [PATCH 10/10] fix code style 2/2 --- tests/Server/TextDocument/HoverTest.php | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/tests/Server/TextDocument/HoverTest.php b/tests/Server/TextDocument/HoverTest.php index 87d8f0e2..cdc17189 100644 --- a/tests/Server/TextDocument/HoverTest.php +++ b/tests/Server/TextDocument/HoverTest.php @@ -23,11 +23,11 @@ public function testHoverForClassLike() $this->assertEquals(new Hover([ new MarkedString('php', "range), $result); }