904184 - gfx/tests/gtest/TestLayers.h:22:1: warning: multi-line comment [-Wcomment]

Status: RESOLVED FIXED

(Core :: Graphics: Layers, defect)

Description

[Daniel Holbert [:dholbert]]

I get several copies of these build warnings, when building mozilla-central with gcc 4.8:
> gfx/tests/gtest/TestLayers.h:22:1: warning: multi-line comment [-Wcomment]
> gfx/tests/gtest/TestLayers.h:24:1: warning: multi-line comment [-Wcomment]

The warning indicates that we have a "//" comment that ends with a "\", making the single-line comment continue onto the next line.

The "\" is actually part of an ASCII art picture.

We should just make this a C-style comment with /* ... */. That fixes this.

Comment 1

[Benoit Girard (:BenWa)]

IMO this warning isn't useful. I don't like /**/ because they don't nest very well.

Comment 2

[Daniel Holbert [:dholbert]]

Attachment: fix v1

Fixed with search-and-replace. (replacing "//" with " *" except on the first line of the comment, and added a final "*/" line)

Comment 3

[Benoit Girard (:BenWa)]

Comment on attachment 789085 [details] [diff] [review]
fix v1

I'm ok with this because I rather be warning clean over minimizing /**/ but I wouldn't mind if we disabled this warning.

Comment 4

[Daniel Holbert [:dholbert]]

https://hg.mozilla.org/integration/mozilla-inbound/rev/8da8c1e4ef9a

Comment 5

[Daniel Holbert [:dholbert]]

(In reply to Benoit Girard (:BenWa) from comment #3)
> I'm ok with this because I rather be warning clean over minimizing /**/ but
> I wouldn't mind if we disabled this warning.

(I'd be against disabling this warning, FWIW, since it also checks for /* within existing /**/ comment, which is more clearly-wrong and worth catching/fixing.)

Comment 6

[Daniel Holbert [:dholbert]]

(Not to mention: if the ascii-art "\" is in the *last* line of a comment, right before some code, you'll unintentionally be commenting out the first line of code.)

Comment 7

[Carsten Book [:Tomcat]]

https://hg.mozilla.org/mozilla-central/rev/8da8c1e4ef9a