* API/JSBase.h: Fix comment formatting where things used to be lined up but
authordarin <darin@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Mon, 17 Jul 2006 15:19:46 +0000 (15:19 +0000)
committerdarin <darin@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Mon, 17 Jul 2006 15:19:46 +0000 (15:19 +0000)
        are now ragged. Got rid of spaces that attempted to line things up.
        * API/JSObjectRef.h: Ditto. Also add missing periods for a couple of comments.

git-svn-id: https://svn.webkit.org/repository/webkit/trunk@15486 268f45cc-cd09-0410-ab3c-d52691b4dbfc

JavaScriptCore/API/JSBase.h
JavaScriptCore/API/JSObjectRef.h
JavaScriptCore/ChangeLog

index b55c89a0ce305a533425ba62717c16c01a83ac07..8b451b830fe0081180b573595e19d2f7e1ab6ccf 100644 (file)
@@ -66,26 +66,26 @@ extern "C" {
 
 /*!
 @function
-@abstract                 Evaluates a string of JavaScript.
-@param ctx            The execution context to use.
-@param script             A JSString containing the script to evaluate.
-@param thisObject         The object to use as "this," or NULL to use the global object as "this."
-@param sourceURL          A JSString containing a URL for the script's source file. This is only used when reporting exceptions. Pass NULL if you do not care to include source file information in exceptions.
+@abstract Evaluates a string of JavaScript.
+@param ctx The execution context to use.
+@param script A JSString containing the script to evaluate.
+@param thisObject The object to use as "this," or NULL to use the global object as "this."
+@param sourceURL A JSString containing a URL for the script's source file. This is only used when reporting exceptions. Pass NULL if you do not care to include source file information in exceptions.
 @param startingLineNumber An integer value specifying the script's starting line number in the file located at sourceURL. This is only used when reporting exceptions.
-@param exception          A pointer to a JSValueRef in which to store an exception, if any. Pass NULL if you do not care to store an exception.
-@result                   The JSValue that results from evaluating script, or NULL if an exception is thrown.
+@param exception A pointer to a JSValueRef in which to store an exception, if any. Pass NULL if you do not care to store an exception.
+@result The JSValue that results from evaluating script, or NULL if an exception is thrown.
 */
 JSValueRef JSEvaluateScript(JSContextRef ctx, JSStringRef script, JSObjectRef thisObject, JSStringRef sourceURL, int startingLineNumber, JSValueRef* exception);
 
 /*!
 @function JSCheckScriptSyntax
-@abstract                 Checks for syntax errors in a string of JavaScript.
-@param ctx            The execution context to use.
-@param script             A JSString containing the script to check for syntax errors.
-@param sourceURL          A JSString containing a URL for the script's source file. This is only used when reporting exceptions. Pass NULL if you do not care to include source file information in exceptions.
+@abstract Checks for syntax errors in a string of JavaScript.
+@param ctx The execution context to use.
+@param script A JSString containing the script to check for syntax errors.
+@param sourceURL A JSString containing a URL for the script's source file. This is only used when reporting exceptions. Pass NULL if you do not care to include source file information in exceptions.
 @param startingLineNumber An integer value specifying the script's starting line number in the file located at sourceURL. This is only used when reporting exceptions.
-@param exception          A pointer to a JSValueRef in which to store a syntax error exception, if any. Pass NULL if you do not care to store a syntax error exception.
-@result                   true if the script is syntactically correct, otherwise false.
+@param exception A pointer to a JSValueRef in which to store a syntax error exception, if any. Pass NULL if you do not care to store a syntax error exception.
+@result true if the script is syntactically correct, otherwise false.
 */
 bool JSCheckScriptSyntax(JSContextRef ctx, JSStringRef script, JSStringRef sourceURL, int startingLineNumber, JSValueRef* exception);
 
index 9d951e82b75f4f1c1430f85a598d45289ea9fed8..c91f43746052d8764b3c63e51e6c73808f5da439 100644 (file)
@@ -504,7 +504,7 @@ bool JSObjectDeleteProperty(JSContextRef ctx, JSObjectRef object, JSStringRef pr
 @abstract Gets a property from an object by numeric index.
 @param ctx The execution context to use.
 @param object The JSObject whose property you want to get.
-@param propertyIndex The property's name as a number
+@param propertyIndex The property's name as a number.
 @param exception A pointer to a JSValueRef in which to store an exception, if any. Pass NULL if you do not care to store an exception.
 @result The property's value if object has the property, otherwise the undefined value.
 @discussion Calling JSObjectGetPropertyAtIndex is equivalent to calling JSObjectGetProperty with a string containing propertyIndex, but it enables optimized access to JavaScript arrays.
@@ -516,7 +516,7 @@ JSValueRef JSObjectGetPropertyAtIndex(JSContextRef ctx, JSObjectRef object, unsi
 @abstract Sets a property on an object by numeric index.
 @param ctx The execution context to use.
 @param object The JSObject whose property you want to set.
-@param propertyIndex The property's name as a number
+@param propertyIndex The property's name as a number.
 @param value A JSValue to use as the property's value.
 @param exception A pointer to a JSValueRef in which to store an exception, if any. Pass NULL if you do not care to store an exception.
 @discussion Calling JSObjectSetPropertyAtIndex is equivalent to calling JSObjectSetProperty with a string containing propertyIndex, but it enables optimized access to JavaScript arrays.
@@ -595,40 +595,40 @@ JSPropertyNameArrayRef JSObjectCopyPropertyNames(JSContextRef ctx, JSObjectRef o
 
 /*!
 @function
-@abstract         Retains a JavaScript property name array.
-@param array      The JSPropertyNameArray to retain.
-@result           A JSPropertyNameArray that is the same as array.
+@abstract Retains a JavaScript property name array.
+@param array The JSPropertyNameArray to retain.
+@result A JSPropertyNameArray that is the same as array.
 */
 JSPropertyNameArrayRef JSPropertyNameArrayRetain(JSPropertyNameArrayRef array);
 
 /*!
 @function
-@abstract         Releases a JavaScript property name array.
-@param array      The JSPropetyNameArray to release.
+@abstract Releases a JavaScript property name array.
+@param array The JSPropetyNameArray to release.
 */
 void JSPropertyNameArrayRelease(JSPropertyNameArrayRef array);
 
 /*!
 @function
-@abstract      Get the number of items in a JavaScript property name array.
-@param array   The array from which to retrieve the count.
-@result        The count of items in the array.
+@abstract Get the number of items in a JavaScript property name array.
+@param array The array from which to retrieve the count.
+@result The count of items in the array.
 */
 size_t JSPropertyNameArrayGetCount(JSPropertyNameArrayRef array);
 
 /*!
 @function
-@abstract      Get a single item from a JavaScript property name array.
-@param array   The array from which to retrieve a property name.
-@param index   The index of the property name to retrieve.
-@result        A JSStringRef containing the name of the property.
+@abstract Get a single item from a JavaScript property name array.
+@param array The array from which to retrieve a property name.
+@param index The index of the property name to retrieve.
+@result A JSStringRef containing the name of the property.
 */
 JSStringRef JSPropertyNameArrayGetNameAtIndex(JSPropertyNameArrayRef array, size_t index);
 
 /*!
 @function
-@abstract           Add a property name - useful while getting the property names for an object.
-@param accumulator  The accumulator object to which to add the property.
+@abstract Add a property name - useful while getting the property names for an object.
+@param accumulator The accumulator object to which to add the property.
 @param propertyName The new property to add.
 */
 void JSPropertyNameAccumulatorAddName(JSPropertyNameAccumulatorRef accumulator, JSStringRef propertyName);
index e00f9a8fc36793b7a29e8756fb3aed18604afa84..07c73e89272ed1e63fa1e0bc02467af1bd0d2406 100644 (file)
@@ -1,3 +1,9 @@
+2006-07-17  Darin Adler  <darin@apple.com>
+
+        * API/JSBase.h: Fix comment formatting where things used to be lined up but
+        are now ragged. Got rid of spaces that attempted to line things up.
+        * API/JSObjectRef.h: Ditto. Also add missing periods for a couple of comments.
+
 2006-07-17  Geoffrey Garen  <ggaren@apple.com>
 
         Reviewed by Maciej.