From a2d4285d34f595e0c9b254c641dfca187fd00fce Mon Sep 17 00:00:00 2001
From: Alexey Borokhvostov <troizet@gmail.com>
Date: Sun, 16 Mar 2025 13:16:05 +0700
Subject: [PATCH] PHP: If a function or method does not have a return operator,
 the @return void tag is generated when generating a phpDoc.

---
 .../typinghooks/PhpCommentGenerator.java      |  2 +
 .../issue193118_01.php.indented               |  3 +-
 .../issue193118_02.php.indented               |  3 +-
 .../issue197924_01.php.indented               |  3 +-
 .../issue197924_02.php.indented               |  3 +-
 .../typinghooks/PhpCommentGeneratorTest.java  | 39 ++++++++++++-------
 6 files changed, 36 insertions(+), 17 deletions(-)

diff --git a/php/php.editor/src/org/netbeans/modules/php/editor/typinghooks/PhpCommentGenerator.java b/php/php.editor/src/org/netbeans/modules/php/editor/typinghooks/PhpCommentGenerator.java
index f23dcae025c8..0104ae0385be 100644
--- a/php/php.editor/src/org/netbeans/modules/php/editor/typinghooks/PhpCommentGenerator.java
+++ b/php/php.editor/src/org/netbeans/modules/php/editor/typinghooks/PhpCommentGenerator.java
@@ -114,6 +114,8 @@ private static void generateFunctionDoc(BaseDocument doc, int offset, int indent
 
         if (i.hasReturn) {
             generateDocEntry(doc, toAdd, "@return", indent, null, i.getReturnType()); // NOI18N
+        } else {
+            generateDocEntry(doc, toAdd, "@return", indent, null, Type.VOID); // NOI18N
         }
 
         addVariables(doc, toAdd, "@throws", indent, i.throwsExceptions);
diff --git a/php/php.editor/test/unit/data/testfiles/bracketCompleter/issue193118_01.php.indented b/php/php.editor/test/unit/data/testfiles/bracketCompleter/issue193118_01.php.indented
index daed0c06326e..12113c242790 100644
--- a/php/php.editor/test/unit/data/testfiles/bracketCompleter/issue193118_01.php.indented
+++ b/php/php.editor/test/unit/data/testfiles/bracketCompleter/issue193118_01.php.indented
@@ -1,7 +1,8 @@
 <?php
 
 /**
- * ^
+ * 
+ * @return void^
  */
 function f(){
   $r= '/.*/';
diff --git a/php/php.editor/test/unit/data/testfiles/bracketCompleter/issue193118_02.php.indented b/php/php.editor/test/unit/data/testfiles/bracketCompleter/issue193118_02.php.indented
index d1415b425671..95272b5f2667 100644
--- a/php/php.editor/test/unit/data/testfiles/bracketCompleter/issue193118_02.php.indented
+++ b/php/php.editor/test/unit/data/testfiles/bracketCompleter/issue193118_02.php.indented
@@ -1,7 +1,8 @@
 <?php
 
 /**
- * ^
+ * 
+ * @return void^
  */
 function f(){
   $r= '/./*';
diff --git a/php/php.editor/test/unit/data/testfiles/bracketCompleter/issue197924_01.php.indented b/php/php.editor/test/unit/data/testfiles/bracketCompleter/issue197924_01.php.indented
index 407340ccaf83..4b4e782a5f55 100644
--- a/php/php.editor/test/unit/data/testfiles/bracketCompleter/issue197924_01.php.indented
+++ b/php/php.editor/test/unit/data/testfiles/bracketCompleter/issue197924_01.php.indented
@@ -2,7 +2,8 @@
 
 /**
  * 
- * @param type $alias^
+ * @param type $alias
+ * @return void^
  */
 function func($alias) {
     $blah = "/blee*/";
diff --git a/php/php.editor/test/unit/data/testfiles/bracketCompleter/issue197924_02.php.indented b/php/php.editor/test/unit/data/testfiles/bracketCompleter/issue197924_02.php.indented
index 5b4d47933be8..97c142eb5223 100644
--- a/php/php.editor/test/unit/data/testfiles/bracketCompleter/issue197924_02.php.indented
+++ b/php/php.editor/test/unit/data/testfiles/bracketCompleter/issue197924_02.php.indented
@@ -2,7 +2,8 @@
 
 /**
  * 
- * @param type $alias^
+ * @param type $alias
+ * @return void^
  */
 function func($alias) {
     $blah = "/blee/*";
diff --git a/php/php.editor/test/unit/src/org/netbeans/modules/php/editor/typinghooks/PhpCommentGeneratorTest.java b/php/php.editor/test/unit/src/org/netbeans/modules/php/editor/typinghooks/PhpCommentGeneratorTest.java
index 33cbb99dad10..214413d6e2c8 100644
--- a/php/php.editor/test/unit/src/org/netbeans/modules/php/editor/typinghooks/PhpCommentGeneratorTest.java
+++ b/php/php.editor/test/unit/src/org/netbeans/modules/php/editor/typinghooks/PhpCommentGeneratorTest.java
@@ -51,7 +51,8 @@ public void testFunctionDocumentationParam() throws Exception {
                             "<?php\n" +
                             "/**\n" +
                             " * \n" +
-                            " * @param " + PhpCommentGenerator.TYPE_PLACEHOLDER + " $i^\n" +
+                            " * @param " + PhpCommentGenerator.TYPE_PLACEHOLDER + " $i\n" +
+                            " * @return void^\n" +
                             " */\n" +
                             "function foo($i) {\n" +
                             "}\n" +
@@ -70,7 +71,8 @@ public void testFunctionDocumentationGlobalVar() throws Exception {
                             "$r = 1;\n" +
                             "/**\n" +
                             " * \n" +
-                            " * @global int $r^\n" +
+                            " * @global int $r\n" +
+                            " * @return void^\n" +
                             " */\n" +
                             "function foo() {\n" +
                             "    global $r;\n" +
@@ -88,7 +90,8 @@ public void testFunctionDocumentationStaticVar() throws Exception {
                             "<?php\n" +
                             "/**\n" +
                             " * \n" +
-                            " * @staticvar " + PhpCommentGenerator.TYPE_PLACEHOLDER + " $r^\n" +
+                            " * @staticvar " + PhpCommentGenerator.TYPE_PLACEHOLDER + " $r\n" +
+                            " * @return void^\n" +
                             " */\n" +
                             "function foo() {\n" +
                             "    static $r;\n" +
@@ -159,7 +162,8 @@ public void testMethodDocumentation() throws Exception {
                             "class foo {\n" +
                             "    /**\n" +
                             "     * \n" +
-                            "     * @param " + PhpCommentGenerator.TYPE_PLACEHOLDER + " $par^\n" +
+                            "     * @param " + PhpCommentGenerator.TYPE_PLACEHOLDER + " $par\n" +
+                            "     * @return void^\n" +
                             "     */\n" +
                             "    function bar($par) {\n" +
                             "    }\n" +
@@ -206,7 +210,8 @@ public void testIssue236311() throws Exception {
                 "?>", "<?php\n" +
                 "class MyCls {\n" +
                 "    /**\n" +
-                "     * ^\n" +
+                "     * \n" +
+                "     * @return void^\n" +
                 "     */\n" +
                 "    public static function beginRequest()\n" +
                 "    {\n" +
@@ -233,7 +238,8 @@ public void testIssue242356() throws Exception {
                 "interface Iface1 {\n" +
                 "    /**\n" +
                 "     * \n" +
-                "     * @param type $param^\n" +
+                "     * @param type $param\n" +
+                "     * @return void^\n" +
                 "     */\n" +
                 "    public function faceFnc($param);\n" +
                 "}\n" +
@@ -254,7 +260,8 @@ public void testResolveProperType_01() throws Exception {
                 "class Test {\n" +
                 "    /**\n" +
                 "     * \n" +
-                "     * @param SomeClass $someClass^\n" +
+                "     * @param SomeClass $someClass\n" +
+                "     * @return void^\n" +
                 "     */\n" +
                 "    public function getSomething(SomeClass $someClass) {}\n" +
                 "}";
@@ -275,7 +282,8 @@ public void testResolveProperType_02() throws Exception {
                 "class Test {\n" +
                 "    /**\n" +
                 "     * \n" +
-                "     * @param SomeClassAlias $someClass^\n" +
+                "     * @param SomeClassAlias $someClass\n" +
+                "     * @return void^\n" +
                 "     */\n" +
                 "    public function getSomething(SomeClassAlias $someClass) {}\n" +
                 "}";
@@ -295,7 +303,8 @@ public void testIssue248213Variadic() throws Exception {
                 "<?php\n"
                 + "/**\n"
                 + " * \n"
-                + " * @param " + PhpCommentGenerator.TYPE_PLACEHOLDER + " $i^\n"
+                + " * @param " + PhpCommentGenerator.TYPE_PLACEHOLDER + " $i\n"
+                + " * @return void^\n"
                 + " */\n"
                 + "function foo(...$i) {\n"
                 + "}\n"
@@ -319,7 +328,8 @@ public void testIssue248213ReferenceVariadic() throws Exception {
                 + "class foo {\n"
                 + "    /**\n"
                 + "     * \n"
-                + "     * @param " + PhpCommentGenerator.TYPE_PLACEHOLDER + " $par^\n"
+                + "     * @param " + PhpCommentGenerator.TYPE_PLACEHOLDER + " $par\n"
+                + "     * @return void^\n"
                 + "     */\n"
                 + "    function bar(&...$par) {\n"
                 + "    }\n"
@@ -351,7 +361,8 @@ public void testIssue269104_01() throws Exception {
                 + "class Bar {\n"
                 + "    /**\n"
                 + "     * \n"
-                + "     * @param callable $callable^\n"
+                + "     * @param callable $callable\n"
+                + "     * @return void^\n"
                 + "     */\n"
                 + "    function callableType(callable $callable) {\n"
                 + "        //...\n"
@@ -384,7 +395,8 @@ public void testIssue269104_02() throws Exception {
                 + "class Bar {\n"
                 + "    /**\n"
                 + "     * \n"
-                + "     * @param int $int^\n"
+                + "     * @param int $int\n"
+                + "     * @return void^\n"
                 + "     */\n"
                 + "    function intType(int $int) {\n"
                 + "        //...\n"
@@ -417,7 +429,8 @@ public void testIssue269104_03() throws Exception {
                 + "class Bar {\n"
                 + "    /**\n"
                 + "     * \n"
-                + "     * @param iterable $iterable^\n"
+                + "     * @param iterable $iterable\n"
+                + "     * @return void^\n"
                 + "     */\n"
                 + "    function iterableType(iterable $iterable) {\n"
                 + "        //...\n"