[Jsdoc-user] JSDoc generating thinks one of my methods is a subclass.
Status: Inactive
Brought to you by:
mmathews
|
From: Leslie F. <le...@su...> - 2007-03-08 18:35:46
|
Hello,
I've recently started using JSDoc and been very pleased. I have run
into one slight problem though. When I run JSDoc on the following
code, it generates class documentation for ImageLoader and
ImageLoader.ininitlize. initilize is a method and not a class. What
do I need to do do my code to stop JSDoc from being confused?
Note: it is not generating a class doc for ImageLoader.onImageLoad,
only for .initilize
/**
* @fileoverview This file defines the ImageLoader class.
*
* @author Leslie Freeman le...@su...
* @version 0.1
*/
var ImageLoader = Class.create();
ImageLoader.prototype = {
/**
* Construct a new ImageLoader object. Begins image loading.
*<p>
* Options:<br>
* <li>container - an element, such as a div, to display the image
in. If a container is specified ImageLoader will also display a
loading image.
* <li>beforeLoad - a command to be excecuted before loading starts
* <li>afterLoad - a command to be excecuted when the image is loaded
*
* @class This is the ImageLoader class.
* @param {String} image_url The URL of the image to load.
* @param {Array} options An array of 'key':'value' option pairs --
see description.
* @constructor
*/
initialize: function(image_url, options) {
//function code
},
/**
* Performs functions after the image is loaded. Should not be
called directly. If you need to execute a callback, use the afterLoad
option to the {@link #initilize constructor}.
*/
onImageLoad: function(){
//function code
}
};
Thanks,
Leslie Freeman
|