Top "Jsdoc" questions

JSDoc is a markup language for adding inline API documentation to JavaScript source code.

Angular2 Documentation Generator

Is there a documentation generator (may be a node package) like in other programming languages (jsdoc / phpdoc / javadoc / ..) for typescript-based …

typescript angular documentation-generation jsdoc
How to document a Require.js (AMD) Modul with jsdoc 3 or jsdoc?

I have 2 types of Modules: Require.js Main File: require.config({ baseUrl: "/another/path", paths: { "some": "some/v1.0" }, waitSeconds: 15, locale: "…

javascript requirejs jsdoc js-amd
Is there a way to define generic types in JS documentation?

I'm looking for documentation generator for my JS library. I find JSDuck the most comprehensive and powerful one. But I …

javascript generics documentation jsdoc jsduck
How to "import" a typedef from one file to another in JSDoc using Node.js?

Let's say I have a file named "File1.js". In this file, I export an object of objects and I …

javascript node.js jsdoc
What is the JSDoc type for document.getElementById('myID') and a jQuery Element?

I'm trying to document my functions with JSDoc syntax. /** * * My Description * * @param {JQuery|???} input * @returns {JQuery} */ function foo(input){ return $(…

javascript jsdoc
How to document anonymous functions (closure) with jsdoc-toolkit

I am trying to document my code using JSDoc-toolkit. My code starts by being wrapped with a self-executing anonymous function. …

javascript comments closures anonymous-function jsdoc
jsdoc : reference typedef-ed type from other module

Assuming I have a typedef type in a js module // somewhere/foo.js /** * @module */ /** * @typedef Foo * @type {object} * property {string} …

jsdoc jsdoc3
jsdoc: multiline description @property

I am documenting my code using jsdoc, so far so good, I have a comment like below ... * @property {string} mode …

javascript documentation jsdoc jsdoc3
JSDoc - how to document prototype methods

I've been trying to document the following code using JSDoc: /** * @module person */ /** * A human being. * @class * @param {string} name */ function …

javascript documentation-generation jsdoc code-documentation jsdoc3
Default "Home" text and content for JSDoc

After running a basic JSDoc compile/render from Node.js: jsdoc file1.js file2.js I get a well-formatted document …

javascript jsdoc jsdoc3