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.
Questions tagged [jsduck]
25 questions
1
vote
1 answer
JSDuck - Created document that doesn't show any parameters of function
Example:
There are several .js files with couple functions like:
/**
* TestFunction - doing something.
* @param {String} strTest Test string.
* @return {Boolean} bRes Returned value.
*/
function TestFunction(strTest) {
//code ...
return…
Roman Vorobets
- 87
- 4
1
vote
2 answers
User comments on documentation with JSDuck?
JSDuck offers user feedback in the generated documentation. Sencha uses this on their code doumentation. It is described in a blog post.
I would like to use that commenting feature for our development team too.
Who knows how to do that?
holgerm
- 839
- 1
- 7
- 11
0
votes
1 answer
use jsduck failed to generate doc,The code framework uses Extjs
The command line prompt error when using jsduck docs today:
enter image description here
Can't I use keywords like parse? But I need these in my code.
JasonSoftWare
- 3
- 5
0
votes
1 answer
JSDuck: Specify an array of a certain length
Using JSDuck for the documentation of my ExtJS application, I try to add a configuration that has to be String[8]:
/**
* @cfg {String[8]} FooColors The eight colors to use for foo. All CSS color formats (Hex, RGB, RGBA, color names...) are valid.
…
Alexander
- 19,906
- 19
- 75
- 162
0
votes
1 answer
jsduck 5.3 create PHP-Doc
Today i tried out the jsDuck 5.3 with my ExtJS project. It works really good. But I've also commented every method and class in PHP.
I've seen that JSDuck 3.11.2 can create a perfekt online documentation from PHP Files, but JSDuck 5.3 doesn't do. Is…
michael-mammut
- 2,595
- 5
- 28
- 46
0
votes
2 answers
typescript documentation generator
i am starting documenting my java-script + typescript website with jsDuck
I've documented my class very well , but my problem is interfaces - they don't compile from the ts file over to the java-script.
here is my output, as u can see the page…
Allen Bustenai
- 83
- 8
0
votes
1 answer
jsDuck javascript/jQuery recommended way to document $.trigger
What is the best way to document in jsDuck:
$(document).trigger('myCustomEvent');
Joel Box
- 429
- 1
- 6
- 12
0
votes
0 answers
Installation's issue with Jsduck gem
I'm trying to install on my Mac JSduck
OSX Mavericks 10.9.2
Xcode command line tools present
But finding the following errors
MacBook-Pro-di-monili:~ monilinicolo$ sudo gem install jsduck
Password:
Building native extensions. This could take a…
WhiteLine
- 1,919
- 2
- 25
- 53
0
votes
1 answer
JSDuck generated output will not load
I'm running JSDuck v5.3.4 on Solaris, with a single, very simple input file:
/**
* @class Designer
*/
And I run it like this:
~/.gem/ruby/1.9.1/bin/jsduck --out ~/public_html/duck foo.js
When I try to browse to the generated content, I see the…
Armentage
- 12,065
- 8
- 33
- 33
0
votes
1 answer
Printing JSDuck Documentation
I've generated documentation with JsDuck. One thing I noticed was that there was no print button for the guides though I saw it in the online docs?
How do I enable it in the config file when building the doc?
If not available, how should I format…
ritcoder
- 3,274
- 10
- 42
- 62