Is there a way to enable debugging ?

[Camille Hodoul]

Hi,

I'm trying to generate doc on a legacy project using yuidoc (on Windows).

I have a yuidoc.json file in the project root, with basic options:

{

    "name": "Legacy project",

    "description": "Legacy project",

    "version": "4.30",

    "options": {

        "outdir": "../documentation/legacy_project",

"paths": ["./app/my/code"]

    }

} 

However, when I run yuidoc (files are in ascii):

>yuidoc --charset "ascii" --server

The output is:

yuidoc: (warn): Setting default charset to ascii

info: (yuidoc): Starting YUI...@0.5.0 using Y...@3.81.1 with Nod...@0.10.35

info: (yuidoc): Scanning for yuidoc.json file.

info: (yuidoc): Loading yuidoc.json data from: Path\To\yuidoc.json

And then nothing, it stops here, and 127.0.0.1:3000 is unavailable. No error message anywhere.

I've tried removing the yuidoc.json and passing all the options from the CLI, but the problem is the same (exept that the program stops at the line "Scanning for yuidoc.json file.").

I've tried setting the charset to "binary", changing options in the yuidoc.json... but it changes nothing.

So, is there a way to enable any kind of verbose logging/debugging to find where the problem is ?

I don't think it comes from my yuidoc installation since I'm using it on other projects and it works fine (the other projects are in utf8 though).

I found nothing in the doc http://yui.github.io/yuidoc/args/index.html#json, and my google-fu failed me...

Any help would be appreciated.

Thanks

[Ryuichi Okumura]

Although I cannot be verified immediately reproduced your problem because I don't have any Windows box, so could you try to verify the port 3000 is LISTEN by running netstat command?

Also, you're able to specify a different port to --server option as follows.

$ yuidoc --server 8080 .

Do not change even on a port number other than port 3000?

Thanks!

Ryuichi

--
You received this message because you are subscribed to the Google Groups "yuidoc" group.
To unsubscribe from this group and stop receiving emails from it, send an email to yuidoc+un...@googlegroups.com.
To post to this group, send email to yui...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/yuidoc/0229e89e-4517-42ab-afcd-f9812eb795ed%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

[Camille Hodoul]

The problem exists even without the --server option, so I don't think it's related.

The main problem is that yuidoc is apparently unable to read files/directories and doesn't show any warning or error.

I should probably add that the files are located on a shared folder on a network.

Thank you for your help !

[Camille Hodoul]

So apparently it was simply a matter of time : yuidoc took so long to read all the files in the project that it didn't output anything in 10 minutes.

It seems that even when you set a specific folder in the `paths` option, yuidoc will read the whole tree, and that's what took so long.

Still, it would be cool if we had a warning in case something takes too long, or if it could be written in the doc that yuidoc will go through your whole project, regardless of the `paths` option (maybe I missed it ?).

[Ryuichi Okumura]

YUIDoc will try to scan all JavaScript files under the "paths". Would you like that if there is a verbose mode you can see the files in the scanning?

Ryuichi

To view this discussion on the web visit https://groups.google.com/d/msgid/yuidoc/2e09d124-9e57-4d89-a488-3ef116288288%40googlegroups.com.