TecDocPope
unread,Jan 30, 2012, 8:18:53 AM1/30/12Sign in to reply to author
Sign in to forward
You do not have permission to delete messages in this group
Either email addresses are anonymous for this group or you need the view member email addresses permission to view the original message
to JSDoc Users
Hello,
is there an opportunity to create JSDocs only for functions of an
class, that have an specific tag? In this special case i have a js
file with different variations of functions with or without
annotations and comments, different uses of @private, @public and so
on. Different variations and combinations of creating JSDocs with
private, public and/or -a option didn't produce the output i wanted
to.
An example:
/**
* @public
* @description An example function
*/
function InitExample(){
alert("Example");
return true;
}
/**
* @private
* @description A private function
*/
function privateFunction(){
alert("Example");
return true;
}
/**
* A function with no specific annotation
*/
function nothingSpecial(){
alert("Example");
return true;
}
Here i only want to have the function InitExample() to be documented,
the private function and the one with no special annotation shall not
be documented. For nothingSpecial(), it is no option to delete the
comment or to annotate it with @private or something like that.
I hope, someone has an idea, how to solve this.
Thanks in advance,
TecDocPope