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
1
vote
1 answer

Is yuidoc @namespace relevant with Ember-CLI?

@namespace The @namespace should not include the "root" or "global" object that your entire library hangs off of. Since we have @module which give the js files container. can some one give me a simplest example possible? or direct me to some…
PCB
  • 638
  • 1
  • 11
  • 22
1
vote
2 answers

YUIDocs parse Polymer element

I am attempting to document a series of Polymer web components. I have used Polymer/core-docs-viewer in the past but find it is not as complete and extendable as YUIDocs or others like JSDocs. YUIDocs seems a better choice for documenting larger…
andrsnn
  • 1,591
  • 5
  • 25
  • 43
1
vote
0 answers

Is there a good resource for creating Node.js documentation with YUIdoc?

I'm having a hard time understanding how I should document my Node API using YUIdoc. I have so many "seemingly simple" questions. How do I differentiate "Routes" from "Models"? At the moment I'm using "route.foo" and "model.foo" but that doesn't…
Brandon Merritt
  • 31
  • 5
1
vote
1 answer

Documenting Ember apps with @constructor and @static

Documentation tools like YUIDocs allow you to identify and describe Classes (object classes) using the @class tag in comment blocks. Each identified Class requires a @static or @constructor tag, defined as follows: @constructor - Indicates that the…
Duncan Walker
  • 2,182
  • 19
  • 28
1
vote
2 answers

yuidoc parses but no output and no errors

I've spent the last 4 days trying to get yuidoc to parse my javascript framework and it's really starting to drive me nuts. here is my json config file { linkNatives: 'true', attributesEmit: 'true', paths: [ '..\\\\layers' ], outdir:…
NlaakALD
  • 377
  • 2
  • 6
  • 16
1
vote
1 answer

Ignoring tags in yuidoc javascript documentor

Is it possible to ignore various tags in yuidoc to make documentation build process messages more useful. I've a problem with tags like @author, @date etc /** * The XYZ View ... * These tags yuidoc result in a yuidoc warning * * @company…
Bernhard
  • 4,855
  • 5
  • 39
  • 70
1
vote
2 answers

ANT Script not working

I have a ANT script which runs yuidoc through command line, but when i run this script it gives me below error: [exec] 'yuidoc' is not recognized as an internal or external command, [exec] operable program or batch file. and the same command ->…
Simply Innovative
  • 191
  • 2
  • 16
1
vote
0 answers

How to document overloaded methods in YuiDoc?

Lets say I have a method on a class, foo, with a method, bar, that accepts all optional parameters, but if the parameters and order are changed, the method's return value changes significantly. var foo = { bar: function (param1, param2) { …
Kelly Milligan
  • 578
  • 1
  • 4
  • 17
1
vote
1 answer

Yuidoc-style comments in Ruby?

How can I use YUIDoc comments in Ruby? The best I can come up with is this: ##* # Get Query history # @type {Array} Past search query objects # @param {int} limit The number of objects to return. Defaults to 10. (Max 100). # @param…
Alexandros K
  • 947
  • 1
  • 6
  • 19
1
vote
2 answers

How can I add IgnorePath for yuidoc

While generating document form yuidoc I want to ignore downloaded javascript libraries inside lib folder of my project. How can I place that into ignore list I tried "ignorePaths": [ "./lib" ], "ignorePaths": [ "./lib/*.js" ], …
Suraz
  • 1,119
  • 7
  • 10
1
vote
1 answer

yuidoc - how to define a class method in an other file

I'm writing documentation with yuidoc. However, I have a class Model, which has one of its methods defined elsewhere. Here is some code to visualize the situation. Assume I have a file model.js: /** * @class Model * @constructor */ window.Model…
Jeanluca Scaljeri
  • 26,343
  • 56
  • 205
  • 333
1
vote
2 answers

How to tell that my method accepts an array of {id: String, label: String} in yuidoc?

I Cant' find it in the doc. What I would prefer is having the type showing [{id: String, label: String}] in the generated doc, and experimentation lead me to think that the only thing I can do is specify a single alphanumeric-only String without any…
Samuel Rossille
  • 18,940
  • 18
  • 62
  • 90
0
votes
1 answer

How to replace YUIDoc's index partial with the classes partial?

I'm trying to build docs from source on one of my plugins. Everything works fine now but the index page is empty and useless. I want to replace the index partial with the content of the classes partial since that's the only useful info for this…
robdel12
  • 229
  • 2
  • 8
0
votes
1 answer

How to document a vector param with YUIDoc?

Any idea how to document a method parameter with YUIDoc, where the param is a vector, being a three-element array of numbers? This is what I'm doing so far, describing the param as simply "Array(Number)": /** * Sets the color, which is a…
xeolabs
  • 1,369
  • 1
  • 9
  • 16
0
votes
1 answer

How to document a namespace using yuidoc?

YUIDoc doesn't seem to be generating any documentation for my namespace. This project uses the Revealing Module design pattern /* * Example namespace. * * @namespace MY_NAMESPACE */ var MY_NAMESPACE = (function() { /** * @property…
tarabyte
  • 17,837
  • 15
  • 76
  • 117
1
2
3