793918 - Missing JSContext* parameter and wrong return mechanism in JSAPI functions

Status: RESOLVED FIXED

(Developer Documentation Graveyard :: General, defect)

Description

[Norbert Lindenberg]

The documentation for at least the following functions is missing the JSContext* parameter that the actual API in jsapi.h requires:
https://developer.mozilla.org/en-US/docs/SpiderMonkey/JSAPI_Reference/JS_ConcatStrings
https://developer.mozilla.org/en-US/docs/SpiderMonkey/JSAPI_Reference/JS_CompareStrings
The last page has additional problems: It shows the function as returning an integer with the result of the comparison, while in reality that integer is returned via a jsval* argument, and the function's return value is a JSBool.

Comment 1

[Nikhil Marathe [:nsm] (No longer reading bugmail, please needinfo?)]

Fixed:

https://developer.mozilla.org/en-US/docs/SpiderMonkey/JSAPI_Reference/JS_ConcatStrings$revision/320641

https://developer.mozilla.org/en-US/docs/SpiderMonkey/JSAPI_Reference/JS_CompareStrings$revision/320643

Please comment if changes are satisfactory.

Comment 2

[Norbert Lindenberg]

Sorry, I was wrong about the jsval* argument - it's actually a int32_t*. The source to match here is really jsapi.h.

Comment 3

[Nikhil Marathe [:nsm] (No longer reading bugmail, please needinfo?)]

I feel quite stupid now :) I looked at the source and realised the int32_t, then came back and read this, and I'm used to JS_* functions taking jsvals as the last argument, so I went and put that.

Fixed now.

Comment 4

[Norbert Lindenberg]

The signatures look good to me now.