We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
1 parent 625b901 commit dcef07eCopy full SHA for dcef07e
examples/jsdoc-project/src/main/ml-modules/lib/sample.sjs
@@ -1,13 +1,24 @@
1
2
+function internalHello(str) {
3
+ return `Hello ${str}`
4
+}
5
+
6
/**
- * Returns "Hello " plus the str parameter
7
+ * Sample Module
8
*
- * @example
- * // returns "Hello World"
- * hello("World")
- *
9
- * @param {string} str the string to say hello to
+ * @module "/sample.sjs"
10
+ * @exports hello
11
*/
-function hello(str) {
12
- return `Hello ${str}`
+module.exports = {
13
+ /**
14
+ * Returns "Hello " plus the str parameter
15
+ *
16
+ * @example
17
+ * const sampleLib = require("/sample.sjs")
18
+ * // returns "Hello World"
19
+ * sampleLib.hello("World")
20
21
+ * @param {string} str the string to say hello to
22
+ */
23
+ hello: internalHello
24
}
0 commit comments