How to write clojure documentation for a single function in a protocol?

Question

Let's say I have a protocol like this:

(defprotocol X
  (y [this z]))

How do I write documentation targeted only for function y?

The normal way for doing this would be:

(defn y
  "Some documentation"
  [])

But if I do:

(defprotocol X
  (y
    "Some documentation" 
    [this z]))

I get the following exception:

java.lang.IllegalArgumentException: Parameter declaration missing

So how do I add this kind of documentation?

Community · Accepted Answer · 2020-06-20 09:12:55Z

4

You can find examples of a protocol on clojuredocs :

(defprotocol Fly
  "A simple protocol for flying"
  (fly [this] "Method to fly"))

Alternatively bang your REPL or look at the source :

;method signatures

(bar [this a b] \"bar docs\")
(baz [this a] [this a b] [this a b c] \"baz docs\"))

CommunityBot

11 silver badge

answered Mar 17, 2016 at 9:00

nha

18.1k15 gold badges95 silver badges141 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

ayato_p · Accepted Answer · 2016-03-17 08:50:28Z

3

(defprotocol X
  (y [this z] "Some documentation"))

answered Mar 17, 2016 at 8:50

ayato_p

4333 silver badges8 bronze badges