video-hdr: Update documentation
authorSeungha Yang <seungha.yang@navercorp.com>
Tue, 20 Aug 2019 12:10:45 +0000 (21:10 +0900)
committerSeungha Yang <seungha.yang@navercorp.com>
Tue, 20 Aug 2019 12:16:24 +0000 (21:16 +0900)
* Fix typo
s/nunormalized/normalized/g

* Update GstVideoMasteringDisplayInfo description
Each values are not array.

* Add missing newline between arguments description and
detailed comment.

gst-libs/gst/video/video-hdr.c
gst-libs/gst/video/video-hdr.h

index 46d449d..aaa6c39 100644 (file)
@@ -377,6 +377,7 @@ gst_video_content_light_level_from_string (GstVideoContentLightLevel *
 /**
  * gst_video_content_light_level_to_string:
  * @linfo: a #GstVideoContentLightLevel
+ *
  * Convert @linfo to its string representation.
  *
  * Returns: (transfer full): a string representation of @linfo.
index a0b92fd..5f982fb 100644 (file)
@@ -30,7 +30,7 @@ typedef struct _GstVideoContentLightLevel GstVideoContentLightLevel;
 
 /**
  * GstVideoMasteringDisplayInfo:
- * @Rx_n: the numerator of nunormalized red x coordinate as defined CIE 1931
+ * @Rx_n: the numerator of normalized red x coordinate as defined CIE 1931
  * @Rx_d: the denominator of normalized red x coordinate as defined CIE 1931
  * @Ry_n: the numerator of normalized red y coordinate as defined CIE 1931
  * @Ry_d: the denominator of normalized red y coordinate as defined CIE 1931
@@ -53,8 +53,8 @@ typedef struct _GstVideoContentLightLevel GstVideoContentLightLevel;
  *
  * Mastering display color volume information defined by SMPTE ST 2086
  * (a.k.a static HDR metadata).
- * Each array represent fraction value of red, green, blue, white
- * and min/max luma (the first element of an array is numerator).
+ * Each pair of *_d and *_n represents fraction value of red, green, blue, white
+ * and min/max luma.
  *
  * The decimal representation of each red, green, blue and white value should
  * be in the range of [0, 1].