For a function like this...
function example() {
var X = 100;
...
var Y = \'abc\';
...
return Z;
}
I need to explain the purpose
It seems that JS Docs ignores comments within the "block" (E.g. class, function, etc.). I tried...
@description
@inner
@instance
@member
@memberof
@name
@summary
...and others. I was unable to get any of them to generate documentation. Throughout the JS Doc examples they use normal JS comments for this sort of thing.
I have concluded that there is no official JS Doc syntax for this.