Reviewed by John.
authorggaren <ggaren@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Fri, 7 Jul 2006 20:38:16 +0000 (20:38 +0000)
committerggaren <ggaren@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Fri, 7 Jul 2006 20:38:16 +0000 (20:38 +0000)
        - More headerdoc

        * API/JSBase.h:
        * JavaScriptCore.xcodeproj/project.pbxproj:

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

JavaScriptCore/API/JSBase.h
JavaScriptCore/ChangeLog
JavaScriptCore/JavaScriptCore.xcodeproj/project.pbxproj

index d3d09d780f3cd77403ed782c59b3adfcb0ce031f..1280525242ccddd5110f0caa32d17696939325eb 100644 (file)
 #ifndef JSBase_h
 #define JSBase_h
 
-/* JS runtime interface types */
+/* JavaScript engine interface */
+
+/*! @typedef JSContextRef A JavaScript execution context. Holds the global object and other execution state. */
 typedef struct __JSContext* JSContextRef;
+/*! @typedef JSStringBuffer A UTF16 character buffer. The fundamental string representation in JavaScript. */
 typedef struct __JSStringBuffer* JSStringBufferRef;
+/*! @typedef JSClassRef A JavaScript class. Used with JSObjectMake to construct objects with custom behavior. */
 typedef struct __JSClass* JSClassRef;
+/*! @typedef JSPropertyListRef A JavaScript property list. Used for listing the properties in an object so they can be enumerated. */
 typedef struct __JSPropertyList* JSPropertyListRef;
+/*! @typedef JSPropertyEnumeratorRef A JavaScript property enumerator. Used for enumerating the properties in an object. */
 typedef struct __JSPropertyEnumerator* JSPropertyEnumeratorRef;
 
-/* Base type of all JS values, and polymorphic functions on them */
+
+/* JavaScript data types */
+
+/*! @typedef JSValueRef A JavaScript value. The base type for all JavaScript values, and polymorphic functions on them. */
 typedef void* JSValueRef;
 
+/*! @typedef JSObjectRef A JavaScript object. A JSObject is a JSValue. */
 typedef struct __JSObject* JSObjectRef;
 
 #endif // JSBase_h
index 67007ce2682d29b079d34c8948eed0b6a9d03011..3598c6fd783340e2324026dabebc4e6dc05daeae 100644 (file)
@@ -1,3 +1,12 @@
+2006-07-07  Geoffrey Garen  <ggaren@apple.com>
+
+        Reviewed by John.
+        
+        - More headerdoc
+
+        * API/JSBase.h:
+        * JavaScriptCore.xcodeproj/project.pbxproj:
+
 2006-07-05  Geoffrey Garen  <ggaren@apple.com>
 
         RS by Beth.
index 75b3f67fb2f9af0a04332263eaeca3cc71a2a200..e1d111fe6d7fcdbe97555f7d082ca593b4166b5c 100644 (file)
                E195679909E7CF1200B89D13 /* UnicodeCategory.h in Headers */ = {isa = PBXBuildFile; fileRef = E195679509E7CF1200B89D13 /* UnicodeCategory.h */; };
 /* End PBXBuildFile section */
 
-/* Begin PBXBuildStyle section */
-               147FA0270A5C2444002E7E85 /* Development */ = {
-                       isa = PBXBuildStyle;
-                       buildSettings = {
-                               COPY_PHASE_STRIP = NO;
-                       };
-                       name = Development;
-               };
-               147FA0280A5C2444002E7E85 /* Deployment */ = {
-                       isa = PBXBuildStyle;
-                       buildSettings = {
-                               COPY_PHASE_STRIP = YES;
-                       };
-                       name = Deployment;
-               };
-/* End PBXBuildStyle section */
-
 /* Begin PBXContainerItemProxy section */
                141211350A48796100480255 /* PBXContainerItemProxy */ = {
                        isa = PBXContainerItemProxy;
                0867D690FE84028FC02AAC07 /* Project object */ = {
                        isa = PBXProject;
                        buildConfigurationList = 149C277108902AFE008A9EFC /* Build configuration list for PBXProject "JavaScriptCore" */;
-                       buildSettings = {
-                       };
-                       buildStyles = (
-                               147FA0270A5C2444002E7E85 /* Development */,
-                               147FA0280A5C2444002E7E85 /* Deployment */,
-                       );
                        hasScannedForEncodings = 1;
                        mainGroup = 0867D691FE84028FC02AAC07 /* JavaScriptCore */;
                        productRefGroup = 034768DFFF38A50411DB9C8B /* Products */;