299851 - nsIAboutModule documentation outdated?

Status: VERIFIED FIXED

(Core :: Networking, defect)

Description

[Christian :Biesinger (don't email me, ping me on IRC)]

52      * @param originalURI - Specifies the original URI which caused the creation
[...]
 59     nsIChannel newChannel(in nsIURI aURI);

There does not seem to be an originalURI parameter...

Comment 1

[J.P.Klippel]

nsIURI* originalURI was introduced to the interface in nsIAboutModule.idl rev.
1.4 and nsAboutProtocolHandler.cpp rev. 1.6 because of bug 17144.
It was removed from nsIAboutModule.idl rev. 1.9 on 2000-03-28 due to "Necko API
changes..." (see cvs log). The Necko API changes removed the parameter from
nsIProtocolHandler.idl::newChannel(...).

I can't figure out any use for the parameter in nsIAboutProtocolHandler.cpp back
then (it's probably just been there to stick to the inherited interface). (IMHO)
But that's history.

Looking at the nsAboutProtocolHandler::NewChannel current method even the part
of the comment saying that if null the aURI parameter will be used is invalid
with the current interface.

So I suggest removing the @param originalURI description completely.

Comment 2

[J.P.Klippel]

Attachment: patch to adjust comment

patch to adjust comment

Comment 3

[Boris Zbarsky [:bzbarsky]]

Comment on attachment 188846 [details] [diff] [review]
patch to adjust comment

Let me know once this has approvals if you want me to check it in, ok?

Comment 4

[Boris Zbarsky [:bzbarsky]]

Checked in for 1.8b4.  Thanks for the patch!

Comment 5

[benc]

V/fixed:

1.13	bzbarsky%mit.edu	2005-07-15 14:49	 	Update documentation. Bug 299851, patch by J.P.Klippel <[e-mail]>,
r=darin, sr=bzbarsky, a=bsmedberg