252011 - Remove extra param in comments section for cancel() in nsIWebBrowserPrint.idl

Status: RESOLVED FIXED

(Core :: Printing: Output, defect)

Description

[David Epstein]

nsIWebBrowserPrint.idl:
There's no @param Cancel in cancel(); it has no parameters. 
The comment should be removed.

Comment 1

[Boris Zbarsky [:bzbarsky]]

To Elliot, per his request.

Comment 2

[Daniel Kraft]

Attachment: Removed comment

You thought of something like this?

Comment 3

[Boris Zbarsky [:bzbarsky]]

Daniel, in general more context makes patches easier to review... -up8 are good
options for making a diff.

Comment 4

[Daniel Kraft]

Of course, normally I use -u8, but not when just changing a comment...
(Or should I even then?)

Comment 5

[Boris Zbarsky [:bzbarsky]]

Well, I can't tell whether this change is correct, because I can't see the
function declaration in the diff, nor the rest of the comment... so yes, you
should use enough context to make the patch reviewable any time you make a
patch.  ;)

Comment 6

[Daniel Kraft]

Attachment: Context 8 lines

Oh, I see. That's reason enough...
Sorry!

Comment 7

[Boris Zbarsky [:bzbarsky]]

Comment on attachment 171649 [details] [diff] [review]
Context 8 lines

Ah, thank you.	r+sr=bzbarsky; I'll check this in when the tree opens.

Comment 8

[timeless]

Comment on attachment 171649 [details] [diff] [review]
Context 8 lines

>+   * Cancels the current print 
current print *what*?

It's best if the documentation be written in English.

Comment 9

[Daniel Kraft]

I'm sorry, but that's what already was present in the original file. Would you
prefer to see "the current print job" or something like that?

Comment 10

[Boris Zbarsky [:bzbarsky]]

Fixed for 1.8b.

Comment 11

[timeless]

i dunno, does it mean that? does it only cancel prints and not previews? if what
you wrote is what it means, then yes i'd rather see that.

Comment 12

[Daniel Kraft]

I also don't know what it means exactly. As I wrote, that is, what was already
present in the file. I've just removed the missplaced @param.