Skip to content

Commit 68a93d1

Browse files
mnoman09thomaszurkan-optimizely
authored andcommitted
Added docs folder and in it we added instructions of how to generate documentation (#192)
* Added Readme.md for generating docs * Updated Readme.md * Updated readme.md * Updated readme changed regex
1 parent 89d18ac commit 68a93d1

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

docs/readme.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Generate Code Documentation
2+
### Steps
3+
* Checkout **master** branch.
4+
* Open project in **IntelliJ**.
5+
* Go to **Tools -> Generate JavaDoc**
6+
* Make sure **Generate JavaDoc scope -> Custom Scope** is checked.
7+
* Click on three dotted icon to make custom scope.
8+
* Give name **Custom_Docs**.
9+
* Copy and paste following regex: **`!*..internal..*&&!test:*..*&&!lib:*..*`** into **Pattern** and click **OK**.
10+
* Uncheck **Include test sources**.
11+
* Select **Output Directory**.
12+
* Click **OK**.
13+
* This will generate HTML documentation in given **Output Directory**.
14+
* Browse **Output Directory/index.html** in browser.

0 commit comments

Comments
 (0)