Include :return-type in response from jdoc-data

Author: JarrodCTaylor

README.md

@@ -97,6 +97,7 @@ Returns all the structured data instead of printing the description.
 ;;     :methods [{:signature "valueOf(int i)"
 ;;                :description "Returns the string representation..."
 ;;                :static? true
+;;                :return-type "String"
 ;;                :clojure-call "^[int] String/valueOf"}
 ;;               ...]}
 
@@ -108,6 +109,7 @@ Returns all the structured data instead of printing the description.
 ;;     :selected-method [{:signature "valueOf(char[] data)"
 ;;                        :description "Returns the string representation..."
 ;;                        :static? true
+;;                        :return-type "String"
 ;;                        :clojure-call "^[char/1] String/valueOf"
 ;;                        :method-description-html "..."
 ;;                        :method-description-md "..."}]}

src/clojure/java/doc/impl.clj

@@ -188,6 +188,20 @@
       (str/ends-with? raw-type "...") (str/replace raw-type #"[.]{3}$" "/1")
       :else raw-type)))
 
+(defn- clojure-return-type
+  "Extract return type from modifier text and convert to Clojure type hint syntax: static char[] -> char/1"
+  [modifier-text]
+  (when modifier-text
+    (-> modifier-text
+        str/trim
+        (str/replace #"^(?:public|private|protected)\s+" "")
+        (str/replace #"^static\s+" "")
+        (str/replace #"^final\s+" "")
+        (str/replace #"^default\s+" "")
+        (str/replace #"^abstract\s+" "")
+        compress-array-syntax
+        str/trim)))
+
 (defn- clojure-call-syntax
   "javadoc signature to clojure param-tag syntax: valueOf(char[] data) -> ^[char/1] String/valueOf"
   [class-part method-signature is-static?]
@@ -222,12 +236,13 @@
                            (let [desc-div ^org.jsoup.nodes.Element (.nextElementSibling method-div)
                                  signature (.text (.select method-div "code"))
                                  modifier-div ^org.jsoup.nodes.Element (.previousElementSibling method-div)
-                                 modifier-html (when modifier-div (.html modifier-div))
-                                 is-static? (and modifier-html (str/includes? modifier-html "static"))]
+                                 modifier-text (when modifier-div (.text modifier-div))
+                                 is-static? (and modifier-text (str/includes? modifier-text "static"))]
                              {:signature signature
                               :description (.text (.select desc-div ".block"))
-                               :static? is-static?
-                               :clojure-call (clojure-call-syntax class-part signature is-static?)})))
+                              :static? is-static?
+                              :return-type (clojure-return-type modifier-text)
+                              :clojure-call (clojure-call-syntax class-part signature is-static?)})))
         class-html (when class-desc-section (.outerHtml ^org.jsoup.nodes.Element class-desc-section))
         result {:classname class-name
                 :class-description-html class-html

test/clojure/java/doc/impl_test.clj

@@ -130,6 +130,42 @@
     (is (= "int[]" (#'sut/expand-array-syntax "int[]")))
     (is (= "String[][]" (#'sut/expand-array-syntax "String[][]")))))
 
+(deftest clojure-return-type-test
+
+  (testing "simple types unchanged"
+    (is (= "String" (#'sut/clojure-return-type "String")))
+    (is (= "int" (#'sut/clojure-return-type "int")))
+    (is (= "void" (#'sut/clojure-return-type "void"))))
+
+  (testing "modifiers stripped"
+    (is (= "String" (#'sut/clojure-return-type "static String")))
+    (is (= "int" (#'sut/clojure-return-type "static int")))
+    (is (= "String" (#'sut/clojure-return-type "public static String")))
+    (is (= "String" (#'sut/clojure-return-type "static final String"))))
+
+  (testing "array types converted to clojure syntax"
+    (is (= "char/1" (#'sut/clojure-return-type "char[]")))
+    (is (= "char/1" (#'sut/clojure-return-type "static char[]")))
+    (is (= "String/1" (#'sut/clojure-return-type "String[]")))
+    (is (= "String/2" (#'sut/clojure-return-type "String[][]"))))
+
+  (testing "generic types stripped"
+    (is (= "List" (#'sut/clojure-return-type "List<String>")))
+    (is (= "List" (#'sut/clojure-return-type "static List<E>")))
+    (is (= "Map" (#'sut/clojure-return-type "Map<K,V>"))))
+
+  (testing "type parameter declarations stripped"
+    (is (= "List" (#'sut/clojure-return-type "<E> List<E>")))
+    (is (= "T/1" (#'sut/clojure-return-type "<T> T[]")))
+    (is (= "T" (#'sut/clojure-return-type "<T> T"))))
+
+  (testing "complex type parameter declarations with nested generics"
+    (is (= "T" (#'sut/clojure-return-type "<T extends Comparable<T>> T")))
+    (is (= "T" (#'sut/clojure-return-type "<T extends Object & Comparable<? super T>> T"))))
+
+  (testing "nil input"
+    (is (nil? (#'sut/clojure-return-type nil)))))
+
 (deftest compress-array-syntax-test
 
   (testing "primitive types unchanged"