38373 - nsIPluginManager::GetURL() documentation comment outdated

Status: RESOLVED FIXED

(Core Graveyard :: Plug-ins, defect, P3)

Description

[Braden]

It looks like this comment didn't get updated when nsIPluginManager::GetURL was
updated to support the new plugin stream API. The comment is nolonger accurate.

Assigning to amusil since it looks like he checked in the code change here.

Comment 1

[Alex Musil]

av owns plugins

Comment 2

[ekrock's old account (dead)]

Not a Netscape 6 RTM blocker. FUTURE. This bug has been marked Future because
the Netscape engineer it is assigned to is overburdened.

Comment 3

[rubydoo123]

marking wontfix - the "new" plug-in api (xpcom) is deprecated

Comment 4

[Braden]

The API may be deprecated, but that's not a good enough reason for a doc-comment
to be out of sync with reality.

Comment 5

[rubydoo123]

this api is deprecated, which means no one should use it, the real issue here is
that this file needs to be marked as deprecated, see bug 104299. We will not
modify the contents of a deprecated api

*** This bug has been marked as a duplicate of 104299 ***

Comment 6

[Braden]

This is certainly not a duplicate of bug 104299.

It does not matter that this API is deprecated. It does not matter that no one
should use it. It should *still* be correctly documented. This bug does *not*
call for an API change, as you suggest. It just calls for an API to be correctly
documented.

Comment 7

[rubydoo123]

Braden: this will either be marked as won't fix or a dup - take your pick, but
if you continue to alter the bug I will pursue having your privledges revoked

*** This bug has been marked as a duplicate of 104299 ***

Comment 8

[Braden]

beppe: I have a patch for this. Should I reopen and attach it here, or would you
like me to attach it to bug 104299?

Comment 9

[Braden]

And beppe, do not threaten me. Be polite. If we disagree on the resolution,
kindly say so and we can get opinions from the module owner and, if necessary,
drivers. But you have not produced a sound reason for not fixing this bug; so
WONTFIX is not appropriate. And it does not look like this problem is at all
likely to be fixed by resolving bug 104299/bug 83189.

Comment 10

[rubydoo123]

no threat just letting you know that we marked this bug appropraitely and that
it did not need to be reopened, and I am the default owner. 

Comment 11

[rubydoo123]

sorry, didn't see the patch comment - please attach the patch to the general
celan-up bug, that way we can ensure it will get included in the patch that we
are doing

Comment 12

[rubydoo123]

also the module owner, av, is part of the triage team (av, peterl, serge, shrir,
and myself)

Comment 13

[Braden]

No, beppe, you weren't "just letting me know". You couched your comment as a threat.

Furthermore, your comment, "We will not modify the contents of a deprecated
api," suggested that you really didn't understand what this bug was about. Had
you demonstrated a grasp of the issue here, I'm sure this could have been avoided.

The patch is on a different machine than I'm using at the moment; I'll attach it
to bug 83189 (that one, right?) tomorrow.

Comment 14

[Peter Lubczynski]

Braden,

If you feel so strongly about fixing this bug, then you please take care of it
and walk it through resolution.

Netscape has no more time to waste on fixing deprecated comments. In bug 83189
we're gona add big fat comments to the all these deprecated files and warn
people not to bother reading any further. In fact, we probably should just strip
all comments like on GetURL so as not to even tempt anyone in using these.

Comment 15

[Peter Lubczynski]

------>braden's bug

Comment 16

[Braden]

> If you feel so strongly about fixing this bug, then you please take care of it
> and walk it through resolution.

Good enough.

> Netscape has no more time to waste on fixing deprecated comments.

Then assign it to [e-mail]. Resolving a bug simply because Netscape
doesn't want to spend time on it is never appropriate.

> In fact, we probably should just strip all comments like on GetURL so as not
> to even tempt anyone in using these.

I agree that would be an acceptable way of fixing this. I don't care whether
this is done or the comment is fixed. Which would you prefer?

Comment 17

[rubydoo123]

that is precisely why we marked this as a dup f the clean-up bug, but in any
event Braden since this is now in your court so please feel free to handle it
the way you see fit. The general clean-up bug work will continue to add the
deprecated information as indicated.

Comment 18

[Braden]

beppe: Then why on earth didn't you say that from the outset???

Comment 19

[Braden]

Attachment: Patch to correct doc-comments.

Comment 20

[Braden]

The patch I've attached corrects the doc-comments for both GetURL and PostURL.

Comment 21

[Peter Lubczynski]

Comment on attachment 90786 [details] [diff] [review]
Patch to correct doc-comments.

thanks Braden! r=peterl

Comment 22

[Braden]

Peter: Thanks. Please check in as appropriate. (I don't have a CVS account.)

Comment 23

[Peter Lubczynski]

patch in trunk