jsdoc3 Questions
1
How to document API using jsdoc which has following form (single file)
// api.js
exports.addSocketEvents = function(socket) {
/**
* This will do that and ...
* @param {Object} data Some data
...
Sandeesandeep asked 10/10, 2015 at 14:14
1
Solved
/**
* @param {String} foo
* @param {Number} bar
*/
or
/**
* @param {string} foo
* @param {number} bar
*/
JSDoc @type documentation is not being explicit about it.
I always uppercase String...
1
Solved
I have a function with an array of objects as parameter and would like to describe the parameter (including the properties of the objects in the array) using JSDOC like in this example:
/**
* @pa...
Handsaw asked 30/8, 2015 at 9:53
1
Please, explain to me the best way to describe this module:
/**
* Common util methods
* @module Utils
*/
var Utils = (/** @lends module:Utils */
function () {
/**
* Some default value
* @...
1
Thanks to the answer found here:
https://mcmap.net/q/358985/-how-do-i-jsdoc-a-nested-object-39-s-methods
My JavaScript documentation is well-organized and well-formatted. Each namespace is a "par...
Conium asked 8/6, 2015 at 19:3
0
It is common in JavaScript to work with arrays that are essentially argument lists: a small fixed length, and known types for each position. This is especially true for ECMAScript 6, which introduc...
Agio asked 10/4, 2015 at 12:33
1
Solved
I faced a problem with understanding the purpose of namespaces and modules in a union. For example I have a class Game.utils.Matrix. I want to annotate Game as a namespace, utils as a module and Ma...
Casiecasilda asked 6/4, 2015 at 10:52
1
I'm looking for a tool to generate the documentation for JavaScript functions and properties even if there are no appropriately formatted comment blocks associated with those functions or pro...
Bingaman asked 20/2, 2014 at 15:1
1
Solved
UseJSDoc.org's page on @type explains how to document arrays and objects, but not arrays of objects. My function accepts an array of objects with a specific list of properties and it's these proper...
Encyclical asked 22/8, 2014 at 5:31
1
Solved
I'm wondering how to documenting jQuery plugin by using JSDoc? My code is:
/**
* The default configurations of comments
* @typedef {Object} CommentConfig
...
*/
/**
* Show comments
* @met...
Utley asked 23/7, 2014 at 4:13
1
Jsdoc is installed locally ( npm install jsdoc ). I get the following error while trying to execute
.\node_modules.bin\jsdoc --debug ./lib/JavaScriptSource.js
Output:
DEBUG: JSDoc 3.3.0-de...
Deroo asked 25/6, 2014 at 15:25
2
Solved
Currently within my Project we are using JSDoc, we have recently started to implement Angular and I want to continue using JSDoc to ensure that all the documentation is within the same place.
I ha...
1
Assuming I have some object, what the is way to comment it using jsdoc3?
/**
* Test object
* @namespace test
*/
var test = {
/**
* Some defaults
* @memberOf test
*/
defaults: {
'test1': 1...
Ravenravening asked 14/2, 2014 at 14:45
© 2022 - 2024 — McMap. All rights reserved.