I'm specifically referring to JavaScript anonymous function but this could be relevant to other languages. I like to use JSDoc notations in my scripts because I know other people will be hacking at it sooner or later. When i have pretty complex anonymous function how do people document it so that it gets picked up by Eclipse and other ID...
hi is there a tool that i can use to generated msdn type documentation? i recently just started playing with sandcastle and i found that there used to a tool called scriptdoc but it has been absorbed into aptana and i don't really want to use aptana studio. what i could find so far is jsdoc which is a perl script which extracts comment...
I have the following Moo class: Nem.Ui.Window = new Class({ Implements: [Options, Events], options: { caption: "Ventana", icon: $empty, centered: true, id: $empty, width: $empty, height: $empty, modal: false, desktop: $empty, ...
Do you know if there is a some sort of <code> tag in JSDoc? I need to add pieces of code in my documentation like this: /** * This function does something see example below: * * var x = foo("test"); //it will show "test" message * * @param {string} str: string argumnet that will be shown in message */ function foo(str) { alert(str); ...
Do you know if it's possible to write something after the @param and @return blocks. Let's say I want to write a piece of text after the parameters/return declarations, something that is separated from them. It seems Javadoc and Jsdoc both attach whatever you write after an @param/@return in the same block of conetnts. Let's say for in...
Edit: This is technically a 2 part question. I've chosen the best answer that covers the question in general and linked to the answer that handles the specific question. What is the best way to document anonymous objects and functions with jsdoc? /** * @class {Page} Page Class specification */ var Page = function() { /** * ...
Hi, I am using PHPDoc and JSDoc for my source code. I know that there are tools to build an API out of those docs. However, what I am wondering is that how is one supposed to explain complex code? Do I just use multiline comments inside functions rather than explaining in the PHPDoc/JSDoc? For example, consider this code: /** * Lorem...
Hi, How do I doc a variable number of parameters? I am writing an application in PHP and JavaScript. Currently I have (in JavaScript): /** * Description * @param {String} description */ function fn() { // arguments holds all strings. } So, how do I doc n-number of string params? ...
I am documenting a library that has a Python component and a JavaScript component. The overall user documentation, and the Python API documentation are in reStructuredText, processed with Sphinx. The JavaScript API is in jsdoc and is processed with jsdoc-toolkit. The principal output format will be HTML. I am new to reST, Sphinx and js...
Hey, I've searched and have found partial answers but none that seem to working - at least as I expect - in my situation. So I am trying to comment http://pastebin.com/eRF0VjmR and running into issues when I try to comment objects. The ones in question are "subscribers", "options", and "fn". As you can see for "fn" (line 756) I am u...
Does anyone know a tool to convert JsDoc to PDF ? Or you have to do that trough convert HTML files into PDF ? Thanks for answer ! ...
I have a JavaScript singleton object created with closure method: /** * This is the singleton. * * @namespace window.Something.Singleton */ window.Something.Singleton = (function() { /** * Foo method. * * @return {String} this method always returns with <code>bar</code> */ function _foo() { return "bar"; } /** ...
Or do they and it's just not in the source? I'd really to get something that will stop js-doc-toolkit from freaking out each time it parses jQuery. It also means I can't properly document any code using jQuery as a dependency without at least putting some boilerplate js-doc blocks, which fail to properly document jQuery's structure. Is t...