Bug 69766 – Style guide should mandate use of pass-by-reference for out arguments

• Status: RESOLVED
• Resolution: FIXED
• Component: WebKit Website

[Ryosuke Niwa]

Per discussion on https://lists.webkit.org/pipermail/webkit-dev/2011-October/018143.html, we should mandate use of pass-by-reference for non-optional out arguments.

[Ryosuke Niwa]

Created attachment 110367 [details]
Patch

[Ryosuke Niwa]

Created attachment 110368 [details]
'get' prefix only applies to getters

[David Levin]

Comment on attachment 110368 [details]
'get' prefix only applies to getters

Per comment on webkit-dev.

[Ryosuke Niwa]

Comment on attachment 110368 [details]
'get' prefix only applies to getters

Ask for review again as this change is nothing to do with RefPtr or PassRefPtr as pointed out on webkit-dev.

[David Levin]

(In reply to comment #4)
> (From update of attachment 110368 [details])
> Ask for review again as this change is nothing to do with RefPtr or PassRefPtr as pointed out on webkit-dev.

Sorry about that. I just had remember this whole thing about RefPtr<>& and then continued to read this whole thing in that context.

[Darin Adler]

Comment on attachment 110368 [details]
'get' prefix only applies to getters

View in context: https://bugs.webkit.org/attachment.cgi?id=110368&action=review

Looks great to me.

> Websites/webkit.org/coding/coding-style.html:578
> +<li>Precede getters that return values through out arguments with the word "get".</li>

I don’t think the phrase “precede getters” is quite right. A getter is a function, not a function’s name, and the “get” is part of the name, so doesn’t precede it.

But since the earlier item says “precede setters”, it seems we can fix both together later.

I’d also use curly quotes instead of straight quotes around "get".

[Ryosuke Niwa]

(In reply to comment #5)
> (In reply to comment #4)
> > (From update of attachment 110368 [details] [details])
> > Ask for review again as this change is nothing to do with RefPtr or PassRefPtr as pointed out on webkit-dev.
> 
> Sorry about that. I just had remember this whole thing about RefPtr<>& and then continued to read this whole thing in that context.

Yeah, I figured. No worries :)

[Ryosuke Niwa]

(In reply to comment #6)
> (From update of attachment 110368 [details])
> View in context: https://bugs.webkit.org/attachment.cgi?id=110368&action=review
> > Websites/webkit.org/coding/coding-style.html:578
> > +<li>Precede getters that return values through out arguments with the word "get".</li>
> 
> I don’t think the phrase “precede getters” is quite right. A getter is a function, not a function’s name, and the “get” is part of the name, so doesn’t precede it.
> 
> But since the earlier item says “precede setters”, it seems we can fix both together later.

Agreed.

[Ryosuke Niwa]

Committed r97070: <http://trac.webkit.org/changeset/97070>

[Ryosuke Niwa]

Fixed a typo in http://trac.webkit.org/changeset/97111.