[GitHub] [netbeans] tmysik commented on a change in pull request #2122: [NETBEANS-3413] Implicit inheritance of PHPDoc descriptions

[GitBox <gi...@apache.org>]

tmysik commented on a change in pull request #2122:
URL: https://github.com/apache/netbeans/pull/2122#discussion_r419125693



##########
File path: php/php.editor/src/org/netbeans/modules/php/editor/completion/DocRenderer.java
##########
@@ -242,6 +243,7 @@ private static String getLocation(PhpElement indexedElement) {
         private final PhpElement indexedElement;
         private final List<String> links = new ArrayList<>();
         private final ASTNode node;
+        @NullAllowed
         private PHPDocBlock phpDocBlock;
 
         public PHPDocExtractor(CCDocHtmlFormatter header, PhpElement indexedElement, ASTNode node, PHPDocBlock phpDocBlock) {

Review comment:
       Missing `@NullAllowed` for `phpDocBlock` param, right?
   

##########
File path: php/php.editor/src/org/netbeans/modules/php/editor/completion/DocRenderer.java
##########
@@ -575,6 +575,9 @@ private String composeDescription(String description, List<PHPDocBlock> comments
         }
 
         private String replaceInheritdocForDescription(String description, String parentDescription) {

Review comment:
       Missing `@NullAllowed` for `description` param.
   

##########
File path: php/php.editor/src/org/netbeans/modules/php/editor/completion/DocRenderer.java
##########
@@ -575,6 +575,9 @@ private String composeDescription(String description, List<PHPDocBlock> comments
         }
 
         private String replaceInheritdocForDescription(String description, String parentDescription) {

Review comment:
       OT: And for `parentDescription` as well, could you please add it? Thanks.
   

##########
File path: php/php.editor/src/org/netbeans/modules/php/editor/completion/DocRenderer.java
##########
@@ -575,6 +575,9 @@ private String composeDescription(String description, List<PHPDocBlock> comments
         }
 
         private String replaceInheritdocForDescription(String description, String parentDescription) {

Review comment:
       OT: Also, the whole method should be annotated by `@CheckForNull` (IIRC) since it can return `null` if I understand it correctly. Thanks.
   

##########
File path: php/php.editor/src/org/netbeans/modules/php/editor/completion/DocRenderer.java
##########
@@ -768,6 +771,9 @@ private boolean isOnlyInheritdoc(PHPDocBlock phpDocBlock) {
         }
 
         static String replaceInlineInheritdoc(String description, String inheritdoc) {

Review comment:
       OT: Again, missing annotations for `null` values.
   




----------------------------------------------------------------
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.

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