[Jsdoc-user] Prototypical inheritence of built-in types creates entries for built-in types in class
Status: Inactive
Brought to you by:
mmathews
From: Bruce B. <br...@br...> - 2007-03-26 14:45:34
|
Hi, I'm having a problem with JSDoc where, when I declare a class which prototypically inherits from a built-in such as Error, JSDoc creates an entry for Error in the class list which does not link to anywhere (since I do not define the Error class in my code). Is it possible to give JSDoc a list of types not to include in the class list or link to? I have found the same to occur when prototypically 'extending' String and Object too. I include a code snippet below. I tried to look through the JSDoc.pl file to see where would be an appropriate place to put some code to ignore built-ins but didn't have much luck understanding where the class list and links are generated. Bruce /** * @class The WBSI global namespace object. * @static */ var WBSI = function() { }; /** * Create a IllegalArgumentException with an associated explanation, operation * and arguument list. * * @class An IllegalArgumentException will be thrown if an operation is * invoked with incorrect or invalid parameters * * @param {String} explanation Explanation of exception * * @param {Object} func The operation invoked * * @param {Object[]} args The arguments the operation was * invoked with */ WBSI.IllegalArgumentException = function(explanation, func, args) { this._wbinit(explanation, func, args); } /** * @extends Error */ WBSI.IllegalArgumentException.prototype=new Error; /** * The explanation for why the exception was thrown * * @property explanation * @type String */ WBSI.IllegalArgumentException.prototype.explanation = null; /** * The operation invoked * * @property operation * @type Object */ WBSI.IllegalArgumentException.prototype.operation = null; /** * The arguments the operation was invoked with * * @property arglist * @type Object[] */ WBSI.IllegalArgumentException.prototype.arglist = null; /** * @method _wbinit * @ignore */ WBSI.IllegalArgumentException.prototype._wbinit = function(ex, op, args) { this.explanation = ex; this.operation = op; this.arglist = args; }; |