Changeset 15486 in webkit for trunk/JavaScriptCore/API


Ignore:
Timestamp:
Jul 17, 2006, 8:19:46 AM (19 years ago)
Author:
darin
Message:
  • 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.
Location:
trunk/JavaScriptCore/API
Files:
2 edited

Legend:

Unmodified
Added
Removed

  • trunk/JavaScriptCore/API/JSBase.h

    r15481 r15486  
    6767/*!
    6868@function
    69 @abstract                 Evaluates a string of JavaScript.
    70 @param ctx            The execution context to use.
    71 @param script             A JSString containing the script to evaluate.
    72 @param thisObject         The object to use as "this," or NULL to use the global object as "this."
    73 @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.
     69@abstract Evaluates a string of JavaScript.
     70@param ctx The execution context to use.
     71@param script A JSString containing the script to evaluate.
     72@param thisObject The object to use as "this," or NULL to use the global object as "this."
     73@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.
    7474@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.
    75 @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.
    76 @result                   The JSValue that results from evaluating script, or NULL if an exception is thrown.
     75@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.
     76@result The JSValue that results from evaluating script, or NULL if an exception is thrown.
    7777*/
    7878JSValueRef JSEvaluateScript(JSContextRef ctx, JSStringRef script, JSObjectRef thisObject, JSStringRef sourceURL, int startingLineNumber, JSValueRef* exception);
    … …  
    8080/*!
    8181@function JSCheckScriptSyntax
    82 @abstract                 Checks for syntax errors in a string of JavaScript.
    83 @param ctx            The execution context to use.
    84 @param script             A JSString containing the script to check for syntax errors.
    85 @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.
     82@abstract Checks for syntax errors in a string of JavaScript.
     83@param ctx The execution context to use.
     84@param script A JSString containing the script to check for syntax errors.
     85@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.
    8686@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.
    87 @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.
    88 @result                   true if the script is syntactically correct, otherwise false.
     87@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.
     88@result true if the script is syntactically correct, otherwise false.
    8989*/
    9090bool JSCheckScriptSyntax(JSContextRef ctx, JSStringRef script, JSStringRef sourceURL, int startingLineNumber, JSValueRef* exception);

  • trunk/JavaScriptCore/API/JSObjectRef.h

    r15484 r15486  
    505505@param ctx The execution context to use.
    506506@param object The JSObject whose property you want to get.
    507 @param propertyIndex The property's name as a number
     507@param propertyIndex The property's name as a number.
    508508@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.
    509509@result The property's value if object has the property, otherwise the undefined value.
    … …  
    517517@param ctx The execution context to use.
    518518@param object The JSObject whose property you want to set.
    519 @param propertyIndex The property's name as a number
     519@param propertyIndex The property's name as a number.
    520520@param value A JSValue to use as the property's value.
    521521@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.
    … …  
    596596/*!
    597597@function
    598 @abstract         Retains a JavaScript property name array.
    599 @param array      The JSPropertyNameArray to retain.
    600 @result           A JSPropertyNameArray that is the same as array.
     598@abstract Retains a JavaScript property name array.
     599@param array The JSPropertyNameArray to retain.
     600@result A JSPropertyNameArray that is the same as array.
    601601*/
    602602JSPropertyNameArrayRef JSPropertyNameArrayRetain(JSPropertyNameArrayRef array);
    … …  
    604604/*!
    605605@function
    606 @abstract         Releases a JavaScript property name array.
    607 @param array      The JSPropetyNameArray to release.
     606@abstract Releases a JavaScript property name array.
     607@param array The JSPropetyNameArray to release.
    608608*/
    609609void JSPropertyNameArrayRelease(JSPropertyNameArrayRef array);
    … …  
    611611/*!
    612612@function
    613 @abstract      Get the number of items in a JavaScript property name array.
    614 @param array   The array from which to retrieve the count.
    615 @result        The count of items in the array.
     613@abstract Get the number of items in a JavaScript property name array.
     614@param array The array from which to retrieve the count.
     615@result The count of items in the array.
    616616*/
    617617size_t JSPropertyNameArrayGetCount(JSPropertyNameArrayRef array);
    … …  
    619619/*!
    620620@function
    621 @abstract      Get a single item from a JavaScript property name array.
    622 @param array   The array from which to retrieve a property name.
    623 @param index   The index of the property name to retrieve.
    624 @result        A JSStringRef containing the name of the property.
     621@abstract Get a single item from a JavaScript property name array.
     622@param array The array from which to retrieve a property name.
     623@param index The index of the property name to retrieve.
     624@result A JSStringRef containing the name of the property.
    625625*/
    626626JSStringRef JSPropertyNameArrayGetNameAtIndex(JSPropertyNameArrayRef array, size_t index);
    … …  
    628628/*!
    629629@function
    630 @abstract           Add a property name - useful while getting the property names for an object.
    631 @param accumulator  The accumulator object to which to add the property.
     630@abstract Add a property name - useful while getting the property names for an object.
     631@param accumulator The accumulator object to which to add the property.
    632632@param propertyName The new property to add.
    633633*/
Note: See TracChangeset for help on using the changeset viewer.