Add additional documentation to ka-Map constructor in an effort to alleviate

the pain described in #327.


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

lib/OpenLayers/Layer/KaMap.js

@@ -35,7 +35,8 @@ OpenLayers.Layer.KaMap.prototype =
     
     /**
      * Constant: DEFAULT_PARAMS
-     * {Object}
+     * {Object} parameters set by default. The default parameters set 
+     * the format via the 'i' parameter to 'jpeg'.    
      */
     DEFAULT_PARAMS: {
         i: 'jpeg',
@@ -48,8 +49,16 @@ OpenLayers.Layer.KaMap.prototype =
      * Parameters:
      * name - {String}
      * url - {String}
-     * params - {Object}
+     * params - {Object} Parameters to be sent to the HTTP server in the
-     * options - {Object}
+     *    query string for the tile. The format can be set via the 'i'
+     *    parameter (defaults to jpg) , and the map should be set via 
+     *    the 'map' parameter. It has been reported that ka-Map may behave
+     *    inconsistently if your format parameter does not match the format
+     *    parameter configured in your config.php. (See ticket #327 for more
+     *    information.)
+     * options - {Object} Additional options for the layer. Any of the 
+     *     APIProperties listed on this layer, and any layer types it
+     *     extends, can be overridden through the options parameter. 
      */
     initialize: function(name, url, params, options) {
         var newArguments = new Array();