Stack Overflow
Stack Overflow

Questions tagged [jsduck]

API documentation generator for Sencha JavaScript frameworks. It offers a nice UI and markdown support.

JSDuck is a documentation generator for JavaScript code. It offers a nice UI and markdown support. It is developed by Sencha.

25 questions
7
votes
1 answer

Is there a way to define generic types in JS documentation?

I'm looking for documentation generator for my JS library. I find JSDuck the most comprehensive and powerful one. But I don't see a way to define type variables for generic classes and functions using its syntax. Quick look at popular JS…
Egor Nepomnyaschih
  • 932
  • 1
  • 8
  • 13
3
votes
1 answer

Can jsduck be used to document code that doesn't use sencha frameworks?

I am exploring JavaScript documentation tools, and found JSDuck impressive. I noticed appcelerator titanium uses it as well. However, couldn't find much information on using it for documenting code that doesn't use Sencha's JavaScript Frameworks.…
user1959860
  • 33
  • 3
2
votes
0 answers

Comment Stub generator for JsDuck in visual studio

I want to generate comment stubs for js methods in visual studio. There is a comment stub generator called "JScript vsdoc Stub Generator" http://visualstudiogallery.msdn.microsoft.com/e122a031-d748-41e9-87b1-7b56d8610d8b but i want to use JsDuck…
kdaShivantha
  • 337
  • 5
  • 10
2
votes
0 answers

Intellisense for JSDuck

I have a JavaScript library which is well-annotated to produce documentation with JSDuck. I think that such annotations are sufficient to provide good IntelliSense for my library. Also, they are pretty standard, because JSDuck syntax is designed to…
Egor Nepomnyaschih
  • 932
  • 1
  • 8
  • 13
1
vote
2 answers

What is the best way to use jsduck to document event handlers?

What is the best sort of jsduck header to put over a method of a class (such as a ExtJS subclass) that handles an event? Jsduck seems to support the same tags as jsdoc, but I'm not sure if the @event tag is appropriate.
Mike Thomsen
  • 36,828
  • 10
  • 60
  • 83
1
vote
1 answer

Migrate from jsduck to jsdoc

I want to migrate lots of JavaScript code which documented with jsduck before. and now I want to migrate them all to jsdoc. It would be great if you help me please. Because I can not find any source for that. So, actually I would also prefer to…
Eva
  • 11
  • 3
1
vote
2 answers

windows ruby install jsduck error

I am trying to install jsduck on ruby gem, however I got error. I've downloaded Ruby 2.3.0(x64). I've also downloaded DevKit-mingw64-64-4.7.2-20130224-1432-sfx.exe which is for x64. I installed the ruby 2.3.0(x64). Then I extracted devkit to…
SchemeSonic
  • 376
  • 5
  • 12
1
vote
1 answer

How to document the classes within overrides folder with jsduck

With the following architecture, how to document the classes within overrides folder with jsduck. MyApp -app -overrides -plugins -resources -... It seems only possible to document the classes within the app folder. In my jsduck documentation…
jose
  • 1,490
  • 3
  • 30
  • 65
1
vote
1 answer

Why JsDuck ignores excluded directory?

I use JsDusk Version : JSDuck 5.3.4 (Ruby 1.8.7) OS: Linux ( CentOS 6 ) I want to exclude some directories, but it doesn't work. --exclude="/Doc/Project1/application/,/Doc/Project1/docs/,/Doc/Project1/docUtil/" Actually it should works. Here…
michael-mammut
  • 2,595
  • 5
  • 28
  • 46
1
vote
1 answer

List ExtJS 4 custom namespace in JSDuck documentation

ExxtJS 4 JSDuck 6 I have an ExtJS workspace (MyWS) with a number of ExtJS apps (i.e. MyApp). There is an overrides folder in the workspace (MyWS.overrides). The 'Ext', 'MyApp' and 'MyWS' namespaces are listed in the left panel of the JSDuck html…
dak
  • 339
  • 6
  • 21
1
vote
1 answer

JSDuck Guides: How to Generate Subsection Navigation?

I am using the Guides feature of JSDuck where I specify README.md files in the guides.json file. The problem I have is that I can't specify an anchor in a README.md file in guides.json. For example, my README.md file has an H1 Head, then 5 H2…
Derwood Kirkwood
  • 496
  • 5
  • 8
1
vote
1 answer

How to document (jsduck/jsdoc) cucumber.js step definitions?

Is there any way to document steps in cucumber.js step definition code? I've tried to do emulate it with jsduck @class: /** * @class Global.steps.common * Common steps. */ var steps = module.exports = function() { /** * Step 1…
Artem Repko
  • 33
  • 5
1
vote
1 answer

Documenting the same jsduck config type across multiple methods

Two questions: First, does anyone know how to inherit part of some documentation? Specifically for an "options" object: * @param {Object} opts * @param {String} opts.effect Transition effect. fade|slide * @param {String} …
user578895
1
vote
1 answer

How do I stop JSDuck generated documentation class names from overlapping

I am using JSDuck to document the JS classes in my extjs mvc project however on the main page of the API documentation all the names of the classes that are documented overlap each other as the class names are quite long. Whilst I realise that…
James Nurse
  • 396
  • 4
  • 19
1
vote
1 answer

Parsing phpdoc to JSON

I would like to find a way to use phpdoc2 to parse PHP projects into JSON rather than into Abstract Syntax Tree XML. Although of course I could just parse the XML into JSON, it seems that creating XML would be unnecessary overhead here. So, in a nut…
Greendrake
  • 3,657
  • 2
  • 18
  • 24
1
2