talios / clojure-maven-plugin

Apache Maven Mojo for compiling clojure scripts to class files
251 stars 74 forks source link

what does the `it` directory do? #110

Closed zcaudate closed 6 years ago

zcaudate commented 6 years ago

All the directories under src/it have a main/clojure/autodoc.clj file. What are they used for?

screen shot 2018-08-22 at 3 11 23 am
talios commented 6 years ago

On 22 Aug 2018, at 7:14, Chris Zheng wrote:

All the directories under src/it have a main/clojure/autodoc.clj file. What are they used for?

If you note there not under ALL the directories - only the various autodoc, and marginalia integration tests - the file is just a simple clojure namespace with a doc comment in it, which is the source from which autodoc/marginalia would generate documentation - the IT test just asserts that such a target doc file was created.

Mark


"The ease with which a change can be implemented has no relevance at all to whether it is the right change for the (Java) Platform for all time." — Mark Reinhold.

Mark Derricutt http://www.theoryinpractice.net http://www.chaliceofblood.net http://plus.google.com/+MarkDerricutt http://twitter.com/talios http://facebook.com/mderricutt

zcaudate commented 6 years ago

ah cool. thanks for the explanation.