You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@netbeans.apache.org by "troizet (via GitHub)" <gi...@apache.org> on 2025/03/16 06:27:42 UTC
[PR] PHP: If a function or method does not have a return operator, the @return void tag is generated when generating a phpDoc [netbeans]
troizet opened a new pull request, #8340:
URL: https://github.com/apache/netbeans/pull/8340
If a function or method does not have a `return` operator, the `@return void` tag is generated when generating a phpDoc.
before:
https://github.com/user-attachments/assets/f14a7c14-53aa-4e77-9678-430e18da882a
after:
https://github.com/user-attachments/assets/ad873709-c2e9-4387-84b2-ed805af0c51f
---
**^Add meaningful description above**
<details open>
<summary>Click to collapse/expand PR instructions</summary>
By opening a pull request you confirm that, unless explicitly stated otherwise, the changes -
- are all your own work, and you have the right to contribute them.
- are contributed solely under the terms and conditions of the Apache License 2.0 (see section 5 of the license for more information).
Please make sure (eg. `git log`) that all commits have a valid name and email address for you in the Author field.
If you're a first time contributor, see the Contributing guidelines for more information.
If you're a committer, please label the PR before pressing "Create pull request" so that the right test jobs can run.
### PR approval and merge checklist:
1. [ ] Was this PR [correctly labeled](https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=240884239#PRsandYouAreviewerGuide-PRtriggeredCIJobs(conditionalCIpipeline)), did the right tests run? When did they run?
2. [ ] Is this PR [squashed](https://cwiki.apache.org/confluence/display/NETBEANS/git%3A+squash+and+merge)?
3. [ ] Are author name / email address correct? Are [co-authors](https://docs.github.com/en/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors#creating-co-authored-commits-on-the-command-line) correctly listed? Do the commit messages need updates?
3. [ ] Does the PR title and description still fit after the Nth iteration? Is the description sufficient to appear in the release notes?
If this PR targets the delivery branch: [don't merge](https://cwiki.apache.org/confluence/display/NETBEANS/Pull+requests+for+delivery). ([full wiki article](https://cwiki.apache.org/confluence/display/NETBEANS/PRs+and+You+-+A+reviewer+Guide))
</details>
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@netbeans.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@netbeans.apache.org
For additional commands, e-mail: notifications-help@netbeans.apache.org
For further information about the NetBeans mailing lists, visit:
https://cwiki.apache.org/confluence/display/NETBEANS/Mailing+lists
Re: [PR] PHP: If a function or method does not have a return statement, the @return void tag is generated when generating a phpDoc [netbeans]
Posted by "tmysik (via GitHub)" <gi...@apache.org>.
tmysik commented on code in PR #8340:
URL: https://github.com/apache/netbeans/pull/8340#discussion_r1997649303
##########
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
Review Comment:
Nitpick: maybe simpler?
```suggestion
generateDocEntry(doc, toAdd, "@return", indent, null, i.hasReturn ? i.getReturnType() : Type.VOID); // NOI18N
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@netbeans.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@netbeans.apache.org
For additional commands, e-mail: notifications-help@netbeans.apache.org
For further information about the NetBeans mailing lists, visit:
https://cwiki.apache.org/confluence/display/NETBEANS/Mailing+lists
Re: [PR] PHP: If a function or method does not have a return statement, the @return void tag is generated when generating a phpDoc [netbeans]
Posted by "junichi11 (via GitHub)" <gi...@apache.org>.
junichi11 commented on PR #8340:
URL: https://github.com/apache/netbeans/pull/8340#issuecomment-2728214618
The existing tests are executed for different purposes, so we should add tests for this fix.
e.g.
```php
function noReturn() {
}
function hasReturn() {
return "test";
}
function emptyReturn() {
return;
}
function multipleEmptyReturns() {
if (true) {
return;
}
return;
}
// ... etc.
class TestClass {
public function noReturn() {
}
// ... etc.
}
interface TestInterface {
public function test(); // in this case, should not add?
// ... etc.
}
abstract class AbstractClass {
public abstract function test(int $param);
// ... etc.
}
```
Please also write examples to the description(Before & After). Thanks!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@netbeans.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@netbeans.apache.org
For additional commands, e-mail: notifications-help@netbeans.apache.org
For further information about the NetBeans mailing lists, visit:
https://cwiki.apache.org/confluence/display/NETBEANS/Mailing+lists