Changeset 29506 in webkit for trunk/JavaScriptCore

Timestamp:

Jan 15, 2008, 9:23:06 PM (17 years ago)

Author:

[email protected]

Message:

Reviewed by Adam Roben.

Some tweaks to our headerdoc, suggested by David Gatwood on the docs
team.

• API/JSBase.h:
• API/JSObjectRef.h:
• API/JSStringRef.h:
• API/JSValueRef.h:

Location:

trunk/JavaScriptCore

Files:

• API/JSBase.h (modified) (1 diff)
• API/JSObjectRef.h (modified) (1 diff)
• API/JSStringRef.h (modified) (1 diff)
• API/JSValueRef.h (modified) (1 diff)
• ChangeLog (modified) (1 diff)

trunk/JavaScriptCore/API/JSBase.h

@@ -38 +38 @@
 typedef struct OpaqueJSContext* JSGlobalContextRef;
 
-/*! @typedef JSString A UTF16 character buffer. The fundamental string representation in JavaScript. */
+/*! @typedef JSStringRef A UTF16 character buffer. The fundamental string representation in JavaScript. */
 typedef struct OpaqueJSString* JSStringRef;
 

trunk/JavaScriptCore/API/JSObjectRef.h

@@ -187 +187 @@
 @discussion If you named your function GetPropertyNames, you would declare it like this:
 
-void GetPropertyNames(JSContextRef ctx, JSObjectRef object, JSPropertyNameAccumulatorRef accumulator);
+void GetPropertyNames(JSContextRef ctx, JSObjectRef object, JSPropertyNameAccumulatorRef propertyNames);
 
 Property name accumulators are used by JSObjectCopyPropertyNames and JavaScript for...in loops. 

trunk/JavaScriptCore/API/JSStringRef.h

@@ -37 +37 @@
 #endif
 
+#if !defined(WIN32) && !defined(_WIN32)
 /*!
 @typedef JSChar
 @abstract A Unicode character.
 */
-#if !defined(WIN32) && !defined(_WIN32)
     typedef unsigned short JSChar;
 #else

trunk/JavaScriptCore/API/JSValueRef.h

@@ -156 +156 @@
 @param ctx The execution context to use.
 @param value The JSValue to test.
-@param object The constructor to test against.
+@param constructor The constructor to test against.
 @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 true if value is an object constructed by constructor, as compared by the JS instanceof operator, otherwise false.

trunk/JavaScriptCore/ChangeLog

@@ +1 @@
+2008-01-15  Geoffrey Garen  <[email protected]>
+
+        Reviewed by Adam Roben.
+        
+        Some tweaks to our headerdoc, suggested by David Gatwood on the docs
+        team.
+
+        * API/JSBase.h:
+        * API/JSObjectRef.h:
+        * API/JSStringRef.h:
+        * API/JSValueRef.h:
+
 2008-01-15  Alp Toker  <[email protected]>