commit f77798bbcb94b3162b7f834d22fa2b30d9f0b6ba
author Brian Osman <brianosman@google.com> Tue Jan 03 16:18:11 2023 -0500
committer SkCQ <skcq-be@skia-corp.google.com.iam.gserviceaccount.com> Tue Jan 03 22:17:35 2023 +0000
tree a9f91c5dd675d307cf4a5dbf028e582ccf993f4d
parent de83118cabbca6cc52f957d475b03ce4027b5389

Fix several outdated / incorrect comments in SkColorSpace

Change-Id: I21ce37126dd0ee52486c316b3b85580300c711be
Reviewed-on: https://skia-review.googlesource.com/c/skia/+/624727
Auto-Submit: Brian Osman <brianosman@google.com>
Commit-Queue: Robert Phillips <robertphillips@google.com>
Commit-Queue: Brian Osman <brianosman@google.com>
Reviewed-by: Robert Phillips <robertphillips@google.com>

include/core/SkColorSpace.h

diff --git a/include/core/SkColorSpace.h b/include/core/SkColorSpace.h
index f42557b..0ae65a5 100644
--- a/include/core/SkColorSpace.h
+++ b/include/core/SkColorSpace.h
@@ -150,8 +150,7 @@
     bool isNumericalTransferFn(skcms_TransferFunction* fn) const;
 
     /**
-     *  Returns true and sets |toXYZD50| if the color gamut can be described as a matrix.
-     *  Returns false otherwise.
+     *  Returns true and sets |toXYZD50|.
      */
     bool toXYZD50(skcms_Matrix3x3* toXYZD50) const;
 
@@ -163,23 +162,19 @@
 
     /**
      *  Returns a color space with the same gamut as this one, but with a linear gamma.
-     *  For color spaces whose gamut can not be described in terms of XYZ D50, returns
-     *  linear sRGB.
      */
     sk_sp<SkColorSpace> makeLinearGamma() const;
 
     /**
-     *  Returns a color space with the same gamut as this one, with with the sRGB transfer
-     *  function. For color spaces whose gamut can not be described in terms of XYZ D50, returns
-     *  sRGB.
+     *  Returns a color space with the same gamut as this one, but with the sRGB transfer
+     *  function.
      */
     sk_sp<SkColorSpace> makeSRGBGamma() const;
 
     /**
      *  Returns a color space with the same transfer function as this one, but with the primary
-     *  colors rotated. For any XYZ space, this produces a new color space that maps RGB to GBR
-     *  (when applied to a source), and maps RGB to BRG (when applied to a destination). For other
-     *  types of color spaces, returns nullptr.
+     *  colors rotated. In other words, this produces a new color space that maps RGB to GBR
+     *  (when applied to a source), and maps RGB to BRG (when applied to a destination).
      *
      *  This is used for testing, to construct color spaces that have severe and testable behavior.
      */
@@ -193,15 +188,14 @@
      *  in some cases: converting ICC fixed point to float, converting white point to D50,
      *  rounding decisions on transfer function and matrix.
      *
-     *  This does not consider a 2.2f exponential transfer function to be sRGB.  While these
+     *  This does not consider a 2.2f exponential transfer function to be sRGB. While these
      *  functions are similar (and it is sometimes useful to consider them together), this
      *  function checks for logical equality.
      */
     bool isSRGB() const;
 
     /**
-     *  Returns nullptr on failure.  Fails when we fallback to serializing ICC data and
-     *  the data is too large to serialize.
+     *  Returns a serialized representation of this color space.
      */
     sk_sp<SkData> serialize() const;
 
@@ -214,7 +208,7 @@
     static sk_sp<SkColorSpace> Deserialize(const void* data, size_t length);
 
     /**
-     *  If both are null, we return true.  If one is null and the other is not, we return false.
+     *  If both are null, we return true. If one is null and the other is not, we return false.
      *  If both are non-null, we do a deeper compare.
      */
     static bool Equals(const SkColorSpace*, const SkColorSpace*);