jsdoc3 Questions
1
Given the following code, how do I properly document that using the latest JSDoc?
function docMe([foo, bar = null, baz = 1]) {
/* */
}
I have tried this:
/**
* @param {Array} options Array ...
Stephanystephen asked 5/2, 2020 at 16:20
1
Solved
I have a function with a huge list of options:
/**
* Show dialog in a blocking manner.
*
* @param {object} opts
* @param {string} opts.msg "Body" of the dialog.
* @param {number} opts.timeout...
0
I have an issue with npm and jsdoc. This question is similar to, but not the same as: How do I get my npm module's JSdoc documentation for functions to show up in users' VScode? In my case,...
Overarch asked 30/8, 2019 at 12:9
2
Solved
I'm using Node.js with two modules and one script that depends on them:
lib/Bar.js
module.exports = class Bar {
// ..
};
lib/Foo.js
const Bar = require('./Bar.js');
module.exports = class Fo...
Iridaceous asked 4/8, 2017 at 11:40
3
Solved
How can I tell JSDoc about the structure of an object that is returned. I have found the @return {{field1: type, field2: type, ...}} description syntax and tried it:
/**
* Returns a coordinate fr...
Gossipry asked 27/2, 2015 at 10:49
3
Solved
I am using JSDOC and all it supported npm plugins to create nice documentation. Getting hard time when jsdoc is running and parsing JSX file it always throws error as below near = sign
SyntaxError...
Battleplane asked 1/11, 2016 at 19:36
2
Solved
I am working on an app which will become quite huge in time. I have decided to use JsDoc3 and DocStrap to document all modules. Modules are defined via require.js and in some places they are nested...
Sokotra asked 2/1, 2016 at 22:54
3
I am struggling documenting router.get calls with JSDocs. I am unable to get the documentation to display correctly on the page if I try to append it to my router call itself.
/**
* Health check
...
0
I'm trying to comment an entire file describing an overall functionality. I put something like this at the top of each file
/**
* @file File with helper functions that facilitate reading config J...
Archaeology asked 26/10, 2018 at 7:25
5
Solved
After running a basic JSDoc compile/render from Node.js:
jsdoc file1.js file2.js
I get a well-formatted document using the default template inside a directory "out". Almost all is as expected!
...
Flutterboard asked 8/6, 2015 at 18:26
1
According to the doc, JSDoc supports destructuring parameters:
/**
* Assign the project to an employee.
* @param {Object} employee - The employee who is responsible for the project.
* @param {s...
Aspirate asked 2/6, 2018 at 9:28
5
I've been trying to document the following code using JSDoc:
/**
* @module person
*/
/**
* A human being.
* @class
* @param {string} name
*/
function Person(name){
this.name = name
}
Per...
Cubiform asked 7/12, 2014 at 13:33
2
Solved
I'm using JSDoc and I would like to add the info to my documentation which value a parameter should have.
In this example you can see, that the parameter operator has string type. But furthermore ...
Babbling asked 22/12, 2017 at 21:29
3
Solved
I'm using documentationjs (which uses jsdoc under the hood) to handle the generation of docs for a lib I'm working on. My lib is written is ES6 and is fully functional, and at present the documenta...
Mischief asked 27/9, 2017 at 17:59
2
Question:
I'm editing and using an open source javascript library that has JSDoc tags in its code. I was wondering if anyone knew of a JSDoc plugin that would allow me to generate a class diagram f...
1
Solved
I have the following higher order function for wrapping contructors:
/**
* Wrapper for calling constructor with given parameters
*
* @param {Class} Cls
* @returns {function} Wrapper on constru...
Columniation asked 11/4, 2017 at 3:48
1
I am trying to create custom tags in jsdoc 3.4.2. The config.json file is
{
"tags": {
"allowUnknownTags": true,
"dictionaries": ["jsdoc","closure"]
},
"source": {
"include": [
"app/"
],
...
Unlicensed asked 26/10, 2016 at 13:39
2
Solved
I've got a function which takes an array of objects.
Looks like this.
myAwesomeFunction([
{
name: 'someName',
next: false,
test: 'test'
},
{
name: 'nameTwo',
next: true
}
]);
So far my ...
Belter asked 9/10, 2016 at 11:7
3
I am using JS Doc version 3 (https://github.com/jsdoc3/jsdoc). When I run the tool, by default it generates documentation in HTML format. Is it possible to generate doc in PDF format?
Extinction asked 11/10, 2016 at 15:2
1
Solved
E.g. MyClass.js
/**
* @class
* @name module:Bar
* @param {number} a1
* @param {string} a2
*/
function Bar(a1, a2){}
And, in another file:
/** @type module:Bar.constructor */ // made up syn...
Octarchy asked 19/10, 2016 at 9:8
4
Solved
I've been trying to use JSDoc3 to generate documentation on a file, but I'm having some difficulty. The file (which is a Require.js module) basically looks like this:
define([], function() {
/*
...
Anathematize asked 7/10, 2013 at 17:23
1
Solved
I am using @JSDoc to create documentation for my javascript library. I know how to indicate optional parameter. like below
/*
* @param {string} [somebody] - Somebody's name.
*/
function sayHello...
Tabular asked 23/8, 2016 at 4:54
4
The objective is to get JSDoc documentation from TypeScript code. The quality of documentation from TypeDoc (TypeScript documentation solution) isn't acceptable because the documentation is targete...
Theophany asked 3/2, 2016 at 11:8
1
I used the following command to generate html from the javascript file.
$> jsdoc --debug jquery.js
$> open out/index.html
Output of the command
DEBUG: JSDoc 3.3.2 (Sat, 13 Jun 2015 22:20...
1
I'm looking for the best way to document my code, but I don't find anything.
I've see others topics, including this, but there all doesn't resolve my problem.
I have something like this:
define(...
Nepenthe asked 6/11, 2015 at 10:42
© 2022 - 2024 — McMap. All rights reserved.