aboutsummaryrefslogtreecommitdiff
path: root/docs/dev/Javadocs.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/dev/Javadocs.md')
-rw-r--r--docs/dev/Javadocs.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/docs/dev/Javadocs.md b/docs/dev/Javadocs.md
new file mode 100644
index 000000000..3a8365d90
--- /dev/null
+++ b/docs/dev/Javadocs.md
@@ -0,0 +1,20 @@
+# Javadocs
+
+## Building
+
+ 1. Make sure you are in drill's root project directory.
+ 1. Build the project:
+ ```
+ mvn -T 1C clean install -DskipTests
+ ```
+ 1. Run:
+ ```
+ mvn javadoc:aggregate
+ ```
+ 1. The javadocs are generated and stored in `target/site/apidocs`.
+
+## Viewing In IntelliJ
+
+ 1. Go to `target/set/apidocs/index.html` in IntelliJ's project view.
+ 2. Right click on `target/set/apidocs/index.html`
+ 3. Select **Open in Browser**.