Skip to content

Commit 8978711

Browse files
[inspector] Don't show javadocs when inspecting classes
1 parent a411e1b commit 8978711

File tree

5 files changed

+11
-121
lines changed

5 files changed

+11
-121
lines changed

CHANGELOG.md

+1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
* [#913](https://github.com/clojure-emacs/cider-nrepl/pull/913): Disable background warmup of `orchard.java` cache.
66
* [#913](https://github.com/clojure-emacs/cider-nrepl/pull/913): Enable background warmup of Compliment cache.
7+
* [#914](https://github.com/clojure-emacs/cider-nrepl/pull/914): Remove javadoc section from the inspector output.
78

89
## 0.52.1 (2025-02-24)
910

doc/modules/ROOT/pages/nrepl-api/ops.adoc

-48
Original file line numberDiff line numberDiff line change
@@ -502,9 +502,6 @@ Optional parameters::
502502
{blank}
503503

504504
Returns::
505-
* `:doc-block-tags-fragments` May be absent. Represent the 'param', 'returns' and 'throws' sections a Java doc comment. It's a vector of fragments, where fragment is a map with ``:type`` ('text' or 'html') and ``:content`` plain text or html markup, respectively
506-
* `:doc-first-sentence-fragments` May be absent. Represents the first sentence of a Java doc comment. It's a vector of fragments, where fragment is a map with ``:type`` ('text' or 'html') and ``:content`` plain text or html markup, respectively
507-
* `:doc-fragments` May be absent. Represents the body of a Java doc comment, including the first sentence and excluding any block tags. It's a vector of fragments, where fragment is a map with ``:type`` ('text' or 'html') and ``:content`` plain text or html markup, respectively
508505
* `:path` Printed representation of current inspector path.
509506
* `:status` "done"
510507
* `:value` The inspector result. Contains a specially-formatted string that can be ``read`` and then rendered client-side.
@@ -525,9 +522,6 @@ Optional parameters::
525522
{blank}
526523

527524
Returns::
528-
* `:doc-block-tags-fragments` May be absent. Represent the 'param', 'returns' and 'throws' sections a Java doc comment. It's a vector of fragments, where fragment is a map with ``:type`` ('text' or 'html') and ``:content`` plain text or html markup, respectively
529-
* `:doc-first-sentence-fragments` May be absent. Represents the first sentence of a Java doc comment. It's a vector of fragments, where fragment is a map with ``:type`` ('text' or 'html') and ``:content`` plain text or html markup, respectively
530-
* `:doc-fragments` May be absent. Represents the body of a Java doc comment, including the first sentence and excluding any block tags. It's a vector of fragments, where fragment is a map with ``:type`` ('text' or 'html') and ``:content`` plain text or html markup, respectively
531525
* `:path` Printed representation of current inspector path.
532526
* `:status` "done"
533527
* `:value` The inspector result. Contains a specially-formatted string that can be ``read`` and then rendered client-side.
@@ -564,9 +558,6 @@ Optional parameters::
564558
{blank}
565559

566560
Returns::
567-
* `:doc-block-tags-fragments` May be absent. Represent the 'param', 'returns' and 'throws' sections a Java doc comment. It's a vector of fragments, where fragment is a map with ``:type`` ('text' or 'html') and ``:content`` plain text or html markup, respectively
568-
* `:doc-first-sentence-fragments` May be absent. Represents the first sentence of a Java doc comment. It's a vector of fragments, where fragment is a map with ``:type`` ('text' or 'html') and ``:content`` plain text or html markup, respectively
569-
* `:doc-fragments` May be absent. Represents the body of a Java doc comment, including the first sentence and excluding any block tags. It's a vector of fragments, where fragment is a map with ``:type`` ('text' or 'html') and ``:content`` plain text or html markup, respectively
570561
* `:path` Printed representation of current inspector path.
571562
* `:status` "done"
572563
* `:value` The inspector result. Contains a specially-formatted string that can be ``read`` and then rendered client-side.
@@ -586,9 +577,6 @@ Optional parameters::
586577
{blank}
587578

588579
Returns::
589-
* `:doc-block-tags-fragments` May be absent. Represent the 'param', 'returns' and 'throws' sections a Java doc comment. It's a vector of fragments, where fragment is a map with ``:type`` ('text' or 'html') and ``:content`` plain text or html markup, respectively
590-
* `:doc-first-sentence-fragments` May be absent. Represents the first sentence of a Java doc comment. It's a vector of fragments, where fragment is a map with ``:type`` ('text' or 'html') and ``:content`` plain text or html markup, respectively
591-
* `:doc-fragments` May be absent. Represents the body of a Java doc comment, including the first sentence and excluding any block tags. It's a vector of fragments, where fragment is a map with ``:type`` ('text' or 'html') and ``:content`` plain text or html markup, respectively
592580
* `:path` Printed representation of current inspector path.
593581
* `:status` "done"
594582
* `:value` The inspector result. Contains a specially-formatted string that can be ``read`` and then rendered client-side.
@@ -607,9 +595,6 @@ Optional parameters::
607595
{blank}
608596

609597
Returns::
610-
* `:doc-block-tags-fragments` May be absent. Represent the 'param', 'returns' and 'throws' sections a Java doc comment. It's a vector of fragments, where fragment is a map with ``:type`` ('text' or 'html') and ``:content`` plain text or html markup, respectively
611-
* `:doc-first-sentence-fragments` May be absent. Represents the first sentence of a Java doc comment. It's a vector of fragments, where fragment is a map with ``:type`` ('text' or 'html') and ``:content`` plain text or html markup, respectively
612-
* `:doc-fragments` May be absent. Represents the body of a Java doc comment, including the first sentence and excluding any block tags. It's a vector of fragments, where fragment is a map with ``:type`` ('text' or 'html') and ``:content`` plain text or html markup, respectively
613598
* `:path` Printed representation of current inspector path.
614599
* `:status` "done"
615600
* `:value` The inspector result. Contains a specially-formatted string that can be ``read`` and then rendered client-side.
@@ -628,9 +613,6 @@ Optional parameters::
628613
{blank}
629614

630615
Returns::
631-
* `:doc-block-tags-fragments` May be absent. Represent the 'param', 'returns' and 'throws' sections a Java doc comment. It's a vector of fragments, where fragment is a map with ``:type`` ('text' or 'html') and ``:content`` plain text or html markup, respectively
632-
* `:doc-first-sentence-fragments` May be absent. Represents the first sentence of a Java doc comment. It's a vector of fragments, where fragment is a map with ``:type`` ('text' or 'html') and ``:content`` plain text or html markup, respectively
633-
* `:doc-fragments` May be absent. Represents the body of a Java doc comment, including the first sentence and excluding any block tags. It's a vector of fragments, where fragment is a map with ``:type`` ('text' or 'html') and ``:content`` plain text or html markup, respectively
634616
* `:path` Printed representation of current inspector path.
635617
* `:status` "done"
636618
* `:value` The inspector result. Contains a specially-formatted string that can be ``read`` and then rendered client-side.
@@ -650,9 +632,6 @@ Optional parameters::
650632
{blank}
651633

652634
Returns::
653-
* `:doc-block-tags-fragments` May be absent. Represent the 'param', 'returns' and 'throws' sections a Java doc comment. It's a vector of fragments, where fragment is a map with ``:type`` ('text' or 'html') and ``:content`` plain text or html markup, respectively
654-
* `:doc-first-sentence-fragments` May be absent. Represents the first sentence of a Java doc comment. It's a vector of fragments, where fragment is a map with ``:type`` ('text' or 'html') and ``:content`` plain text or html markup, respectively
655-
* `:doc-fragments` May be absent. Represents the body of a Java doc comment, including the first sentence and excluding any block tags. It's a vector of fragments, where fragment is a map with ``:type`` ('text' or 'html') and ``:content`` plain text or html markup, respectively
656635
* `:path` Printed representation of current inspector path.
657636
* `:status` "done"
658637
* `:value` The inspector result. Contains a specially-formatted string that can be ``read`` and then rendered client-side.
@@ -672,9 +651,6 @@ Optional parameters::
672651
{blank}
673652

674653
Returns::
675-
* `:doc-block-tags-fragments` May be absent. Represent the 'param', 'returns' and 'throws' sections a Java doc comment. It's a vector of fragments, where fragment is a map with ``:type`` ('text' or 'html') and ``:content`` plain text or html markup, respectively
676-
* `:doc-first-sentence-fragments` May be absent. Represents the first sentence of a Java doc comment. It's a vector of fragments, where fragment is a map with ``:type`` ('text' or 'html') and ``:content`` plain text or html markup, respectively
677-
* `:doc-fragments` May be absent. Represents the body of a Java doc comment, including the first sentence and excluding any block tags. It's a vector of fragments, where fragment is a map with ``:type`` ('text' or 'html') and ``:content`` plain text or html markup, respectively
678654
* `:path` Printed representation of current inspector path.
679655
* `:status` "done"
680656
* `:value` The inspector result. Contains a specially-formatted string that can be ``read`` and then rendered client-side.
@@ -698,9 +674,6 @@ Optional parameters::
698674

699675

700676
Returns::
701-
* `:doc-block-tags-fragments` May be absent. Represent the 'param', 'returns' and 'throws' sections a Java doc comment. It's a vector of fragments, where fragment is a map with ``:type`` ('text' or 'html') and ``:content`` plain text or html markup, respectively
702-
* `:doc-first-sentence-fragments` May be absent. Represents the first sentence of a Java doc comment. It's a vector of fragments, where fragment is a map with ``:type`` ('text' or 'html') and ``:content`` plain text or html markup, respectively
703-
* `:doc-fragments` May be absent. Represents the body of a Java doc comment, including the first sentence and excluding any block tags. It's a vector of fragments, where fragment is a map with ``:type`` ('text' or 'html') and ``:content`` plain text or html markup, respectively
704677
* `:path` Printed representation of current inspector path.
705678
* `:status` "done"
706679
* `:value` The inspector result. Contains a specially-formatted string that can be ``read`` and then rendered client-side.
@@ -720,9 +693,6 @@ Optional parameters::
720693
{blank}
721694

722695
Returns::
723-
* `:doc-block-tags-fragments` May be absent. Represent the 'param', 'returns' and 'throws' sections a Java doc comment. It's a vector of fragments, where fragment is a map with ``:type`` ('text' or 'html') and ``:content`` plain text or html markup, respectively
724-
* `:doc-first-sentence-fragments` May be absent. Represents the first sentence of a Java doc comment. It's a vector of fragments, where fragment is a map with ``:type`` ('text' or 'html') and ``:content`` plain text or html markup, respectively
725-
* `:doc-fragments` May be absent. Represents the body of a Java doc comment, including the first sentence and excluding any block tags. It's a vector of fragments, where fragment is a map with ``:type`` ('text' or 'html') and ``:content`` plain text or html markup, respectively
726696
* `:path` Printed representation of current inspector path.
727697
* `:status` "done"
728698
* `:value` The inspector result. Contains a specially-formatted string that can be ``read`` and then rendered client-side.
@@ -742,9 +712,6 @@ Optional parameters::
742712
{blank}
743713

744714
Returns::
745-
* `:doc-block-tags-fragments` May be absent. Represent the 'param', 'returns' and 'throws' sections a Java doc comment. It's a vector of fragments, where fragment is a map with ``:type`` ('text' or 'html') and ``:content`` plain text or html markup, respectively
746-
* `:doc-first-sentence-fragments` May be absent. Represents the first sentence of a Java doc comment. It's a vector of fragments, where fragment is a map with ``:type`` ('text' or 'html') and ``:content`` plain text or html markup, respectively
747-
* `:doc-fragments` May be absent. Represents the body of a Java doc comment, including the first sentence and excluding any block tags. It's a vector of fragments, where fragment is a map with ``:type`` ('text' or 'html') and ``:content`` plain text or html markup, respectively
748715
* `:path` Printed representation of current inspector path.
749716
* `:status` "done"
750717
* `:value` The inspector result. Contains a specially-formatted string that can be ``read`` and then rendered client-side.
@@ -764,9 +731,6 @@ Optional parameters::
764731
{blank}
765732

766733
Returns::
767-
* `:doc-block-tags-fragments` May be absent. Represent the 'param', 'returns' and 'throws' sections a Java doc comment. It's a vector of fragments, where fragment is a map with ``:type`` ('text' or 'html') and ``:content`` plain text or html markup, respectively
768-
* `:doc-first-sentence-fragments` May be absent. Represents the first sentence of a Java doc comment. It's a vector of fragments, where fragment is a map with ``:type`` ('text' or 'html') and ``:content`` plain text or html markup, respectively
769-
* `:doc-fragments` May be absent. Represents the body of a Java doc comment, including the first sentence and excluding any block tags. It's a vector of fragments, where fragment is a map with ``:type`` ('text' or 'html') and ``:content`` plain text or html markup, respectively
770734
* `:path` Printed representation of current inspector path.
771735
* `:status` "done"
772736
* `:value` The inspector result. Contains a specially-formatted string that can be ``read`` and then rendered client-side.
@@ -786,9 +750,6 @@ Optional parameters::
786750
{blank}
787751

788752
Returns::
789-
* `:doc-block-tags-fragments` May be absent. Represent the 'param', 'returns' and 'throws' sections a Java doc comment. It's a vector of fragments, where fragment is a map with ``:type`` ('text' or 'html') and ``:content`` plain text or html markup, respectively
790-
* `:doc-first-sentence-fragments` May be absent. Represents the first sentence of a Java doc comment. It's a vector of fragments, where fragment is a map with ``:type`` ('text' or 'html') and ``:content`` plain text or html markup, respectively
791-
* `:doc-fragments` May be absent. Represents the body of a Java doc comment, including the first sentence and excluding any block tags. It's a vector of fragments, where fragment is a map with ``:type`` ('text' or 'html') and ``:content`` plain text or html markup, respectively
792753
* `:path` Printed representation of current inspector path.
793754
* `:status` "done"
794755
* `:value` The inspector result. Contains a specially-formatted string that can be ``read`` and then rendered client-side.
@@ -807,9 +768,6 @@ Optional parameters::
807768
{blank}
808769

809770
Returns::
810-
* `:doc-block-tags-fragments` May be absent. Represent the 'param', 'returns' and 'throws' sections a Java doc comment. It's a vector of fragments, where fragment is a map with ``:type`` ('text' or 'html') and ``:content`` plain text or html markup, respectively
811-
* `:doc-first-sentence-fragments` May be absent. Represents the first sentence of a Java doc comment. It's a vector of fragments, where fragment is a map with ``:type`` ('text' or 'html') and ``:content`` plain text or html markup, respectively
812-
* `:doc-fragments` May be absent. Represents the body of a Java doc comment, including the first sentence and excluding any block tags. It's a vector of fragments, where fragment is a map with ``:type`` ('text' or 'html') and ``:content`` plain text or html markup, respectively
813771
* `:path` Printed representation of current inspector path.
814772
* `:status` "done"
815773
* `:value` The inspector result. Contains a specially-formatted string that can be ``read`` and then rendered client-side.
@@ -829,9 +787,6 @@ Optional parameters::
829787
{blank}
830788

831789
Returns::
832-
* `:doc-block-tags-fragments` May be absent. Represent the 'param', 'returns' and 'throws' sections a Java doc comment. It's a vector of fragments, where fragment is a map with ``:type`` ('text' or 'html') and ``:content`` plain text or html markup, respectively
833-
* `:doc-first-sentence-fragments` May be absent. Represents the first sentence of a Java doc comment. It's a vector of fragments, where fragment is a map with ``:type`` ('text' or 'html') and ``:content`` plain text or html markup, respectively
834-
* `:doc-fragments` May be absent. Represents the body of a Java doc comment, including the first sentence and excluding any block tags. It's a vector of fragments, where fragment is a map with ``:type`` ('text' or 'html') and ``:content`` plain text or html markup, respectively
835790
* `:path` Printed representation of current inspector path.
836791
* `:status` "done"
837792
* `:value` The inspector result. Contains a specially-formatted string that can be ``read`` and then rendered client-side.
@@ -850,9 +805,6 @@ Optional parameters::
850805
{blank}
851806

852807
Returns::
853-
* `:doc-block-tags-fragments` May be absent. Represent the 'param', 'returns' and 'throws' sections a Java doc comment. It's a vector of fragments, where fragment is a map with ``:type`` ('text' or 'html') and ``:content`` plain text or html markup, respectively
854-
* `:doc-first-sentence-fragments` May be absent. Represents the first sentence of a Java doc comment. It's a vector of fragments, where fragment is a map with ``:type`` ('text' or 'html') and ``:content`` plain text or html markup, respectively
855-
* `:doc-fragments` May be absent. Represents the body of a Java doc comment, including the first sentence and excluding any block tags. It's a vector of fragments, where fragment is a map with ``:type`` ('text' or 'html') and ``:content`` plain text or html markup, respectively
856808
* `:path` Printed representation of current inspector path.
857809
* `:status` "done"
858810
* `:value` The inspector result. Contains a specially-formatted string that can be ``read`` and then rendered client-side.

src/cider/nrepl.clj

+4-4
Original file line numberDiff line numberDiff line change
@@ -300,10 +300,10 @@ Note: Documentation may be incomplete; not all return keys are described."
300300
"ns" "The current namespace"}
301301
:returns {"status" "done"}}}}))
302302

303-
(def inspector-returns (merge {"status" "\"done\""
304-
"value" "The inspector result. Contains a specially-formatted string that can be `read` and then rendered client-side."
305-
"path" "Printed representation of current inspector path."}
306-
fragments-doc))
303+
(def inspector-returns
304+
{"status" "\"done\""
305+
"value" "The inspector result. Contains a specially-formatted string that can be `read` and then rendered client-side."
306+
"path" "Printed representation of current inspector path."})
307307

308308
(def-wrapper wrap-inspect cider.nrepl.middleware.inspect/handle-inspect
309309
#{"eval"}

0 commit comments

Comments
 (0)