Stack Overflow
Stack Overflow

Questions tagged [jsdoc3]

JSDoc3 is an API documentation generator for JavaScript. It can be customised via a plugin mechanism and the output can be controlled via templates. It is written in Javascript and can be run with Node.js or Rhino.

JSDoc 3

JSDoc3 is an API documentation generator for JavaScript. It can be customised via a plugin mechanism and the output can be controlled via templates.

It is written in Javascript and can be run with Node.js or Rhino.

The tool can be found at https://github.com/jsdoc3/jsdoc

The documentation can be found at http://usejsdoc.org/

279 questions
0
votes
0 answers

How to auto generate sub menus in menu section while generating documentation using jsdoc

I want to auto generate a sub menu like this while generating documentation using Jsdoc. Is it possible to do so? If yes then show me the way it's been done.Sample docs with submenu (Edited) got an easier way to do documentation with (ReadTheDocs)
Ansuman
  • 1
  • 4
0
votes
1 answer

Jsdoc namespacing with revealing module pattern

I'm trying to get namespacing to work with the revealing module pattern. I have code that looks similar to the following: /** * @namespace bigpage */ var bigpage = {}; /** * @namespace bigpage.data.methods * @memberOf…
Ryder Bergerud
  • 733
  • 1
  • 6
  • 15
0
votes
1 answer

Returning a object with specific property and type

I have a function operation that takes two arguments str (a String) and fn (a Function). function operation(str, fn){ var temp = {} temp[str] = fn return temp } How do you describe this return value? What does this return value look like in…
ThomasReggi
  • 42,912
  • 63
  • 199
  • 343
0
votes
0 answers

JSDoc - proper way to create custom type in a separated file

I want to create custom type in order to for example code completion, in separated file named custom-types.js, in way I found in Rzslider angular repository, in file Rzslider.js file at the bottom: /** * * @name Author * @property {number} id *…
Radek Anuszewski
  • 1,620
  • 6
  • 28
  • 56
0
votes
1 answer

extending jsDoc to handle custom tags

I'm looking to extend jsdoc (particularly with docstrap). I have a nodeJS application and want to split the jsdoc navigation to Controllers, Views ,etc. I've managed up to a certain extent with this by creating my custom tags such as @controller…
user584569
  • 155
  • 10
0
votes
1 answer

JSDoc output inconsistent between gulp-jsdoc & standard CLI

I'm trying to build docs for a simple set of JS code (given below). If I use gulp, the docs are created how I would expect them. If I use the CLI, the docs are incomplete. Here's my JS code: // BASE.js /** @module BASE */ var BASE = {}; //…
TheJim01
  • 6,362
  • 1
  • 17
  • 44
0
votes
1 answer

Issues creating AngularJS documentation using JsDoc3

I have an AngularJS factory that I am trying to generate documentation for using Jsdoc. The logic is below: (function (angular) { /** * @module factories * @memberOf angular_module */ var factories =…
fhevol
  • 782
  • 7
  • 27
0
votes
1 answer

ES 2015 related features and templates

i) Could an inheritance hierarchy be implemented in a template? ii) The templates I have seen all list methods alphabetically, could they be listed in the same order as in the source code? (I appreciate this is not particularly needed for ES5,…
user5321531
  • 2,545
  • 5
  • 21
  • 27
0
votes
2 answers

Generating JSDocs from Parse.com Cloud Code

I'm using Parse for a mobile app, I have a few Cloud Code functions and I want to generate documentation using JSDoc. If I do this: /** This is a Cloud Code function */ Parse.Cloud.define('foo', function(request, response){ }); JSDoc does not…
Edu
  • 1,089
  • 7
  • 12
0
votes
1 answer

The right way to use JSDoc to document a data object's members, when I add them one by one?

I have a JS data object that just holds some static items. I'm not declaring it all in one go inside { }; I start with an empty object, and add items in one at a time. E.g: var ScapeStuff = {}; // some generic stuff ScapeStuff.generic = new…
Daniel Baird
  • 2,129
  • 1
  • 16
  • 23
0
votes
1 answer

Document mid-function optional parameters

Is there a proper syntax for documenting optional JavaScript parameters, where the optional parameter comes in the middle of the function header (think jQuery, Gulp, etc.) I've documented the function in the standard way and that works fine. The…
samanime
  • 21,211
  • 7
  • 69
  • 122
0
votes
1 answer

Syntax to use to document the fields of a function parameter which is an object

I was wondering what is the proper way to document an argument (which is an object) and all of its properties. If I understood correctly square brackets mean "optional", is that right? Is the syntax I used to describe the object properties…
elad.chen
  • 2,182
  • 5
  • 22
  • 32
0
votes
1 answer

JSDoc: node, events, listeners

I am trying to document a pretty extensive (to me) code-base written in JS/NodeJS. JSDoc seems the only valid tool available but there are challenges. Here are two that I would like to know how to document: 1) I 'require' a module (Buzz) and then…
MikeB
  • 766
  • 1
  • 7
  • 26
0
votes
1 answer

JSDoc3 with Dojo and AMD

I am trying to get my JS documentation right. I am using Dojo, and some other complicated framework built on top of it, I will spare the details. The point is that this framework is using AMD modules. I want my JSDoc to work. Here is what I have so…
Frederic Fortier
  • 740
  • 6
  • 21
0
votes
1 answer

jsdoc @callback operator in webstorm

I think I'm doing it the way it's explained in jsdoc3 documentation. My WebStorm is version 8.0.4 /** * This callback type is called `dbOpenCallback` and is displayed as a global symbol. * * @callback dbOpenCallback * @param {object} err *…
user732456
  • 2,442
  • 2
  • 29
  • 47
1 2 3
…
18
19