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/

294 questions
1
vote
2 answers

jsdoc: How do I get instance method parameters to appear?

I'm trying to document some old code with JSDoc3, and I'm stuck trying to get it to include in the documentation the parameters to instance methods - or to show anything as an instance property at all. I suspect the problem is that the code does…
ShadSterling
  • 1,792
  • 1
  • 21
  • 40
1
vote
1 answer

Why does this object literal not render to JSDoc?

I have the following JavaScript. It is a RequireJS module that has its functions namespaced into an object literal. I referred to: How do I JSDoc A Nested Object's Methods? to find out how to mark up the JSDoc notations. I run JSDocs 3.3.0-beta3…
Markus
  • 2,214
  • 3
  • 19
  • 32
1
vote
0 answers

How to specify Array like class in JSDocs

I have a class which is in some ways is like an array. First there is a generic part that can be accessed with dot notation like: myclass.customerlist myclass.clientlist myclass.some_dynamic_list_i_added_on_the_fly i.e. there are generic…
blackmamba
  • 757
  • 5
  • 21
1
vote
0 answers

Using JSDoc with AMD

I have the following AMD structure for my modules. /* globals define */ define([""], function() { 'use strict'; var module = {}; function _somePrivateFunc() {} function somePublicFunc() {} module.somePublicFunc =…
Attila Kling
  • 1,717
  • 4
  • 18
  • 32
1
vote
2 answers

How to document simple class within a self-invoking function?

How to document following code fragment? When I leave it as it is Foo.bar has no description. When I add @memberof tag it will be documented as static property. Adding @instance tag changes nothing. This is rather simple and common code pattern, so…
jesper
  • 879
  • 8
  • 21
1
vote
1 answer

How to document possible configuration properties in function argument in JSDOC?

How can I document possible configuration properties in function argument in JSDOC: /** * N level expectimax AI. * * @param {object} cfg config * cfg.minimaxDepth - limit for minimax search * cfg.expectiDepth - limit for expectimax…
gavenkoa
  • 45,285
  • 19
  • 251
  • 303
1
vote
1 answer

How to document an web component with jsdoc3

What would be the way to document a web component using jsdoc3 Here is an example of web component registered with x-tag. xtag.register('x-analytics', { lifecycle : { created : function(){ } }, accessors : { code…
krampstudio
  • 3,519
  • 2
  • 43
  • 63
1
vote
1 answer

Is there an Implements or Extends annotation in JSDoc?

I know there is an abstract annotation, so I was expecting an annotation for the inverse. Ie a sub-type method that implements (or extends) and abstract method. I can't seem to find any in the JSDoc reference.
Oliver Watkins
  • 12,575
  • 33
  • 119
  • 225
1
vote
1 answer

How to get JSDoc3 to document module functions

Given this file /* * comments */ "use strict"; /** @module stuffutils */ define(function() { /** * @callback GetStuffCallback * @param {String[]} array of stuff * Will be empty if no stuff. */ /** * Gets the stuff. …
gman
  • 100,619
  • 31
  • 269
  • 393
1
vote
1 answer

Documenting complex JavaScript Objects with custom Inheritance System

I'm currently trying to migrate an existing server-side JavaScript API from its existing manually copy-and paste Inheritance System to a better and more reliable system. The pure prototyping cannot be used because state (variables) of the objects…
Chris
  • 7,675
  • 8
  • 51
  • 101
1
vote
1 answer

jsdoc issue: Full path to source file is displayed (unwantedly)

I'm using jsdoc3 for my project and everything compiles nicely. But this I've been fiddling with for the last 2 days and I give up :( When using the most basic call from MacOsX Terminal to run jsdoc I ALWAYS get the full path of my source file…
Jan Paepke
  • 1,997
  • 15
  • 25
1
vote
1 answer

JavaScript class has setter that returns this. How do I document this in JsDoc?

Sample code: var myObject = (function() { var M; M = function() { } M.prototype = { constructor: M, setSomeProperty = function(someValue) { // Do Stuff return this; // For chaining purposes …
Levi Hackwith
  • 9,232
  • 18
  • 64
  • 115
1
vote
2 answers

Output examples with html

I am wanting to output examples which has HTML within it such as * @example *
*
*
But at the moment it renders it "safely" as HTML however I want it as text, at the…
Nick White
  • 1,602
  • 4
  • 20
  • 35
0
votes
0 answers

Using JSDoc with SuiteScript

I am using WebStorm to write SuiteScript code and the netsuite N/record module (I defined the module as record). I have a function I wrote that will return a record (below is a simplified form of it) /** * * @returns {record.Record} record.Record …
jvoigt
  • 400
  • 4
  • 23
0
votes
0 answers

Is there a way to see the JSDocs and Intellisense of a method from a class which is dynamically add by FeatureManager

So my goal is to create a class with which all other classes can be manipulated(added, removed, etc...) using my own FeatureManager class. Everything is working fine, but I am having trouble documenting the methods and properties of the custom…
Norman
  • 11
  • 1
1 2 3
…
19 20