Skip to content

Commit 480c67f

Browse files
Dermot SmythDermot Smyth
authored andcommitted
renamed mlJsDoc task to generateJsDoc
1 parent ad7cf8d commit 480c67f

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

examples/jsdoc-project/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This project uses the [JSDoc Gradle Plugin](https://github.com/liferay/liferay-p
1010
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
1111

1212
```
13-
gradle mlJsDoc
13+
gradle generateJsDoc
1414
```
1515

1616
This will generate jsdoc for the code in __src/main/ml-modules/lib__
@@ -21,6 +21,6 @@ The html documentation will be generated in __build/docs/jsdoc__
2121

2222
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.
2323

24-
To customise the jsdoc task generator, please customize the __mlJsDoc__ task in the __build.gradle__ file. Refer to the [JSDoc Gradle Plugin](https://github.com/liferay/liferay-portal/tree/master/modules/sdk/gradle-plugins-jsdoc) site for details on how to configure this.
24+
To customise the jsdoc task generator, please customize the __generateJsDoc__ task in the __build.gradle__ file. Refer to the [JSDoc Gradle Plugin](https://github.com/liferay/liferay-portal/tree/master/modules/sdk/gradle-plugins-jsdoc) site for details on how to configure this.
2525

2626

examples/jsdoc-project/build.gradle

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ plugins {
1414
}
1515

1616

17-
task mlJsDoc(type:com.liferay.gradle.plugins.jsdoc.JSDocTask) {
17+
task generateJsDoc(type:com.liferay.gradle.plugins.jsdoc.JSDocTask) {
1818
configuration = project.resources.text.fromFile(file("jsdoc.json"))
1919
destinationDir = "build/docs/jsdoc"
2020
sourceDirs = file("src/main/ml-modules/lib")

0 commit comments

Comments
 (0)