Cause For anyone seeing this, if you have written your own assert function, keep in mind that TypeScript cannot use arrowFunctions for assertions. See https://github.com/microsoft/TypeScript/issues/34523 Fix Change your assert function from an arrowFunction to standard function.
In JSDoc 3.1 and later, you can use the new @callback tag to describe the callback function in a separate comment block. You can then refer to the callback in the docs for your method. Here’s an example: /** @class */ function MyClass() {} /** * Do something. * @param {MyClass~onSuccess} cb – Called on … Read more
I do the following in my code. /** Express router providing user related routes * @module routers/users * @requires express */ /** * express module * @const */ const express = require(‘express’); /** * Express router to mount user related functions on. * @type {object} * @const * @namespace usersRouter */ const router = express.Router(); … Read more
I’ll take a shot in the dark here since I can’t speak for the jQuery team of why I wouldn’t use JSDoc. JSDoc, at least the last time I checked, didn’t have any clean way to support method overloading (or parameter shifting…whatever name you want to give it here) and jQuery uses this all over … Read more
If you’re familiar with Grunt, you can easily generate .html docs with grunt-jsdoc. Document your code with JSDoc. Use grunt-jsdoc which internally uses jsdoc to generate code documentation. This will also output the source code in HTML and within the documentation it will include links to code lines for each publicly accessible member. You can … Read more
This method worked for me. In markdown (or in StackOverflow), you need to have two line breaks (ie an additional one) to start new line (or paragraph). same method worked for JSDoc /** * Converts the prefixed value to the specified base. * * Requires one of the following prefixes: * * ‘0b’ Base 2: … Read more
Since Typescript 4.5: const foo = /** @type {const} */ ({x: 1}); const bar = /** @type {const} */ (“baz”); Note that the parentheses are required; this is cast syntax, not normal type annotation.
I have encountered this issue as well. I am now writing documentation for angularjs codes through jsdoc comments like this: 1.Make a blank .js file with the following comment: /** * @namespace angular_module */ This will create a separate html in the generated documentation for listing all modules. 2.In javascript files that defines any new … Read more
You can use @namespace with @name and @lends like this: /** * @name MyNamespace * @namespace Hold all functionality */ (function () { “use strict”; /** @lends MyNamespace*/ var stlib = function (param, param, param) { …All of my code…}; }());
According to http://code.google.com/p/jsdoc-toolkit/wiki/TagParam it should be Param type before param name. /** * Initializes a login object. * @param {jQuery} formEl The login form element on the page. */ var login = function(formEl){ … }