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
17
votes
2 answers

jsdoc two dimensional array

I have an array of array of string and I can't figure out how to document that with JSDoc. /** @class */ function PostbackList() { /** @type {int} @default */ this.TypeID = 0; /** @type {PostbackList.Field[]} */ …
Serge Profafilecebook
  • 1,047
  • 1
  • 11
  • 32
16
votes
2 answers

JsDoc: How do I document that an object can have arbritrary (unknown) properties but with a particular type?

This is a similar to question 30360391. I want to express that the parameter of a function is a plain JS object that can have arbitrary properties (with unknown) names but all properties are objects themselves with fixed properties. An example: The…
user2690527
  • 1,211
  • 13
  • 31
15
votes
1 answer

Do primitive type names need to be uppercase or lowercase?

/** * @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 and Number because it is my understanding that I…
Gajus
  • 55,791
  • 58
  • 236
  • 384
15
votes
1 answer

Generate JavaScript documentation directly from source code

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 properties (like Doxygen does). This comparison between JSDoc…
Greg
  • 7,624
  • 4
  • 33
  • 50
13
votes
2 answers

Using JsDoc3 for large apps, How to group modules into sections/categories/submodules

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 up to 3 or 4 levels deep. Until now I understand…
Adrian Moisa
  • 2,937
  • 4
  • 34
  • 53
12
votes
4 answers

TypeScript strips down comments and spoils JSDoc documentation

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 targeted at JS users and shouldn't be flooded with the…
Estus Flask
  • 150,909
  • 47
  • 291
  • 441
11
votes
5 answers

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} bar - some property */ Is it possible to reference this type in another module, so that in the HTML…
phtrivier
  • 12,156
  • 4
  • 42
  • 73
11
votes
2 answers

How to create jsdoc types from json schemas

I have tons of json schema for node.js project. Can I use them in any way for: Accessing them as jsdoc types from ".js" code files to increase webstorm intellisense accuracy Or for creating jsdoc type definitions automatically ?
uzay95
  • 14,378
  • 28
  • 105
  • 167
11
votes
1 answer

The error message "There are no input files to process" from jsdoc

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-dev (Sun, 15 Jun 2014 18:39:52 GMT) …
TDreama
  • 400
  • 2
  • 8
10
votes
3 answers

JSDoc: reference @param of method in another @param

I am new to using JSDocs and couldn't find an answer to this question. Suppose I wanted to write this simple function: function hasQ(array, item) {return array.includes(item);} which with JSDoc's I would mark-up like: /** * Another way to call…
SumNeuron
  • 3,880
  • 1
  • 21
  • 74
10
votes
1 answer

How to run jsdoc on whole directory in ubuntu

I just need to run jsdoc on ai whole directory containing .js files, I am doing this on individual files in ubuntu terminal by issuing command jsdoc abc.js but what I need is to apply this command on all files in the directory at once,so that all…
SQA
  • 101
  • 1
  • 4
10
votes
3 answers

Can JS Doc generate PDF

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?
Sai
  • 1,691
  • 1
  • 16
  • 26
10
votes
3 answers

Is there a detailed documentation on how to create own jsdoc templates?

Short version: If I wanted to develop a completely new jsDoc template from scratch, what would I have to read to understand what jsDoc does, what interface my template must provide and what data I get to work with? Long version: I've been using…
codepearlex
  • 442
  • 3
  • 14
10
votes
2 answers

JSDoc UML Diagram

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 from the JSDoc tags. Edit I decided to try out…
theCrux
  • 101
  • 1
  • 6
9
votes
1 answer

create custom tags with jsdoc

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/" …
anjo
  • 275
  • 1
  • 7
  • 17
1
2
3
…
18 19