diff options
| author | Timothy Farkas <timothyfarkas@apache.org> | 2018-05-08 11:11:33 -0700 |
|---|---|---|
| committer | Sorabh Hamirwasia <sorabh@apache.org> | 2018-06-06 09:06:22 -0700 |
| commit | e0c39e070bb696d2bc67f60f18559e5a547208ad (patch) | |
| tree | bbe50bab85684144d6bf3cdca7c63aa1934667f1 /docs | |
| parent | d05ce7fdf095976a98e66e32d7c27ee016aaf9fc (diff) | |
DRILL-6389: Fixed building javadocs
- Added documentation about how to build javadocs
- Fixed some of the javadoc warnings
closes #1276
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/dev/DevDocs.md | 4 | ||||
| -rw-r--r-- | docs/dev/Javadocs.md | 20 |
2 files changed, 24 insertions, 0 deletions
diff --git a/docs/dev/DevDocs.md b/docs/dev/DevDocs.md index 3fb76157d..9b6ec09bb 100644 --- a/docs/dev/DevDocs.md +++ b/docs/dev/DevDocs.md @@ -11,3 +11,7 @@ For information about how to do integration and unit testing in Drill see [Testi ## License Headers For more information about working with license headers see [LicenseHeaders.md](LicenseHeaders.md) + +## Javadocs + +For more info about generating and using javadocs see [Javadocs.md](Javadocs.md) 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**. |