Skip to content

Commit 32a41f3

Browse files
Brent Hartwigrjrudin
authored andcommitted
Revised documentation to reference gradle.properties and document the environment this was last successfully tested in.
1 parent 8788419 commit 32a41f3

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

examples/jsdoc-project/README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,20 @@ This project uses the [JSDoc Gradle Plugin](https://github.com/liferay/liferay-p
77

88
## Usage
99

10-
All of the configuration is captured in the __build.gradle__ file and the __jsdoc.json__ file. To test this, clone this repoitory and execute the command below in this directory
10+
Configuration is captured in __build.gradle__, __gradle.properties__, and __jsdoc.json__.
1111

12-
```
13-
gradle generateJsDoc
14-
```
12+
To test:
13+
14+
1. Clone this repoitory.
15+
1. Review the default property values provided in __gradle.properties__. If any do not match your environment, override in __gradle-local.properties__ (not provided).
16+
1. Run `gradle generateJsDoc`
1517

1618
This will generate jsdoc for the code in __src/main/ml-modules/lib__
1719

1820
The html documentation will be generated in __build/docs/jsdoc__
1921

22+
Tested with Java 11, Gradle 5.6.4, ml-gradle 4.0.4, Node.js 12.18.3, Liferay node 7.2.0, and Liferay app jsdoc 2.0.54 on Windows 10 Pro 64-bit.
23+
2024
## Customize
2125

2226
To customise the jsdoc output, you can modify the __jsdoc.json__ file. Refer to the http://usejsdoc.org/about-configuring-jsdoc.html site for details on how to configure this.

0 commit comments

Comments
 (0)