Merge all changes from the naturaldocs sandbox. This brings all the work that

has been done in the NaturalDocs branch back to trunk. Thanks to everyone who
helped out in making this happen. (I could list people, but the list would
be long, and I'm already mentally on vacation.)


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

lib/OpenLayers/Console.js

@@ -3,17 +3,18 @@
  * for the full text of the license. */
 
 /**
+ * Namespace: OpenLayers.Console
  * The OpenLayers.Console namespace is used for debugging and error logging.
  * If the Firebug Lite (../Firebug/firebug.js) is included before this script,
  * calls to OpenLayers.Console methods will get redirected to window.console.
  * This makes use of the Firebug extension where available and allows for
  * cross-browser debugging Firebug style.
  *
+ * Note:
  * Note that behavior will differ with the Firebug extention and Firebug Lite.
  * Most notably, the Firebug Lite console does not currently allow for
  * hyperlinks to code or for clicking on object to explore their properties.
  * 
- * @fileoverview Error logging and debugging console
  */
 OpenLayers.Console = {
     /**
@@ -24,6 +25,7 @@ OpenLayers.Console = {
      */
     
     /**
+     * APIFunction: log
      * Log an object in the console.  The Firebug Lite console logs string
      * representation of objects.  Given multiple arguments, they will
      * be cast to strings and logged with a space delimiter.  If the first
@@ -31,86 +33,95 @@ OpenLayers.Console = {
      * will be used in string substitution.  Any additional arguments (beyond
      * the number substituted in a format string) will be appended in a space-
      * delimited line.
-     *
-     * Examples:
-     * // Firebug Lite logs someObject.toString()
-     * OpenLayers.Console.log(someObject);
      * 
-     * // string substitution
-     * OpenLayers.Console.log("%s jumped over %s", cow, moon);
-     * 
-     * @param {Object} object
+     * Parameters:
+     * object - {Object}
      */
     log: function() {},
 
     /**
+     * APIFunction: debug
      * Writes a message to the console, including a hyperlink to the line
      * where it was called.
      *
      * May be called with multiple arguments as with OpenLayers.Console.log().
      * 
-     * @param (Object) object
+     * Parameters:
+     * object - {Object}
      */
     debug: function() {},
 
     /**
+     * APIFunction: info
      * Writes a message to the console with the visual "info" icon and color
      * coding and a hyperlink to the line where it was called.
      *
      * May be called with multiple arguments as with OpenLayers.Console.log().
      * 
-     * @param (Object) object
+     * Parameters:
+     * object - {Object}
      */
     info: function() {},
 
     /**
+     * APIFunction: warn
      * Writes a message to the console with the visual "warning" icon and
      * color coding and a hyperlink to the line where it was called.
      *
      * May be called with multiple arguments as with OpenLayers.Console.log().
      * 
-     * @param (Object) object
+     * Parameters:
+     * object - {Object}
      */
     warn: function() {},
 
     /**
+     * APIFunction: error
      * Writes a message to the console with the visual "error" icon and color
      * coding and a hyperlink to the line where it was called.
      *
      * May be called with multiple arguments as with OpenLayers.Console.log().
      * 
-     * @param (Object) object
+     * Parameters:
+     * object - {Object}
      */
     error: function() {},
 
     /**
+     * APIFunction: assert
      * Tests that an expression is true. If not, it will write a message to
      * the console and throw an exception.
      *
      * May be called with multiple arguments as with OpenLayers.Console.log().
      * 
-     * @param (Object) expression
+     * Parameters:
+     * object - {Object}
      */
     assert: function() {},
 
     /**
+     * APIFunction: dir
      * Prints an interactive listing of all properties of the object. This
      * looks identical to the view that you would see in the DOM tab.
      * 
-     * @param (Object) object
+     * Parameters:
+     * object - {Object}
      */
     dir: function() {},
 
     /**
+     * APIFunction: dirxml
      * Prints the XML source tree of an HTML or XML element. This looks
      * identical to the view that you would see in the HTML tab. You can click
      * on any node to inspect it in the HTML tab.
      * 
-     * @param (Object) object
+     * Parameters:
+     * object - {Object}
      */
     dirxml: function() {},
 
     /**
+     * APIFunction: trace
      * Prints an interactive stack trace of JavaScript execution at the point
      * where it is called.  The stack trace details the functions on the stack,
      * as well as the values that were passed as arguments to each function.
@@ -121,28 +132,33 @@ OpenLayers.Console = {
     trace: function() {},
 
     /**
+     * APIFunction: group
      * Writes a message to the console and opens a nested block to indent all
      * future messages sent to the console. Call OpenLayers.Console.groupEnd()
      * to close the block.
      *
      * May be called with multiple arguments as with OpenLayers.Console.log().
      * 
-     * @param (Object) object
+     * Parameters:
+     * object - {Object}
      */
     group: function() {},
 
     /**
+     * APIFunction: groupEnd
      * Closes the most recently opened block created by a call to
      * OpenLayers.Console.group
      */
     groupEnd: function() {},
     
     /**
+     * APIFunction: time
      * Creates a new timer under the given name. Call
      * OpenLayers.Console.timeEnd(name)
      * with the same name to stop the timer and print the time elapsed.
      *
-     * @param {String} name
+     * Parameters:
+     * name - {String}
      */
     time: function() {},
 
@@ -150,7 +166,8 @@ OpenLayers.Console = {
      * Stops a timer created by a call to OpenLayers.Console.time(name) and
      * writes the time elapsed.
      *
-     * @param {String} name
+     * Parameters:
+     * name - {String}
      */
     timeEnd: function() {},
 
@@ -160,7 +177,8 @@ OpenLayers.Console = {
      *
      * This function is not currently implemented in Firebug Lite.
      * 
-     * @param {String} title Optional title for the profiler
+     * Parameters:
+     * title - {String} Optional title for the profiler
      */
     profile: function() {},
 
@@ -178,11 +196,14 @@ OpenLayers.Console = {
      *
      * This function is not currently implemented in Firebug Lite.
      *
-     * @param {String} title Optional title to be printed with count
+     * Parameters:
+     * title - {String} Optional title to be printed with count
      */
     count: function() {},
 
-    /** @final @type String */
+    /**
+     * Constant: CLASS_NAME
+     */
     CLASS_NAME: "OpenLayers.Console"
 };