Add sigs function to the api

Author: JarrodCTaylor

README.md

@@ -38,7 +38,7 @@ clojure -Sdeps '{:deps {org.clojure/clojure.java.doc {:git/url "https://github.c
 
 ## Usage
 
-The core namespace provides two functions:
+The core namespace provides three functions:
 
 ### jdoc
 
@@ -60,6 +60,23 @@ Prints a markdown formatted version of the javadoc description:
 (jdoc ^[_ int] String/.substring)
 ```
 
+### sigs
+
+Prints the method signatures in param tags form:
+
+```clojure
+(sigs String/valueOf)
+;; => ^[boolean] String/valueOf
+;;    ^[char] String/valueOf
+;;    ^[char/1] String/valueOf
+;;    ^[char/1 int int] String/valueOf
+;;    ^[double] String/valueOf
+;;    ^[float] String/valueOf
+;;    ^[int] String/valueOf
+;;    ^[long] String/valueOf
+;;    ^[Object] String/valueOf
+```
+
 ### jdoc-data
 
 Returns structured data instead of printing:

src/clojure/java/doc/api.clj

@@ -1,6 +1,6 @@
 (ns clojure.java.doc.api
   (:require
-    [clojure.java.doc.impl :refer [parse-javadoc print-javadoc]]))
+    [clojure.java.doc.impl :refer [parse-javadoc print-javadoc print-signatures]]))
 
 (defn javadoc-data-fn [s param-tags]
   (parse-javadoc s param-tags))
@@ -25,3 +25,11 @@
      (jdoc ^[char/1] String/valueOf)  ; Print specific overload"
   [class-or-method]
   `(javadoc-fn ~(str class-or-method) '~(:param-tags (meta class-or-method))))
+
+(defn sigs-fn [s param-tags]
+  (print-signatures (javadoc-data-fn s param-tags)))
+
+(defmacro sigs
+  "print method signatures in param tags form"
+  [class-or-method]
+  `(sigs-fn ~(str class-or-method) '~(:param-tags (meta class-or-method))))

src/clojure/java/doc/impl.clj

@@ -160,3 +160,8 @@
       (doseq [{:keys [method-description-md]} selected-method]
         (println (condense-lines method-description-md)))
       (println (condense-lines class-description-md)))))
+
+(defn print-signatures [{:keys [methods selected-method]}]
+  (let [methods-to-print (or selected-method methods)]
+    (doseq [{:keys [clojure-call]} methods-to-print]
+      (println clojure-call))))