This is probably a simple question

Taking an AMD approach, how do you properly document a stand-alone function? I've been looking at the docs and examples, but I wasn't able to find anything related…

Example to help clarify my problem:

/**
 * bind
 *
 * @version 0.0.1
 * @module function
 */
define(function () {

    /**
     * binds a function to a given object (context)
     *
     * @function
     * @param {Function} fn Function to be bound
     * @param {Object} context Object that will serve as context
     * @return {Function} bound function
     */
    return function (fn, context) { /* code */ }

});

This is an AMD module that returns a simple bind function, but because it's not a class and it's not exactly a constructor, i totally fail to make that function's documentation appear in the generated docs, at least correctly.

When on the index tab of a class, you click on a method or property listed on that index, all you can see is a blank page. The url changes has #method_name appended, and if you click enter on the url bar it works, so the problem must be a javascript error.

If you try it without debugging there are no javascript errors, but debugging step by step there are javascript errors.

I get to a point on apidocs.js line 205, in pjax.updateTabState function, which has an inner function called scrollToNode, which has a setTimeOut calling an anonymous function, there's the following error:

Uncaught TypeError: Cannot read property 'responseText' of null

It happens twice, and it points to combo:56

Uncaught TypeError: Cannot read property 'responseText' of null combo:56 n._onPjaxIOComplete combo:56 e.Subscriber._notify combo:14 e.Subscriber.notify combo:14 e.CustomEvent._notify combo:14 e.CustomEvent._procSubs combo:14 e.CustomEvent.fireSimple combo:14 e.CustomEvent.fire combo:14 E.fire combo:14 o._evt combo:49 o.complete combo:49 o._rS combo:49

If I click to the link combo:56 it takes me to this piece of code

/* YUI 3.7.0 (build 5625) Copyright 2012 Yahoo! Inc. All rights reserved. Licensed under the BSD License. http://yuilibrary.com/license/ _/ YUI.add("pjax-content",function(e,t){function n(){}n.prototype={getContent:function(t){var n={},r=this.get("contentSelector"),i=e.Node.create(t||""),s=this.get("titleSelector"),o;return r?n.node=i.all(r).toFrag():n.node=i,s&&(o=i.one(s),o&&(n.title=o.get("text"))),n},loadContent:function(t,n,r){var i=t.url;this._request&&this.request.abort(),this.get("addPjaxParam")&&(i=i.replace(/([^#])(#.*)?$/,function(e,t,n){return t+=(t.indexOf("?")>-1?"&":"?")+"pjax=1",t+(n||"")})),this._request=e.io(i,{arguments:{route:{req:t,res:n,next:r},url:i},context:this,headers:{"X-PJAX":"true"},timeout:this.get("timeout"),on:{complete:this._onPjaxIOComplete,end:this._onPjaxIOEnd}})},_onPjaxIOComplete:function(e,t,n){var r=this.getContent(t.responseText),i=n.route,s=i.req,o=i.res;s.ioURL=n.url,o.content=r,o.ioResponse=t,i.next()},_onPjaxIOEnd:function(){this._request=null}},n.ATTRS={addPjaxParam:{value:!0},contentSelector:{value:null},titleSelector:{value:"title"},timeout:{value:3e4}},e.PjaxContent=n},"3.7.0",{requires:["io-base","node-base","router"]});

I think this might be related to issue 88

https://github.com/yui/yuidoc/issues/88

Hi,

The logo wasn't working for me, after this fix it is.

I also tried to create a test to actually verify what is going on but I wasn't able to really.

If someone can provide more info on how and why then that would be interesting.

Hi Guys, after reading that yahoo terminated YUI, is there a chance that yuidoc will be maintained in the future, if not please post some announcements (according support & new features) on the title page.

Paths may be ignored because they contain a large number of files. The getDirs method should not actually descend into those ignored directories. Specifically in Ember.js our tmp/ and node_modules/ directories may both be extremely large and have complex symlinking that trolls the validatePaths method.

Additionally this commit flattens the recursion in getDirs.

I have 2 modules in separate directories and 3 classes. One class ends up being associated with the module from the other directory. Note that if I change the name of the file that defines the module from z.js to a.js, it works.

The layout is:

.
./c
./c/t.js
./u
./u/m.js
./u/z.js

t.js is:

/** 
 * @module C
 */
/**
 * @class T
 * @static
*/

m.js is:

/**
 * @class M
 * @static
 */

z.js is:

/**
 * @module U
 */
/**
 * @class L
 * @static
 */

I would expect class M to be in the U module but it ends up in the C module.

As path.join produces backslashes on windows need an alternative to not have broken links when built on my machine.

I cannot run your tests for some reason so cannot guarantee this hasn't broken everything. I would also want to check there is nowhere else that this issue is also occurring. Not sure if the https is correct!

I thought would submit a pull request to highlight where the issue is occurring for me and to allow you to take a look.

Implements #354. A utility script is provided to update the native links, which can then be committed to the repo. In the future, this could be improved to update the links at compile time so that they are always fresh.

Hello everyone,

I've installed yuidoc with "npm -g install yuidocjs" and have no error, but when I try to use it, it do nothing :

site@ubuntu:~/casperjs-sqlite3$ yuidoc .
site@ubuntu:~/casperjs-sqlite3$ yuidoc -h
site@ubuntu:~/casperjs-sqlite3$ 

I search but found nothing about it, any ideas ?

Thanks.

Thomas

Hi!

Rest parameter syntax is coming in EcmaScript 6 (already in Firefox Nightly!). It looks like this:

function foo(param1, ...args) {
  // args is an array
}

I think it makes sense to use this syntax instead of YUIDoc's * for multiple parameters. It's easier to remember (I sometimes confuse it with Type[]) and maybe some day we'll be using it in real code. This pull request updates the docs to use ...params, and adds the option for @param {Type} ...params and @param {Type} [...params].

I added tests for this feature but I can't seem to run them from the command line. Is there anything else I should do besides running node tests\parser.js?

Hi,

Here is a fix for https://github.com/yui/yuidoc/issues/212.

As I wrote in the comments there, it is possible to set a preprocessor directive in the options. The preprocessor is a node module which will be called to allow modifications of the data before rendering. The module is searched for relative to the current working directory.

Example yuidoc.json:

{
    "options": {
        "preprocessor": "internal_doc_preprocessor.js"
    }
}

Then, the file internal_doc_preprocessor.js would look like the following. In this case it is a preprocessor which removes all classes and class items which has the @internal tag:

module.exports=function(data) {
    var keepClasses={};

    for (var c in data.classes) {
        if (!data.classes[c].hasOwnProperty("internal"))
            keepClasses[c]=data.classes[c];
    }

    data.classes=keepClasses;

    var keepItems=[];

    for (var i in data.classitems) {
        if (!data.classitems[i].hasOwnProperty("internal"))
            keepItems.push(data.classitems[i])
    }

    data.classitems=keepItems;
}

I also added a test suite which tests the functionality, with respect to single or multiple processors being used, correct path resolution in case the preprocessor use absolute or relative path, etc.

Please take a look!

Homebrew on Ventura on Apple M1 silicon installs node modules in

/opt/homebrew/lib/node_modules/

instead of in

/usr/local/lib/node_modules/

Yuidoc is just not finding things correctly. I can't tell if its a homebrew problem, an npm problem, or a yuidoc problem. But the path to the theme is obviously incorrect in the error message:

 [exec] error: Error: Cannot find module '/Users/(my project path)/opt/homebrew/lib/node_modules/yuidoc-lucid-theme/helpers/helpers.js'
 [exec] Require stack:
 [exec] - /opt/homebrew/lib/node_modules/yuidocjs/lib/builder.js
 [exec] - /opt/homebrew/lib/node_modules/yuidocjs/node_modules/yui/yui-nodejs/yui-nodejs.js
 [exec] - /opt/homebrew/lib/node_modules/yuidocjs/node_modules/yui/index.js
 [exec] - /opt/homebrew/lib/node_modules/yuidocjs/lib/index.js
 [exec] - /opt/homebrew/lib/node_modules/yuidocjs/lib/cli.js
 [exec]     at Module._resolveFilename (node:internal/modules/cjs/loader:1026:15)
 [exec]     at Module._load (node:internal/modules/cjs/loader:872:27)
 [exec]     at Module.require (node:internal/modules/cjs/loader:1092:19)
 [exec]     at require (node:internal/modules/cjs/helpers:103:18)
 [exec]     at /opt/homebrew/lib/node_modules/yuidocjs/lib/builder.js:137:25
 [exec]     at Array.forEach (<anonymous>)
 [exec]     at Y.DocBuilder._addHelpers (/opt/homebrew/lib/node_modules/yuidocjs/lib/builder.js:133:21)
 [exec]     at new Y.DocBuilder (/opt/homebrew/lib/node_modules/yuidocjs/lib/builder.js:58:18)
 [exec]     at Object.<anonymous> (/opt/homebrew/lib/node_modules/yuidocjs/lib/cli.js:43:23)
 [exec]     at Module._compile (node:internal/modules/cjs/loader:1205:14)
 [exec] error: --------------------------------------------------------------------------
 [exec] error: Node.js version: v19.1.0
 [exec] error: YUI version: 3.18.1
 [exec] error: YUIDoc version: 0.10.2
 [exec] error: Please file all tickets here: http://github.com/yui/yuidoc/issues
 [exec] error: --------------------------------------------------------------------------
 [exec] Result: 1

When I try to install yuidoc with npm -g install yuidocjs I get the following Error: npm ERR! Invalid Version: 3.5.0pr2

I've no idea what to do. Thanks for your help

JSDoc seems to have a way to represent generic type parameters: https://stackoverflow.com/a/19322784/497116. Does YUIDoc have a similar functionality or plans to implement one?

Subdependency cryptiles/0.2.2 (via yui->request->hawk) has a security vulnerability (see https://nvd.nist.gov/vuln/detail/CVE-2018-1000620). Would it be possible to update these dependencies to fix the issue?

I was using the npm start command to bring up the preview server and noticed that code blocks (either using the triple backtick or the indent method) would have their first line indented incorrectly. Looks like the first line has no spaces in front of it.

Also, in the final compiled documentation, it looks like a bunch of unnecessary empty comments are added between each line.

Left side shows compiled documentation. Right side show preview server.

Would be nice to have some form of note/warning/important tagging. E.g.

@note When you do this, that could result in that. @warning Doing this could format your hard drive and cause demons from exiting your nostrils. @Important Do not look into the sun too long or you will go blind!

This would, for example, allow the markup to translate this to something like putting a vertical line to the left and add a hanging indent. Somehow emphasize the paragraphs that follow the tag.

Would also be good to be able to control if the note should remain indented (to be part of the @param/@return) or not to show that it is a note for the entire @method.