Subj : Re: API docs
To   : netscape.public.mozilla.jseng
From : Sterling Bates <whoelse@sterlingbates.com>
Date : Thu Apr 15 2004 06:16 pm

This is a multi-part message in MIME format.
--------------080100020308060006030801
Content-Type: text/plain; charset=us-ascii; format=flowed
Content-Transfer-Encoding: 7bit

(Keeping things within this thread.)  I've updated the XML file for the 
structs, and I've attached the diff.  Let me know if I'm heading in the 
right direction, and what I should do differently.

Thanks,

Sterling

--------------080100020308060006030801
Content-Type: text/plain;
 name="diff.txt"
Content-Transfer-Encoding: 7bit
Content-Disposition: inline;
 filename="diff.txt"

964c964
< JS_NewRuntime(maxbytes);
---
> JS_NewRuntime(uint32 maxbytes);
979c979
< JS_DestroyRuntime(rt);
---
> JS_DestroyRuntime(JSRuntime *rt);
1023c1023
<    char *name;
---
>    const char *name;
1041c1041,1042
<    prword spare[2];
---
>    JSMarkOp mark;
>    JSReserveSlotsOp reserveSlots;
1086c1087
<         Pointer to the constructor for the object that represents this <C>class</C><BR/>
---
>         Pointer to the constructor for the object that represents this <C>class</C>.<BR/>
1094,1095c1095,1099
<       <PARAM name='spare' type='prword'>
<         Reserved for future use.<BR/>
---
>       <PARAM name='mark' type='JSMarkOp'>
>         See <a href="http://lxr.mozilla.org/mozilla/source/js/src/jspubtd.h#308">http://lxr.mozilla.org/mozilla/source/js/src/jspubtd.h#308</a><BR/>
>       </PARAM>
>       <PARAM name='reserveSlots' type='JSReserveSlotsOp'>
>         See <a href="http://lxr.mozilla.org/mozilla/source/js/src/jspubtd.h#329">http://lxr.mozilla.org/mozilla/source/js/src/jspubtd.h#308</a><BR/>
1141c1145,1150
<    prword spare[2];
---
>    JSSetObjectSlotOp setProto;
>    JSSetObjectSlotOp setParent;
>    JSMarkOp mark;
>    JSFinalizeOp clear;
>    JSGetRequiredSlotOp getRequiredSlot;
>    JSSetRequiredSlotOp setRequiredSlot;
1197,1198c1206,1222
<       <PARAM name='spare' type='prword'>
<         Reserved for future use.<BR/>
---
>       <PARAM name='setProto' type='JSSetObjectSlotOp'>
>         See <a href="http://lxr.mozilla.org/mozilla/source/js/src/jspubtd.h#464">http://lxr.mozilla.org/mozilla/source/js/src/jspubtd.h#464</a><BR/>
>       </PARAM>
>       <PARAM name='setParent' type='JSSetObjectSlotOp'>
>         See <a href="http://lxr.mozilla.org/mozilla/source/js/src/jspubtd.h#464">http://lxr.mozilla.org/mozilla/source/js/src/jspubtd.h#464</a><BR/>
>       </PARAM>
>       <PARAM name='mark' type='JSMarkOp'>
>         See <a href="http://lxr.mozilla.org/mozilla/source/js/src/jspubtd.h#308">http://lxr.mozilla.org/mozilla/source/js/src/jspubtd.h#308</a><BR/>
>       </PARAM>
>       <PARAM name='clear' type='JSFinalizeOp'>
>         See <a href="http://lxr.mozilla.org/mozilla/source/js/src/jspubtd.h#239">http://lxr.mozilla.org/mozilla/source/js/src/jspubtd.h#239</a><BR/>
>       </PARAM>
>       <PARAM name='getRequiredSlot' type='JSGetRequiredSlotOp'>
>         See <a href="http://lxr.mozilla.org/mozilla/source/js/src/jspubtd.h#473">http://lxr.mozilla.org/mozilla/source/js/src/jspubtd.h#473</a><BR/>
>       </PARAM>
>       <PARAM name='setRequiredSlot' type='JSSetRequiredSlotOp'>
>         See <a href="http://lxr.mozilla.org/mozilla/source/js/src/jspubtd.h#473">http://lxr.mozilla.org/mozilla/source/js/src/jspubtd.h#473</a><BR/>
1360c1384
< typedef struct JSPrincipals {
---
> struct JSPrincipals {
1362,1368c1386,1390
<    void *(*getPrincipalArray)(JSContext *cx,
<       struct JSPrincipals *);
<    JSBool (*globalPrivilegesEnabled)(JSContext *cx,
<       struct JSPrincipals *);
<    uintN refcount;
<    void (*destroy)(JSContext *cx, struct JSPrincipals *);
< } JSPrincipals;
---
>    void *(* JS_DLL_CALLBACK getPrincipalArray)(JSContext *cx, JSPrincipals *);
>    JSBool (* JS_DLL_CALLBACK globalPrivilegesEnabled)(JSContext *cx, JSPrincipals *);
>    jsrefcount refcount;
>    void (* JS_DLL_CALLBACK destroy)(JSContext *cx, struct JSPrincipals *);
> };
1378c1400
<       <PARAM name='refcount' type='uintN'>
---
>       <PARAM name='refcount' type='jsrefcount'>
1412a1435,1438
>    uintN flags;
>    uintN errorNumber;
>    const jschar *ucmessage;
>    const jschar **messageArgs;
1431a1458,1473
>       <PARAM name='flags' type='uintN'>
>         Error description attributes. The default is <C>0</C>. This property may be any of the following attributes <C>OR</C>'d:<BR/>
> <C>JSREPORT_ERROR</C> (default)<BR/>
> <C>JSREPORT_WARNING</C><BR/>
> <C>JSREPORT_EXCEPTION</C><BR/>
> <C>JSREPORT_STRICT</C><BR/>
>       </PARAM>
>       <PARAM name='errorNumber' type='uintN'>
>         The error number. See <a href="http://lxr.mozilla.org/mozilla/source/js/src/js.msg">http://lxr.mozilla.org/mozilla/source/js/src/js.msg</a><BR/>
>       </PARAM>
>       <PARAM name='*ucmessage' type='const jschar'>
>         Unicode error message.<BR/>
>       </PARAM>
>       <PARAM name='**messageArgs' type='const jschar'>
>         Pointer to the arguments for the error message <C>*ucmessage</C>.<BR/>
>       </PARAM>
4647c4689
<    jsint *lengthp);
---
>    jsuint *lengthp);
5242c5284
<       If it successfully creates properties for all the functions specified in the array, <C>JS_DefineFunctions</C> returns <C>JS_TRUE</C>. Otherwise it returns <C>JS_FALSE</C>.<P/>
---
>       <C>JS_DefineFunctions</C> always returns <C>JS_TRUE</C>, indicating it has created all functions specified in the array.<P/>

--------------080100020308060006030801--

.