jsdoc

Assuming you have the following code inside a ES6 class (documentation): /** * @typedef Test~options * @type {object.<string>} * @property {array} elements - An array containing elements * @property {number} length - The array length */ /** * @param {Test~options} opt - Option object */ test(opt){ } Now I would like to document another function, let's name it test2 . This function takes exactly the same options object, but needs another property parent . How to document this without documenting redundant options? Redundant means: /** * @typedef Test~options * @type {object.<string>} *

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 js/uml and found the following. The JS/UML eclipse extension requires an older version of Eclipse (Indigo) and a non-supported dependency library UML2tools. I found the dependencies needed and according to the Eclipse software manager installed correctly. When I tried to enable the uml functionality (having configured the js root), the process would hang.

When I write the following code, the annotator tells me that BrowserSelector is not defined in the second typedef: /** * @typedef {{name: String, minVer: Number, maxVer: Number}} BrowserSelector */ /** * @typedef {{type:String, browser: BrowserSelector, attribute: Object}} Selector */ I believe it is not associating the type with the name. How can I do that? I would prefer not to add actual code for it, just jsdoc comments. iolo I'm using this comment style for 'struct' like types: /** * @name BrowserSelector * @property {String} name * @property {Number} minVer * @property {Number} maxVer */

I'm currently refactoring some Javascript code we have and amongst other things I've changed it to make use of the revealing module pattern. The code is looking much tidier and it works fine but I can't see the functions anymore in the outline view. I see the top level namespace var as a var but you can't expand it to see the functions within. Lets say the code used to look like this: function myFunc1() {} function myFunc2() {} In this case you see both functions in the outline view. But if you change it to this: var myNamespace = function() { function myFunc1() {} function myFunc2() {} return

How can I get my application to be 100% typed in regard to google closure compiler? I already tagged everything with jsdoc comments. Is it even possible to get 100? I'm at 64,6% kayahr It IS possible to achieve 100%. My own projects are 100% typed. The closure compiler can output warnings about expressions with unknown types. Unfortunately there is no command line option to enable this feature. You have to modify the source code to enable it: Download the current sources: git clone https://code.google.com/p/closure-compiler/ Edit src/com/google/javascript/jscomp/CompilerOptions.java and change

I've spent quite a while scouring the internet looking for the best way to properly document callbacks with jsdoc, but unfortunately, I haven't found a great one yet. Here's my question: I'm writing a Node.js library for developers. This library provides multiple classes, functions, and methods that developers will be working with. In order to make my code clear and understandable, as well as to (hopefully) auto-generate some API documentation in the future, I've started using jsdoc in my code to self-document what's happening. Let's say I define a function like the following: function

Having next example: var CONF = { locale: { "en": { name: "English", lang: "en-US" }, "es": { name: "Spanish", lang: "es-ES" } } }; And knowing that what the locale property contains is a dictionary object, which comes from the database, how can I document its inner properties with JSDoc? Currently I am thinking to typedef type for my locale objects, then may I be able to set the locale property to simply an Array of my defined type? Is this the right way to do it? Áxel Costas Pena According to the JSDoc 3 docs : Arrays and objects (type applications and record types) An object with string

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() { /* * @exports mystuff/foo */ var foo = { /** * @member */ bar: { /** * @method */ baz: function() { /*...*/ } } }; return foo; } The problem is, I can't get baz to show up in the generated documentation. Instead I just get a documentation file for a foo/foo module, which lists a bar member, but bar has no baz (just a link to foo 's source code). I've tried changing bar 's directive to @property instead,