You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Example: There are several .js files with couple functions like:
no classes just function.
/** * TestFunction - doing something. * @param {String} strTest Test string. * @return {Boolean} bRes Returned value. */ function TestFunction(strTest) { //code ... return bRes; }
After JsDuck.exe created help file - no parameter strTest of function TestFunction in function description is present, only return value bRes with description.
Version: SDuck 5.0.0.beta2 also tried on earlier version and same result.
Does anyone used JSduck for functional frameworks(e.g using JSDuck for TestComplete) and got success or are there any workaround to get this work properly?
Same .js files work correctly with JSDoc toolkit and all data is shown, but JSDuck is still preferable to make it work.
Also additional question is there possibility to group function that are in same files without changes in code.
Thanks in advance for reply.
The text was updated successfully, but these errors were encountered:
So, because your function begins with uppercase letter, JSDuck thinks it's in fact a class. You need to add @method tag to make JSDuck understand it correctly.
There are number of heuristics like this that JSDuck uses. So if your write code in a certain way, JSDuck will happily auto-detect lots of things for you. However if you use some drastically different coding style, it can be pain to use JSDuck.
JSDuck is specifically targeted towards Sencha JS frameworks. But it should generally work well when writing JavaScript in OOP-style. For functional it's probably not such a good fit. First off it forces you to organize your code into classes - you might not like that if you only want functions.
Example: There are several .js files with couple functions like:
no classes just function.
/**
* TestFunction - doing something.
* @param {String} strTest Test string.
* @return {Boolean} bRes Returned value.
*/
function TestFunction(strTest) {
//code ...
return bRes;
}
After JsDuck.exe created help file - no parameter strTest of function TestFunction in function description is present, only return value bRes with description.
Version: SDuck 5.0.0.beta2 also tried on earlier version and same result.
Does anyone used JSduck for functional frameworks(e.g using JSDuck for TestComplete) and got success or are there any workaround to get this work properly?
Same .js files work correctly with JSDoc toolkit and all data is shown, but JSDuck is still preferable to make it work.
Also additional question is there possibility to group function that are in same files without changes in code.
Thanks in advance for reply.
The text was updated successfully, but these errors were encountered: