921512 - Properly document layers code

Status: RESOLVED DUPLICATE of bug 861377

(Core :: Graphics: Layers, defect)

Comment 1

[Nicolas Silva [:nical]]

Attachment: Document a few more texture client methods

Comment 2

[Benoit Jacob [:bjacob] (mostly away)]

Comment on attachment 811174 [details] [diff] [review]
Document a few more texture client methods

Review of attachment 811174 [details] [diff] [review]:
-----------------------------------------------------------------

::: gfx/layers/client/TextureClient.h
@@ +125,5 @@
>    virtual TextureClientSurface* AsTextureClientSurface() { return nullptr; }
>    virtual TextureClientYCbCr* AsTextureClientYCbCr() { return nullptr; }
>  
> +  /**
> +   * Always lock/unlock when accessing the shared data.

It is not clear if that is a statement about what that method does, or general advice to the reader.

@@ +126,5 @@
>    virtual TextureClientYCbCr* AsTextureClientYCbCr() { return nullptr; }
>  
> +  /**
> +   * Always lock/unlock when accessing the shared data.
> +   * if Lock() returns false, do not attempt to access the shared data.

Same.

@@ +142,3 @@
>  
> +  /**
> +   * An ID that is used to match a texture client with his corresponding TextureHost.

This refers to 'an id' which would be a piece of data, but here we have a method.

@@ +142,4 @@
>  
> +  /**
> +   * An ID that is used to match a texture client with his corresponding TextureHost.
> +   * Only the COmpositableClient should be allowed to set or clear the ID.

CO with uppercase O

Comment 3

[Nicolas Silva [:nical]]

fixed comments and landed
https://hg.mozilla.org/integration/mozilla-inbound/rev/b4a1b2767689

Comment 4

[Ryan VanderMeulen [:RyanVM]]

https://hg.mozilla.org/mozilla-central/rev/b4a1b2767689

Comment 5

[:Ms2ger (he/him; ⌚ UTC+1/+2)]

(In reply to Nicolas Silva [:nical] from comment #3)
> fixed comments and landed
> https://hg.mozilla.org/integration/mozilla-inbound/rev/b4a1b2767689

    1.12 -// A texture host that supports tiling
    1.13  const TextureFlags TEXTURE_FRONT              = 1 << 12;

That doesn't look like adding documentation.

Comment 6

[Nicolas Silva [:nical]]

(In reply to :Ms2ger from comment #5)
> (In reply to Nicolas Silva [:nical] from comment #3)
> > fixed comments and landed
> > https://hg.mozilla.org/integration/mozilla-inbound/rev/b4a1b2767689
> 
>     1.12 -// A texture host that supports tiling
>     1.13  const TextureFlags TEXTURE_FRONT              = 1 << 12;
> 
> That doesn't look like adding documentation.

Yeah, that comment was just wrong. Looks like a copy-past accident. The change was too small to get its own patch though.