titanium-jsduck run not working

[ricardoalcocer]

I've tried several times, but the only way I can get the documentation to be generated is by actually compiling the app.

[jamilspain-appc]

Ricardo,

Do you get this error?

[ERROR] Documentation Folder does not exist yet. Have you compiled your project yet?

[ricardoalcocer]

Don't remember seeing a message. I'll check and will report back.

[misha-panyushkin]

Jamil, I get the error of this kind after making "install" & "run" commands respectively.

[jamilspain-appc]

ok. This error means that the documentation folder is not getting created by jsduck. Please try to run "jsduck" from the command line and see if you get a response back. It should say "I have no input options to build documentation" .

@misha-panyushkin Check to see if your alloy.jmk has the proper post:compile statement in there as well. I would try to run the command in the .exec(" "); directly from the command line in the terminal just to make sure everything is working good with your environment.

[misha-panyushkin]

@jamilspain-appc I have run the command inside my project folder: titanium-jsduck install And the output was: "Titanium-JSDuck Version 1.2.3 [INFO] Detected an Titanium Mobile Project [INFO] Detected an existing Alloy.jmk... Backing up to alloy.jmk.txt [INFO] Updated alloy.jmk with config for titanium-jsduck" The "docs" folder was created after this step.

After that I run command: titanium-jsduck run The output: "Titanium-JSDuck Version 1.2.3 [INFO] Running JSDuck Documentation Generator"

After that the command: titanium-jsduck open And the output was: "Titanium-JSDuck Version 1.2.3 [ERROR] Documentation Folder does not exist yet. Have you compiled your project yet?"

[misha-panyushkin]

@jamilspain-appc the command inside exec function call has printed a lot of warnings into my terminal window. The command it self: jsduck --config=docs/jsduck.json app

One of the warning is: Warning: /Users/mishapanyushkin/Documents/imessenger.proto/Prototype/app/lib/node_modules/buffer/perf/solo/bundle.js:1263: Unsupported tag: @memberOf

There is also an one error: Error: Error while parsing /Users/mishapanyushkin/Documents/imessenger.proto/Prototype/app/lib/node_modules/iconv-lite/test/cyrillic-test.js: incompatible character encodings: UTF-8 and ASCII-8BIT

[mjstelly]

Jamil, I'm having the same issue as Ricardo. I don't get an error. I thought it was me. But then I ran the app through Studio and refreshed the browser page. Voila'! Doc changes appeared.

[iamsenorespana]

awesome. If you upgrade to the new version and run the "titanium-jsduck run" from the terminal, it will show output from the "jsduck" ruby command. It will give you some good verbose output. I would ignore the warnings and if they're are any errors however, that's the jackpot.

[mjstelly]

Doesn't appear that jsduck can auto-detect the @param of an event (unless I'm doing it wrong). For example, something like this:

/**
 * @event click
 * @param 
 * */
$.definedBenefitTable.addEventListener('click', function(e) {
    doLog && console.log('[accounts] - definedBenefitTitle - e.index=' + e.index);
});

generates this:

Warning: /Users/mstelly/Documents/Titanium_Studio_Workspace/trsretire-poc/app/controllers/accounts/accounts.js:51: Unnamed parameter

[jamilspain-appc]

for anonymous functions, I don’t that that will work. If you define the function first and then start the doc block above it should pick it up.

function benefitTableClick(e){

} $.definedBenefitTable.addEventListener(“click”, benefitTableClick );

that above method can also be defined using this syntax:

var benefitTableClick = function(e){

}

On Jun 27, 2014, at 11:14 AM, Michael Stelly notifications@github.com<mailto:notifications@github.com> wrote:

Doesn't appear that jsduck can uato-detect the @paramhttps://github.com/param of an event (unless I'm doing it wrong). For example, something like this:

/**

• @event click
• @param
• */ $.definedBenefitTable.addEventListener('click', function(e) { doLog && console.log('[accounts] - definedBenefitTitle - e.index=' + e.index); });

generates this:

Warning: /Users/mstelly/Documents/Titanium_Studio_Workspace/trsretire-poc/app/controllers/accounts/accounts.js:51: Unnamed parameter

— Reply to this email directly or view it on GitHubhttps://github.com/jamilhassanspain/titanium-jsduck/issues/2#issuecomment-47358779.

[rblalock]

Define the param and it should work.