aboutsummaryrefslogtreecommitdiff
path: root/docs/dev/Javadocs.md
blob: 3a8365d90ea91b5924ce7f824d717ab2bf06a62b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
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**.