JSDOC coding standards

git-svn-id: http://svn.openlayers.org/trunk/openlayers@146 dc9f47b5-9b13-0410-9fdd-eb0c1a62fdaf

lib/OpenLayers/Util.js

@@ -576,15 +576,20 @@ OpenLayers.Util.createDiv = function(id, px, sz, overflow, img, position) {
 };
 
 /** 
-* @param {str} img - src URL 
+* @param {String} img - src URL 
 * @param {OpenLayers.Size} sz
 * @param {OpenLayers.Pixel} xy
-* @param {str} position
+* @param {String} position
-* @param {str} id
+* @param {String} id
 * @param {int} border
+*
+* @returns A DOM Image created with the specified attributes.
+* @type DOMElement
 */
 OpenLayers.Util.createImage = function(img, sz, xy, position, id, border) {
+
     image = document.createElement("img");
+
     if (id) {
         image.id = id;
         image.style.alt = id;
@@ -610,18 +615,18 @@ OpenLayers.Util.createImage = function(img, sz, xy, position, id, border) {
     image.style.cursor = "inherit";
     image.src = img;
     image.galleryImg = "no";
+    
     return image;
 };
 
 
-/** returns a concatenation of the properties of an object in 
+/**
-*    http parameter notation. ex:
-*
-*    "key1=value1&key2=value2&key3=value3"
-*
 * @param {Object} params
 *
-* @return {str}
+* @returns a concatenation of the properties of an object in 
+*    http parameter notation. 
+*    (ex. <i>"key1=value1&key2=value2&key3=value3"</i>)
+* @type String
 */
 OpenLayers.getParameterString = function(params) {
     paramsArray = new Array();
@@ -637,7 +642,11 @@ OpenLayers.getParameterString = function(params) {
     return paramsArray.join("&");
 };
 
-OpenLayers.Util.getImagesLocation = function () {
+/** 
+* @returns The fully formatted image location string
+* @type String
+*/
+OpenLayers.Util.getImagesLocation = function() {
     return OpenLayers._getScriptLocation() + "img/";
 };
 
@@ -647,7 +656,8 @@ OpenLayers.Util.getImagesLocation = function () {
 *
 * @param {Object} to
 * @param {Object} from
-* @return {Object}
+*
+* @type Object
 */
 OpenLayers.Util.applyDefaults = function (to, from) {
     for (var key in from) {