Stack Overflow
Stack Overflow

Questions tagged [yuidoc]

YUIDoc is a Node.js application that generates API documentation from comments in source, using a syntax similar to tools like Javadoc and Doxygen.

YUIDoc is a Node.js application that generates API documentation from comments in source, using a syntax similar to tools like Javadoc and Doxygen. YUIDoc provides:

  • Live previews. YUIDoc includes a standalone doc server, making it trivial to preview your docs as you write.
  • Modern markup. YUIDoc's generated documentation is an attractive, functional web application with real URLs and graceful fallbacks for spiders and other agents that can't run JavaScript.
  • Wide language support. YUIDoc was originally designed for the YUI project, but it is not tied to any particular library or programming language. You can use it with any language that supports /* */ comment blocks.
34 questions
17
votes
1 answer

Run npm commands using Python subprocess

I'm trying to automate the generation of documentation using YUIDOC, but I have a server side framework that heavily uses python, so I'm trying to automate everything from within a python script. I'm able to get the node command to run fine, but…
Evan Siroky
  • 9,040
  • 6
  • 54
  • 73
13
votes
2 answers

How to document an Ember App?

I'm using YUIdoc. Anything else ? Well could anyone tell me how to properly document a model, a controller, a mixin and a view in Ember ? For example I'm trying to document this: App.newModel = DS.Model.extend({ someProperty:…
Bartheleway
  • 528
  • 5
  • 19
8
votes
2 answers

How to document an "object" parameter of a method

I'm trying to write some documentation for a JavaScript method using YUIDoc. It looks like: /** Returns an instance of className @method getInstance @param {string} className the of the class used to create the instance @param…
Jeanluca Scaljeri
  • 26,343
  • 56
  • 205
  • 333
6
votes
1 answer

How to add add external links in yuidoc (grunt-contrib-yuidoc)

I imagine I'm missing something in yuidoc documentation or misunderstanding usage. I cannot seem to find a way to include a link to an external site/page in my documentation. In a comment block, I'd like to have something like this: /** * Creates…
user56512
6
votes
1 answer

How to define a custom main page on a YUIDoc-generated documentation

I've been playing with YUIDoc and I find it fantastic. By the way, I don't find a way to define my own main page content for the auto-generated documentation site (custom content inside the auto-generated index.html). How can I define the main page…
Matías Fidemraizer
  • 63,804
  • 18
  • 124
  • 206
4
votes
0 answers

How can I document a property defined with Object.defineProperties() in WebStorm (JSDoc)

Let's say I define a property with Object.defineProperties(). If I try to specify the type of this property with a JSDoc comment, WebStorm gives me a warning. Here is an example: Object.defineProperties(obj, { /** * @type {String} */ …
djip.co
  • 997
  • 10
  • 17
3
votes
1 answer

YuiDocs external data link usage

I have an ember-cli project that needs documentation, I am using the ember-cli-yuidoc plugin and this is my yuidoc.json file: { "name": "myapp", "description": "Small description for myapp goes here", "version": "0.1.0", "options": { …
Patsy Issa
  • 11,113
  • 4
  • 55
  • 74
3
votes
1 answer

How can I build YUIDoc with offline resources?

When you build & run YUIDoc it gets some of his resources from http://yui.yahooapis.com/.... These resources include the stylesheet and yui.min.js. How can I download and use these resources offline? The reason for this is because we run our docs on…
A1rPun
  • 16,287
  • 7
  • 57
  • 90
3
votes
0 answers

how to add custom tags in yuidoc

I need to add some custom plugins like @date and @author in a javascript project that I am working on. WE are using yuidoc for the documentation purpose. But there are two cases here 1> @data tag is not there in yuidoc 2> @author tag is there but…
Nav
  • 10,304
  • 20
  • 56
  • 83
3
votes
1 answer

Yuidoc : specify the nature of the param

I'm trying to document my node.js modules with yuidoc (http://yui.github.io/yuidoc/) and i'm wondering how to create a link from a param to its implementation. Let's say I have the following src/core/Repo.js /** * Repo * @class Repo * @module…
xavier.seignard
  • 11,254
  • 13
  • 51
  • 75
2
votes
0 answers

yuidoc - reuse complex @param {Object}

I have a Foo object that gets passed around. /** * Do something cool * * @method baz * @param {Object} foo * @param {String} foo.name * @param {Number} foo.x * @param {Number} foo.y * @param {Number} foo.z …
Ilia Choly
  • 18,070
  • 14
  • 92
  • 160
1
vote
2 answers

EmberJS documentation using YUIDoc, Comment Style?

Here I have an emberJS controller as an example. How to comment it properly to generate documentation using YUIDoc? import Ember from 'ember'; /** * ? */ export default Ember.Controller.extend({ queryParams: ['param1', 'param2'], /** * ? …
Entwickler
  • 255
  • 2
  • 12
1
vote
2 answers

How to document multiple errors with @throws in YUIdoc / jsdoc?

According to the documentation of YUIdoc (which seems to be in this case equivalent to jsdoc) there is a @throws tag to document a potentially thrown error. Specifies an error which method throws. A @throws tag has the structure @throws {type}…
Michael Hoeller
  • 22,018
  • 10
  • 39
  • 66
1
vote
1 answer

YUIDOC - Document params of returned callback

How can I properly document a returned callback that returns multiple parameters. Exe: return callback(error, success);
JDillon522
  • 19,046
  • 15
  • 47
  • 81
1
vote
3 answers

Should read-only Ember computed properties be marked as @property or @method in YUIdoc?

How should read-only computed properties (say, of Ember.js Models) be documented as, in YUIdoc? Say I have a simple model: /** * Person model * @class Person * @extends Ember.Object * @constructor */ Person = Ember.Object.extend({ /** *…
Dmitri Zagidulin
  • 1,117
  • 9
  • 23
1
2 3