Skip to content

Commit e171053

Browse files
mnoman09thomaszurkan-optimizely
authored andcommitted
Added Readme.md in docs folder with instructions of how to generate sdk documentation (#203)
* Added Readme.md to generate java docs * Updated docs/readme.md instructions to generate documentations
1 parent 992acca commit e171053

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

docs/readme.md

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

0 commit comments

Comments
 (0)