Fixed return value documentation comments for getter of property elem…

…ent (heremaps#1541) Fixed return value documentation comments for getter of property element --------- Signed-off-by: Sameer Mahant <[email protected]>
parzysty · Jul 31, 2023 · f4b1e8d · f4b1e8d
1 parent 1ba42f2
commit f4b1e8d
Show file tree

Hide file tree

Showing 9 changed files with 28 additions and 10 deletions.
diff --git a/gluecodium/src/main/resources/templates/java/JavaMethodComment.mustache b/gluecodium/src/main/resources/templates/java/JavaMethodComment.mustache
@@ -21,17 +21,26 @@
 {{#ifPredicate "hasAnyComment"}}
 /**
 {{prefixPartial "combinedComment" " * "}}
- */{{#if attributes.deprecated}}
-@Deprecated{{/if}}{{/ifPredicate}}{{!!
+ */
+{{#if attributes.deprecated}}@Deprecated{{/if}}
+{{/ifPredicate}}
 
-}}{{+combinedComment}}{{resolveName comment}}{{#if comment.isExcluded}}
-@hidden{{/if}}{{#if attributes.deprecated}}
-@deprecated {{resolveName attributes.deprecated.message}}{{/if}}{{!!
+{{+combinedComment}}{{!!
+}}{{resolveName comment}}{{!!
+}}{{#if comment.isExcluded}}
+{{!!}}@hidden{{!!
+}}{{/if}}{{!!
+}}{{#if attributes.deprecated}}
+{{!!}}@deprecated {{resolveName attributes.deprecated.message}}{{!!
+}}{{/if}}{{!!
 }}{{#parameters}}
-@param {{resolveName}} {{#resolveName comment}}{{prefix this "    " skipFirstLine=true}}{{/resolveName}}{{/parameters}}{{!!
-}}{{#unless isConstructor returnType.isVoid isGetter logic="and"}}{{!! document the return value if
-it's neither a constructor nor returning void nor a getter}}
-@return {{#resolveName returnType.comment}}{{prefix this "    " skipFirstLine=true}}{{/resolveName}}{{/unless}}{{!!
+{{!!}}@param {{resolveName}} {{#resolveName comment}}{{prefix this "    " skipFirstLine=true}}{{/resolveName}}{{!!
+}}{{/parameters}}{{!!
+}}{{!! document the return value if it's neither a constructor nor returning void }}{{!!
+}}{{#unless isConstructor returnType.isVoid logic="and"}}
+{{!!}}@return {{#resolveName returnType.comment}}{{prefix this "    " skipFirstLine=true}}{{/resolveName}}{{!!
+}}{{/unless}}{{!!
 }}{{#if thrownType}}
-@throws {{resolveName exception "" "ref"}} {{#resolveName thrownType.comment}}{{prefix this "    " skipFirstLine=true}}{{/resolveName}}{{/if}}{{!!
+{{!!}}@throws {{resolveName exception "" "ref"}} {{#resolveName thrownType.comment}}{{prefix this "    " skipFirstLine=true}}{{/resolveName}}{{!!
+}}{{/if}}{{!!
 }}{{/combinedComment}}
diff --git a/...t/resources/smoke/attributes/output/android/com/example/smoke/AttributesWithComments.java b/...t/resources/smoke/attributes/output/android/com/example/smoke/AttributesWithComments.java
@@ -47,6 +47,7 @@ public void disposeNative(long handle) {
     public native void veryFun();
     /**
      * <p>Getter comment
+     * @return <p>Property comment
      */
     @OnPropertyInClass
     @NonNull

diff --git a/...resources/smoke/attributes/output/android/com/example/smoke/AttributesWithDeprecated.java b/...resources/smoke/attributes/output/android/com/example/smoke/AttributesWithDeprecated.java
@@ -53,6 +53,7 @@ public void disposeNative(long handle) {
     /**
      *
      * @deprecated
+     * @return
      */
     @Deprecated
     @OnPropertyInClass

diff --git a/gluecodium/src/test/resources/smoke/comments/output/android/com/example/smoke/Comments.java b/gluecodium/src/test/resources/smoke/comments/output/android/com/example/smoke/Comments.java
@@ -188,6 +188,7 @@ public void disposeNative(long handle) {
     public native String returnCommentOnly(@NonNull final String undocumented);
     /**
      * <p>Gets some very useful property.
+     * @return <p>Some very useful property.
      */
     public native boolean isSomeProperty();
     /**

diff --git a/...src/test/resources/smoke/comments/output/android/com/example/smoke/CommentsInterface.java b/...src/test/resources/smoke/comments/output/android/com/example/smoke/CommentsInterface.java
@@ -92,6 +92,7 @@ public SomeStruct(final boolean someField) {
     void someMethodWithoutReturnTypeOrInputParameters();
     /**
      * <p>Gets some very useful property.
+     * @return <p>Some very useful property.
      */
     boolean isSomeProperty();
     /**

diff --git a/...c/test/resources/smoke/comments/output/android/com/example/smoke/DeprecationComments.java b/...c/test/resources/smoke/comments/output/android/com/example/smoke/DeprecationComments.java
@@ -74,6 +74,7 @@ public SomeStruct() {
      * <p>Gets some very useful property.
      * @deprecated <p>Unfortunately, this property's getter is deprecated.
      * Use {@link com.example.smoke.Comments#isSomeProperty} instead.
+     * @return <p>Some very useful property.
      */
     @Deprecated
     boolean isSomeProperty();
@@ -88,6 +89,7 @@ public SomeStruct() {
     /**
      * <p>Gets the property but not accessors.
      * @deprecated <p>Will be removed in v3.2.1.
+     * @return <p>Describes the property but not accessors.
      */
     @Deprecated
     @NonNull

diff --git a/...st/resources/smoke/comments/output/android/com/example/smoke/DeprecationCommentsOnly.java b/...st/resources/smoke/comments/output/android/com/example/smoke/DeprecationCommentsOnly.java
@@ -53,6 +53,7 @@ public SomeStruct() {
     /**
      *
      * @deprecated <p>Unfortunately, this property's getter is deprecated.
+     * @return
      */
     @Deprecated
     boolean isSomeProperty();

diff --git a/.../src/test/resources/smoke/comments/output/android/com/example/smoke/ExcludedComments.java b/.../src/test/resources/smoke/comments/output/android/com/example/smoke/ExcludedComments.java
@@ -128,6 +128,7 @@ public void disposeNative(long handle) {
     /**
      * <p>Gets some very useful property.
      * @hidden
+     * @return <p>Some very useful property.
      */
     public native boolean isSomeProperty();
     /**

diff --git a/.../test/resources/smoke/comments/output/android/com/example/smoke/ExcludedCommentsOnly.java b/.../test/resources/smoke/comments/output/android/com/example/smoke/ExcludedCommentsOnly.java
@@ -114,6 +114,7 @@ public void disposeNative(long handle) {
     /**
      *
      * @hidden
+     * @return
      */
     public native boolean isSomeProperty();
     /**