Added documentation for the TypedArray API

Author: phoboslab

JavaScriptCore/API/JSTypedArray.h

@@ -3,6 +3,24 @@
 
 #include <JavaScriptCore/JSValueRef.h>
 
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/*!
+@enum JSType
+@abstract     A constant identifying the Typed Array type of a JSValue.
+@constant     kJSTypedArrayTypeNone                 Not a Typed Array.
+@constant     kJSTypedArrayTypeInt8Array            Int8Array
+@constant     kJSTypedArrayTypeInt16Array           Int16Array
+@constant     kJSTypedArrayTypeInt32Array           Int32Array
+@constant     kJSTypedArrayTypeUint8Array           Int8Array
+@constant     kJSTypedArrayTypeUint8ClampedArray    Int8ClampedArray
+@constant     kJSTypedArrayTypeUint16Array          Uint16Array
+@constant     kJSTypedArrayTypeUint32Array          Uint32Array
+@constant     kJSTypedArrayTypeFloat32Array         Float32Array
+@constant     kJSTypedArrayTypeFloat64Array         Float64Array
+*/
 typedef enum {
     kJSTypedArrayTypeNone,
     kJSTypedArrayTypeInt8Array,
@@ -17,14 +35,35 @@ typedef enum {
     kJSTypedArrayTypeLast
 } JSTypedArrayType;
 
+/*!
+@function
+@abstract           Returns a JavaScript value's Typed Array type
+@param ctx          The execution context to use.
+@param value        The JSValue whose Typed Array type you want to obtain.
+@result             A value of type JSTypedArrayType that identifies value's Typed Array type.
+*/
+JS_EXPORT JSTypedArrayType JSTypedArrayGetType(JSContextRef ctx, JSValueRef value);
 
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-JS_EXPORT JSTypedArrayType JSTypedArrayGetType(JSContextRef ctx, JSValueRef array);
+/*!
+@function
+@abstract           Creates a JavaScript Typed Array with the given number of elements
+@param ctx          The execution context to use.
+@param arrayClass   A value of type JSTypedArrayType identifying the type of array you want to create
+@param numElements  The number of elements for the array.
+@result             A JSValueRef that is a Typed Array or NULL if there was an error
+*/
 JS_EXPORT JSValueRef JSTypedArrayMake(JSContextRef ctx, JSTypedArrayType arrayClass, size_t numElements);
-JS_EXPORT void * JSTypedArrayGetDataPtr(JSContextRef ctx, JSValueRef array, size_t * byteLength);
+
+/*!
+@function
+@abstract           Returns a pointer to a Typed Array's data in memory
+@param ctx          The execution context to use.
+@param value        The JSValue whose Typed Array type data pointer you want to obtain.
+@param byteLength   A pointer to a size_t in which to store the byte length of the Typed Array
+@result             A pointer to the Typed Array's data or NULL if the JSValue is not a Typed Array
+*/
+JS_EXPORT void * JSTypedArrayGetDataPtr(JSContextRef ctx, JSValueRef value, size_t * byteLength);
+
 
 #ifdef __cplusplus
 }