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
0
votes
0 answers

Defining global objects using YUI Doc

How to define a global variable using YUI Doc. I can't find suitable comment tag to define a global object and its properties. What is the best way to do it. Below is my defined object: var glob = glob || { breakPoints: { mainNavigation:…
Ryxle
  • 880
  • 7
  • 21
0
votes
0 answers

yuidoc: how to document a plugin

I have a javascript class which has plugins. These plugins actually add/replace functions of this class. However, I don't see how I should document these plugins. For example, if I have a class and plugin as follows CLASS: /** Foo is a ..... …
Jeanluca Scaljeri
  • 26,343
  • 56
  • 205
  • 333
0
votes
2 answers

convert javascript comments into .chm files using yuidoc

I am using YUIDOC to convert Javascript comments to a chm file. I have installed node.js then,I have run the command yuidoc but when I am running the command yuidoc E:\foldername\filename.js then no error is coming but warning come that path argumen…
Navya
  • 657
  • 2
  • 10
  • 20
0
votes
1 answer

Generating JavaScript document using yuidoc with ANT script

I am trying to generate JavaScript documentation using yuidoc, below is my ANT script.
Simply Innovative
  • 191
  • 2
  • 16
1 2
3