1167831 - Document for XMLHttpRequest is wrong

Status: RESOLVED FIXED

(Developer Documentation Graveyard :: API: DOM, defect)

Description

[Zhenbo Li]

What did you do?
================
Visit https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest#init%28%29

What happened?
==============
Non-standard methods
init()

Initializes the object for use from C++ code.
Warning: This method must not be called from JavaScript.

[noscript] void init(
   in nsIPrincipal principal,
   in nsIScriptContext scriptContext,
   in nsPIDOMWindow ownerWindow
);

What should have happened?
==========================
In  dom/base/nsIXMLHttpRequest.idl
  [noscript] void init(in nsIPrincipal principal,
                       in nsIScriptContext scriptContext,
                       in nsIGlobalObject globalObject,
                       in nsIURI baseURI,
                       [optional] in nsILoadGroup loadGroup);


Is there anything else we should know?
======================================

Comment 1

[Eric Shepherd [:sheppy]]

The point here is that there are new arguments added to the init() method that are not yet documented.

Comment 2

[Eric Shepherd [:sheppy]]

I'll work on this. I will also rework this page into a modern layout documentation set based on MDN's current style guide.

Comment 4

[Jean-Yves Perrier [:teoli]]

:sheppy, any progress on this?

Comment 5

[Eric Shepherd [:sheppy]]

Updated the init() documentation here: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest#init%28%29 with the missing information.