Where communities thrive


  • Join over 1.5M+ people
  • Join over 100K+ communities
  • Free without limits
  • Create your own community
People
Repo info
Activity
Alexej Yaroshevich
@zxqfox
Mm, no, because CommonND not belongs to google/Area module
@extends google/CommonND:CommonND or something like
depends on your needs
mzummo
@mzummo
and what should the name be in COmmonND.js?
@class google/CommonND:CommonND?
Alexej Yaroshevich
@zxqfox
    /**
     * @module google/CommonND
     */

    /**
     * @class CommonND
     * @extends google/Common:Common
     */
If I understand you right ;-)
mzummo
@mzummo
common is part of "google" too btw
google/Common
widget.js is outside of the google dir
in common/Widget.js
Alexej Yaroshevich
@zxqfox
y
mzummo
@mzummo
just is thats the way the lib was designed there is a common file to all google charts commonND to ND based data type charts
so there is really a Common1D Common2D and CommonND
google/Gauage.js -> Common1D -> Common -> Widget
Alexej Yaroshevich
@zxqfox
Ye, I think I see it now, but does it work?
Is there somethink breaking?
mzummo
@mzummo
still cant get all the inherited functions to show up under the "module"
still need someway of saying hey if you create a google/Area() object you have access to this and all of these methods from its parent class
think i need "@mixin"
Alexej Yaroshevich
@zxqfox
Ye, probably
If you want to show all inherited methods in the final class I think you should tune generator itself.
mzummo
@mzummo
what do you mean tune generator itself
Alexej Yaroshevich
@zxqfox
Or use some special directives (like @mixin)
mzummo
@mzummo
?
Alexej Yaroshevich
@zxqfox
Probably there is a way in jsdoc3 to show all inherited methods in the final classes
Actually, I've never used jsdoc3 bin, better to address this question right to them
mzummo
@mzummo
im not sure where to ask them
Alexej Yaroshevich
@zxqfox
;-) That's a question to me.
I see 2 legit ways:
mzummo
@mzummo
@zxqfox .. or anyone that might be able to help .. btw zxqfox i was able to get what i was looking to do .... i just need to get the interface mathods to show through
i can get parent class methods to show by using @instance on the method block
but its not working for interfaces
Mufaddal B
@invinciblemuffi
How can I link 2 files using jsdoc3 annotations. Which annotation to use in which file.
Michael Malura
@maluramichael
Is it possible to group multiple classes? I have many classes where each class represents a route. So.. i want to put them in a group Routes.
Christian Giacomi
@cgiacomi
Hi does jscs-jsdoc support documentation for callbacks? I tried using @callback as described by the JSDoc documentation but I get the following error
jsDoc: Unavailable tag callback
Benny Powers
@bennypowers

How would I describe objects which inherit and modify types? like

/**
 * Redux action
 * @typedef {Object} ReduxAction
 * @property {Promise<Object)} payload
 * @property {string} type
 * @property {object} meta
 */

/**
 * DELETE_VIDEO action
 * @typedef {ReduxAction} DeleteVideoAction
 * @property {'DELETE_VIDEO'} type DELETE_VIDEO action type
 * @property {{id: string}} meta
 */

where DeleteVideoAction's type value would override the inherited type value

Jim Sagevid
@jims
Does jsdoc provide any way of describing fixed size arrays. for example a point represented as [x, y]?
canvasplay
@canvasplay
Hi all! anyone active now for a quick question?
Maximilian Berkmann
@Berkmann18

Hello guys,
Is there a way to ensure that JSDoc sees and document some source files?
I've been looking around and twicking my config file but it seems to only document the package.json (while making sure the syntax is correct according to the usejsdoc.org website) but I feel like something has changed (as it used to work in the past).

Here's my configuration file:

{
  "tags": {
    "allowUnknownTags": false
  },
  "source": {
    "includePattern": ".+\\.js(doc|x)?$",
    "excludePattern": "(^|\\/|\\\\)_|.+\\.min.js",
    "exclude": [ "(.*)node_modules" ],
    "include": [ "src" ]
  },
  "plugins": ["plugins/summarize"],
  "templates": {
    "cleverLinks": false,
    "monospaceLinks": false,
    "default": {
      "outputSourceFiles": true
    }
  },
  "opts": {
    "destination": "./doc/",
    "recurse": true,
    "package": "./package.json",
    "access": "public",
    "readme": "./README.md"
  }
}

src is the folder that contains my NodeJS JS files being ignored.

Maximilian Berkmann
@Berkmann18
Is there someone here that can help?
Oleg Gaidarenko
@markelog
You probably should consider switching from jscs
Maximilian Berkmann
@Berkmann18
@markelog You mean switching to JSCS?
Sri Harsha
@harsha509
Hi all, can anyone please clarify me the below jsdoc clousure meaning diff between {string?} and {?string}
thanks in advance!
Ghost
@ghost~57cbaf6040f3a6eec0634f49
Hi, How can I document the below code using JSDoc?
exports.deleteAccount = function(req, res) {
   //Here is the code for delete account
}
Ahmetcan Aksu
@ahmtcn123
/**
 * @callback deleteCallback
 * @param {object} req requestblabla
 * @param {object} res responseBlbla
 */

/**
 *  Request all dots in assistant mind
 *  @param {deleteCallback} callback
 *  @returns {void}
*/
exports.deleteAccount = function(req, res) {
   //Here is the code for delete account
}
Maybe you can try this