nsIAboutModule documentation outdated?

VERIFIED FIXED in mozilla1.8beta4

Status

()

Core
Networking
--
trivial
VERIFIED FIXED
13 years ago
12 years ago

People

(Reporter: Biesinger, Assigned: J.P.Klippel)

Tracking

Trunk
mozilla1.8beta4
Points:
---

Firefox Tracking Flags

(Not tracked)

Details

(URL)

Attachments

(1 attachment)

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...
Whiteboard: [good first bug]

Updated

13 years ago
Keywords: helpwanted
Target Milestone: --- → Future
(Assignee)

Comment 1

13 years ago
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.
(Assignee)

Comment 2

13 years ago
Created attachment 188846 [details] [diff] [review]
patch to adjust comment

patch to adjust comment
Attachment #188846 - Flags: review?(darin)

Updated

13 years ago
Attachment #188846 - Flags: review?(darin) → review+
(Assignee)

Updated

13 years ago
Attachment #188846 - Flags: superreview?(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?
Attachment #188846 - Flags: superreview?(bzbarsky) → superreview+

Updated

13 years ago
Attachment #188846 - Flags: approval1.8b4?

Updated

13 years ago
Attachment #188846 - Flags: approval1.8b4? → approval1.8b4+
Assignee: darin → jklippel
Checked in for 1.8b4.  Thanks for the patch!
Status: NEW → RESOLVED
Last Resolved: 13 years ago
Resolution: --- → FIXED
Target Milestone: Future → mozilla1.8beta4

Comment 5

12 years ago
V/fixed:

1.13	bzbarsky%mit.edu	2005-07-15 14:49	 	Update documentation. Bug 299851, patch by J.P.Klippel <jklippel@xtux.org>,
r=darin, sr=bzbarsky, a=bsmedberg
Status: RESOLVED → VERIFIED
Keywords: helpwanted
Whiteboard: [good first bug]
You need to log in before you can comment on or make changes to this bug.