We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent 89d18ac commit 68a93d1Copy full SHA for 68a93d1
docs/readme.md
@@ -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