Fix comments after Blink rename

Fix comments after Blink rename

Blink recently went through a style guide change and renamed variables
and functions. However, comments were not updated. So when a comment
mentioned a variable or function, that comment became outdated.

This patch fixes comments inside Blink's image-decoders/.

BUG=717642
Review-Url: https://codereview.chromium.org/2856993002
Cr-Commit-Position: refs/heads/master@{#468936}
Committed: https://chromium.googlesource.com/chromium/src/+/41da09b543495010a2836b82ee7273d298183d47

[cblume, 2017-05-02 18:29:51]

Description was changed from

==========
Fix comments after Blink rename

Blink recently went through a style guide change and renamed variables
and functions. However, comments were not updated. So when a comment
mentioned a variable or function, that comment became outdated.

This patch fixes comments inside Blink's image-decoders/.
==========

to

==========
Fix comments after Blink rename

Blink recently went through a style guide change and renamed variables
and functions. However, comments were not updated. So when a comment
mentioned a variable or function, that comment became outdated.

This patch fixes comments inside Blink's image-decoders/.

BUG=717642
==========

[cblume, 2017-05-02 18:29:51]

cblume@chromium.org changed reviewers:
+ noel@chromium.org, pkasting@chromium.org, scroggo@google.com

[cblume, 2017-05-02 18:29:56]

The CQ bit was checked by cblume@chromium.org to run a CQ dry run

[commit-bot: I haz the power, 2017-05-02 18:30:47]

Dry run: CQ is trying da patch.

Follow status at:
https://chromium-cq-status.appspot.com/v2/patch-status/codereview.chromium.or...

[cblume, 2017-05-02 18:31:03]

PTAL

[cblume, 2017-05-02 18:41:20]

https://codereview.chromium.org/2856993002/diff/1/third_party/WebKit/Source/p...
File third_party/WebKit/Source/platform/image-decoders/bmp/BMPImageReader.h
(right):

https://codereview.chromium.org/2856993002/diff/1/third_party/WebKit/Source/p...
third_party/WebKit/Source/platform/image-decoders/bmp/BMPImageReader.h:83: //
Helper for decodeBMP() which will call either ProcessRLEData() or
I missed "decodeBMP()".

Also, RLE is capitals here in a function name but lower-case in the parameter
name. I'll check if that matches the new style.

https://codereview.chromium.org/2856993002/diff/1/third_party/WebKit/Source/p...
File third_party/WebKit/Source/platform/image-decoders/gif/GIFImageDecoder.cpp
(right):

https://codereview.chromium.org/2856993002/diff/1/third_party/WebKit/Source/p...
third_party/WebKit/Source/platform/image-decoders/gif/GIFImageDecoder.cpp:108:
// (frameContext->xOffset, frameContext->yOffset). There is no guarantee
I missed "frameContext".

But I'm curious if xOffset should instead become x_offset.

[scroggo_chromium, 2017-05-02 18:58:14]

scroggo@chromium.org changed reviewers:
+ scroggo@chromium.org

[scroggo_chromium, 2017-05-02 18:58:15]

lgtm

https://codereview.chromium.org/2856993002/diff/1/third_party/WebKit/Source/p...
File third_party/WebKit/Source/platform/image-decoders/ImageFrame.h (right):

https://codereview.chromium.org/2856993002/diff/1/third_party/WebKit/Source/p...
third_party/WebKit/Source/platform/image-decoders/ImageFrame.h:168: // set
aftera batch of changes was made.
after a*

(Also, "was made" sounds slightly awkward here. Maybe it should be "after a
batch of changes has been made"?)

[commit-bot: I haz the power, 2017-05-02 20:24:30]

The CQ bit was unchecked by commit-bot@chromium.org

[commit-bot: I haz the power, 2017-05-02 20:24:31]

Dry run: This issue passed the CQ dry run.

[cblume, 2017-05-02 20:31:06]

https://codereview.chromium.org/2856993002/diff/1/third_party/WebKit/Source/p...
File third_party/WebKit/Source/platform/image-decoders/ImageFrame.h (right):

https://codereview.chromium.org/2856993002/diff/1/third_party/WebKit/Source/p...
third_party/WebKit/Source/platform/image-decoders/ImageFrame.h:168: // set
aftera batch of changes was made.
On 2017/05/02 18:58:15, scroggo_chromium wrote:
> after a*
> 
> (Also, "was made" sounds slightly awkward here. Maybe it should be "after a
> batch of changes has been made"?)

Done.

https://codereview.chromium.org/2856993002/diff/1/third_party/WebKit/Source/p...
File third_party/WebKit/Source/platform/image-decoders/bmp/BMPImageReader.h
(right):

https://codereview.chromium.org/2856993002/diff/1/third_party/WebKit/Source/p...
third_party/WebKit/Source/platform/image-decoders/bmp/BMPImageReader.h:83: //
Helper for decodeBMP() which will call either ProcessRLEData() or
On 2017/05/02 18:41:19, cblume wrote:
> I missed "decodeBMP()".
> 
> Also, RLE is capitals here in a function name but lower-case in the parameter
> name. I'll check if that matches the new style.

The Google style guide suggests function names be like Rle instead of RLE.
https://google.github.io/styleguide/cppguide.html#Function_Names
I do not see any overrides in the Chromium or Blink style guides for this.

However, this is a bit more wide-spread since it also appears in type names such
as BMPImageReader (instead of BmpImageReader). Again, the Google style guide
seems to indicate it prefers BmpImageReader here. Although, it only indicates
that through an example and does not explicitly call it out like it does in the
Function Names section.
https://google.github.io/styleguide/cppguide.html#Type_Names

Anyway, because it is more widespread that should go in a separate CL. This CL
is just to update the comments which became mismatched.

I made a separate bug for this: https://crbug.com/717705
We can get to it later. It isn't important.

https://codereview.chromium.org/2856993002/diff/1/third_party/WebKit/Source/p...
File third_party/WebKit/Source/platform/image-decoders/gif/GIFImageDecoder.cpp
(right):

https://codereview.chromium.org/2856993002/diff/1/third_party/WebKit/Source/p...
third_party/WebKit/Source/platform/image-decoders/gif/GIFImageDecoder.cpp:108:
// (frameContext->xOffset, frameContext->yOffset). There is no guarantee
On 2017/05/02 18:41:19, cblume wrote:
> I missed "frameContext".
> 
> But I'm curious if xOffset should instead become x_offset.

The reason it was xOffset instead of x_offset is because GIFFrameContext is
inside GIFImageReader.h which did not get the Blink renaming update. It didn't
get this because it was not inside the blink namespace.

The image decoders and all their free functions should be inside the blink
namespace. Free functions should be in a nested anonymous namespace. Then we can
run the renaming tool to update GIFImageReader.h / .cpp.

This will happen in a separate CL, since this CL is only to update the
mismatched comments.
The bug for that is here: https://crbug.com/717697

[cblume, 2017-05-02 20:31:22]

The CQ bit was checked by cblume@chromium.org to run a CQ dry run

[commit-bot: I haz the power, 2017-05-02 20:31:54]

Dry run: CQ is trying da patch.

Follow status at:
https://chromium-cq-status.appspot.com/v2/patch-status/codereview.chromium.or...

[commit-bot: I haz the power, 2017-05-02 22:31:13]

The CQ bit was unchecked by commit-bot@chromium.org

[commit-bot: I haz the power, 2017-05-02 22:31:14]

Dry run: This issue passed the CQ dry run.

[Noel Gordon, 2017-05-03 00:38:17]

LGTM

https://codereview.chromium.org/2856993002/diff/20001/third_party/WebKit/Sour...
File third_party/WebKit/Source/platform/image-decoders/bmp/BMPImageDecoder.cpp
(right):

https://codereview.chromium.org/2856993002/diff/20001/third_party/WebKit/Sour...
third_party/WebKit/Source/platform/image-decoders/bmp/BMPImageDecoder.cpp:120:
*/
Maybe re-align this comment.

[cblume, 2017-05-03 09:15:18]

The CQ bit was checked by cblume@chromium.org

[cblume, 2017-05-03 09:15:19]

The patchset sent to the CQ was uploaded after l-g-t-m from
scroggo@chromium.org, noel@chromium.org
Link to the patchset: https://codereview.chromium.org/2856993002/#ps40001
(title: "Re-aligning comment")

[commit-bot: I haz the power, 2017-05-03 09:15:30]

CQ is trying da patch.

Follow status at:
https://chromium-cq-status.appspot.com/v2/patch-status/codereview.chromium.or...

[cblume, 2017-05-03 09:24:08]

https://codereview.chromium.org/2856993002/diff/20001/third_party/WebKit/Sour...
File third_party/WebKit/Source/platform/image-decoders/bmp/BMPImageDecoder.cpp
(right):

https://codereview.chromium.org/2856993002/diff/20001/third_party/WebKit/Sour...
third_party/WebKit/Source/platform/image-decoders/bmp/BMPImageDecoder.cpp:120:
*/
On 2017/05/03 00:38:16, noel gordon wrote:
> Maybe re-align this comment.

Done.

[commit-bot: I haz the power, 2017-05-03 11:05:10]

CQ is committing da patch.

Bot data: {"patchset_id": 40001, "attempt_start_ts": 1493802918796480,
"parent_rev": "e72a3130f14c931b19617f818945877e93059a15", "commit_rev":
"41da09b543495010a2836b82ee7273d298183d47"}

[commit-bot: I haz the power, 2017-05-03 11:05:20]

Description was changed from

==========
Fix comments after Blink rename

Blink recently went through a style guide change and renamed variables
and functions. However, comments were not updated. So when a comment
mentioned a variable or function, that comment became outdated.

This patch fixes comments inside Blink's image-decoders/.

BUG=717642
==========

to

==========
Fix comments after Blink rename

Blink recently went through a style guide change and renamed variables
and functions. However, comments were not updated. So when a comment
mentioned a variable or function, that comment became outdated.

This patch fixes comments inside Blink's image-decoders/.

BUG=717642

Review-Url: https://codereview.chromium.org/2856993002
Cr-Commit-Position: refs/heads/master@{#468936}
Committed:
https://chromium.googlesource.com/chromium/src/+/41da09b543495010a2836b82ee72...
==========

[commit-bot: I haz the power, 2017-05-03 11:05:22]

Committed patchset #3 (id:40001) as
https://chromium.googlesource.com/chromium/src/+/41da09b543495010a2836b82ee72...