From 1628bca0cd1437ee2b3bfc0d80231e3d178ffb85 Mon Sep 17 00:00:00 2001 From: oakes Date: Mon, 31 Mar 2014 01:14:44 -0400 Subject: [PATCH] Indicate return value when appropriate --- doclet/src/clojure/play_clj_doclet/core.clj | 5 ++++- doclet/src/clojure/play_clj_doclet/html.clj | 6 ++++-- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/doclet/src/clojure/play_clj_doclet/core.clj b/doclet/src/clojure/play_clj_doclet/core.clj index 518782f..f2cf18a 100644 --- a/doclet/src/clojure/play_clj_doclet/core.clj +++ b/doclet/src/clojure/play_clj_doclet/core.clj @@ -5,7 +5,7 @@ [marginalia.core :as marg] [play-clj-doclet.html :as html]) (:import [com.sun.javadoc ClassDoc ConstructorDoc Doc ExecutableMemberDoc - FieldDoc Parameter RootDoc])) + FieldDoc MethodDoc Parameter RootDoc])) (def targets (-> "targets.edn" io/resource slurp edn/read-string)) @@ -37,6 +37,9 @@ {:name n}) (when (> (count (.commentText d)) 0) {:text (.commentText d)}) + (when (and (isa? (type d) MethodDoc) + (not= (-> d .returnType .typeName) "void")) + {:type (-> d .returnType .typeName)}) (cond (isa? (type d) ExecutableMemberDoc) {:args (->> d .parameters (map parse-param) vec)} diff --git a/doclet/src/clojure/play_clj_doclet/html.clj b/doclet/src/clojure/play_clj_doclet/html.clj index c95d38c..b9a9573 100644 --- a/doclet/src/clojure/play_clj_doclet/html.clj +++ b/doclet/src/clojure/play_clj_doclet/html.clj @@ -10,13 +10,15 @@ param-name])) (defn item - [{:keys [name text args]}] + [{:keys [name text type args]}] [:div [:p [:b (str name)] " " (string/join ", " (map param args))] - (when text [:i text])]) + (cond + text [:i text] + type [:i (str "Returns a " type)])]) (defn create-from-file [parsed-file]