History

Convert all "/**jsdoc" occurrences to "/*@jsdoc"

David Rowe committed 5 years ago

Commit 4d11d1d1 parent 2130dea220 files · +2319 −2319Browse files

Showing the changes to plugins/JSAPIExample/src/JSAPIExample.cpp (1 of 220 files). Show all

Unified · Split

plugins/JSAPIExample/src/JSAPIExample.cpp+5−5
@@ -77,7 +77,7 @@ namespace REPLACE_ME_WITH_UNIQUE_NAME { · 76 unmodified lines
7777 // (note: Qt script engines automatically look for a ".toString" method on native classes when coercing values to strings)
7878 QString toString() const { return QString("[%1 version=%2]").arg(objectName()).arg(_version); }
7979
80− /**jsdoc
80+ /*@jsdoc
8181 * Returns current microseconds (usecs) since Epoch. note: 1000usecs == 1ms
8282 * @example <caption>Measure current setTimeout accuracy.</caption>
8383 * var expected = 1000;
@@ -89,7 +89,7 @@ namespace REPLACE_ME_WITH_UNIQUE_NAME { · 5 unmodified lines
8989 */
9090 QVariant now() const { return usecTimestampNow(); }
9191
92− /**jsdoc
92+ /*@jsdoc
9393 * Example of returning a JS Object key-value map
9494 * @example <caption>"zip" a list of keys and corresponding values to form key-value map</caption>
9595 * print(JSON.stringify(JSAPIExample.zip(["a","b"], [1,2])); // { "a": 1, "b": 2 }
@@ -102,7 +102,7 @@ namespace REPLACE_ME_WITH_UNIQUE_NAME { · 6 unmodified lines
102102 return out;
103103 }
104104
105− /**jsdoc
105+ /*@jsdoc
106106 * Example of returning a JS Array result
107107 * @example <caption>emulate Object.values(keyValues)</caption>
108108 * print(JSON.stringify(JSAPIExample.values({ "a": 1, "b": 2 }))); // [1,2]
@@ -112,7 +112,7 @@ namespace REPLACE_ME_WITH_UNIQUE_NAME { · 3 unmodified lines
112112 return values;
113113 }
114114
115− /**jsdoc
115+ /*@jsdoc
116116 * Another example of returning JS Array data
117117 * @example <caption>generate an integer sequence (inclusive of [from, to])</caption>
118118 * print(JSON.stringify(JSAPIExample.seq(1,5)));// [1,2,3,4,5]
@@ -125,7 +125,7 @@ namespace REPLACE_ME_WITH_UNIQUE_NAME { · 6 unmodified lines
125125 return out;
126126 }
127127
128− /**jsdoc
128+ /*@jsdoc
129129 * Example of returning arbitrary binary data from C++ (resulting in a JS ArrayBuffer)
130130 * see also: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer#Examples
131131 * @example <caption>return compressed/decompressed versions of the input data</caption>