Liking cljdoc? Tell your friends :D

XTDB style for Javadoc

styles.css is stylesheets to use with Javadoc.

Automated Build

The standard build for XTDB javadocs can be found under the deploy-api-docs target in the CircleCI config: .circleci/config.yml

Usage

# Add these parameters to your javadoc command to generate docs with XTDB CSS styles.
-encoding UTF-8 -docencoding utf-8 -charset utf-8 -stylesheetfile <path_to_styles.css>
# such as:
javadoc -Xdoclint:none -d xtdb-javadoc/ -cp `lein classpath` -sourcepath core/src xtdb.api -subpackages xtdb.api.tx -encoding UTF-8 -docencoding utf-8 -charset utf-8 -stylesheetfile docs/javadocs/styles.css

Can you improve this documentation?Edit on GitHub

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close