Stack Overflow
Stack Overflow

Questions tagged [marginalia]

marginalia is a Clojure library that uses comments in a Clojure source-code file to create an enhanced documentation web page. This page displays the source code itself (without comments), moving the comments to a separate column to the left of the source code.

marginalia is a Clojure library that uses comments in a Clojure source-code file to create an enhanced documentation web page. This page displays the source code itself (without comments), moving the comments to a separate column to the left of the source code.

You can see an example of the library's output at http://fogus.me/fun/marginalia/.

5 questions
76
votes
7 answers

What is the difference between ; and ;; in Clojure code comments?

What is the difference between ; and ;; when starting a comment in Clojure? I see that my text editor colours them differently, so I'm assuming there is notionally some difference. I also see that Marginalia treats them differently: ; Stripped…
pauldoo
  • 18,087
  • 20
  • 94
  • 116
34
votes
4 answers

State of the Art for Clojure Documentation Tools

Over the last year or so I've seen various announcements on the Clojure discussion list and other places about tools for documenting Clojure code. These range from full-on literate programming systems like Marginalia, and the tool being used to…
rplevy
  • 5,393
  • 3
  • 32
  • 31
7
votes
2 answers

Clojure equivalent to Python doctest?

Python doctests associate simple tests with the source code (in Python they are in the function documentation). More info and examples here. Is there anything similar for Clojure? I am aware of unit tests with clojure.test, but looking for…
andrew cooke
  • 45,717
  • 10
  • 93
  • 143
3
votes
3 answers

Marginalia / Docco / etc for Java Maven projects?

Is it possible to run Marginalia on a Java (multi-module) project which uses Maven? Or is there any other alternative that's similar to Marginalia or Docco that can do this? What's important to me is to be able to add it as a dependency from some…
Martin Spa
  • 1,494
  • 1
  • 24
  • 44
1
vote
2 answers

Clojure: Marginalia: Multi Page Documentation

Question (run-marginalia {}) produces a single file, docs/uberdoc.html I would prefer it to produce many files in docs/*, one per *.clj file Motivation: I really like marginalia. I have recently started using it, and it's causing me to want to…
user1311390