【文件属性】:
文件名称:codox:Clojure文档工具
文件大小:129KB
文件格式:ZIP
更新时间:2021-02-01 05:47:17
documentation clojure docs-generator ClojureClojure
科多克斯
从Clojure或ClojureScript源代码生成API文档的工具。
用法
莱宁根
在您的project.clj文件或全局配置文件中包含以下插件:
:plugins [[lein-codox " 0.10.7 " ]]
然后运行:
lein codox
这将在“ target / doc”子目录(或您的项目:target-path设置到的任何位置)中生成API文档。
开机
将boot-codox添加到build.boot依赖项中,并需要名称空间:
(set-env! :dependencies '[[boot-codox "0.10.7" :scope "test"]])
(require '[codox.boot :refer [codox]])
您可以在命令行上看到可用的选项:
$ boot codox -h
或在REPL中:
boot.user=> (doc codox)
请记住使用引导程序的内置target任务将文件输出到目标目录:
$ boot codox target
0.9的重大变化
为准备1.0版,Codox 0.9进行了许多重大更改:
L
【文件预览】:
codox-master
----.gitignore(78B)
----codox()
--------src()
--------resources()
--------licenses()
--------project.clj(585B)
----CONTRIBUTING.md(1KB)
----CHANGELOG.md(6KB)
----LICENSE.txt(11KB)
----README.md(12KB)
----example()
--------src()
--------resources()
--------doc()
--------src-typed()
--------build.boot(510B)
--------project.clj(2KB)
----lein-codox()
--------src()
--------project.clj(358B)
----boot-codox()
--------src()
--------project.clj(236B)