diff options
| author | Mattias Andrée <maandree@operamail.com> | 2014-05-28 04:58:51 +0200 |
|---|---|---|
| committer | Mattias Andrée <maandree@operamail.com> | 2014-05-28 04:58:51 +0200 |
| commit | d8c194e3868ff7cc74e6b990e458a1814814c427 (patch) | |
| tree | 477fdd9e6cb21a2c67c62fbfb6d7565a4eb51c79 | |
| parent | on GAMMA_METHOD_MAX and GAMMA_METHOD_COUNT (diff) | |
| download | libgamma-d8c194e3868ff7cc74e6b990e458a1814814c427.tar.gz libgamma-d8c194e3868ff7cc74e6b990e458a1814814c427.tar.bz2 libgamma-d8c194e3868ff7cc74e6b990e458a1814814c427.tar.xz | |
change doc style to one appropriate for manuals
Signed-off-by: Mattias Andrée <maandree@operamail.com>
| -rw-r--r-- | src/edid.c | 4 | ||||
| -rw-r--r-- | src/edid.h | 4 | ||||
| -rw-r--r-- | src/gamma-dummy.c | 146 | ||||
| -rw-r--r-- | src/gamma-dummy.h | 146 | ||||
| -rw-r--r-- | src/gamma-helper.c | 60 | ||||
| -rw-r--r-- | src/gamma-helper.h | 82 | ||||
| -rw-r--r-- | src/gamma-linux-drm.c | 137 | ||||
| -rw-r--r-- | src/gamma-linux-drm.h | 82 | ||||
| -rw-r--r-- | src/gamma-quartz-cg.c | 84 | ||||
| -rw-r--r-- | src/gamma-quartz-cg.h | 82 | ||||
| -rw-r--r-- | src/gamma-w32-gdi.c | 82 | ||||
| -rw-r--r-- | src/gamma-w32-gdi.h | 84 | ||||
| -rw-r--r-- | src/gamma-x-randr.c | 166 | ||||
| -rw-r--r-- | src/gamma-x-randr.h | 84 | ||||
| -rw-r--r-- | src/gamma-x-vidmode.c | 82 | ||||
| -rw-r--r-- | src/gamma-x-vidmode.h | 84 | ||||
| -rw-r--r-- | src/libgamma-error.c | 4 | ||||
| -rw-r--r-- | src/libgamma-error.h | 96 | ||||
| -rw-r--r-- | src/libgamma-facade.c | 270 | ||||
| -rw-r--r-- | src/libgamma-facade.h | 290 | ||||
| -rw-r--r-- | src/libgamma-method.c | 80 | ||||
| -rw-r--r-- | src/libgamma-method.h | 276 |
22 files changed, 1213 insertions, 1212 deletions
@@ -24,13 +24,13 @@ /** - * Parse the EDID of a monitor + * Parse the EDID of a monitor. * * @param this Instance of a data structure to fill with the information about the EDID. * It must contain the EDID and its length. * @param feilds OR:ed identifiers for the information about the EDID that should be parsed. * Fields that do not have to do with EDID are ignored. - * @return Non-zero on error + * @return Non-zero on error. */ int libgamma_parse_edid(libgamma_crtc_information_t* restrict this, int32_t fields) { @@ -24,13 +24,13 @@ /** - * Parse the EDID of a monitor + * Parse the EDID of a monitor. * * @param this Instance of a data structure to fill with the information about the EDID. * It must contain the EDID and its length. * @param feilds OR:ed identifiers for the information about the EDID that should be parsed. * Fields that do not have to do with EDID are ignored. - * @return Non-zero on error + * @return Non-zero on error. */ int libgamma_parse_edid(libgamma_crtc_information_t* restrict out, int32_t fields); diff --git a/src/gamma-dummy.c b/src/gamma-dummy.c index d35e3bb..03f7f33 100644 --- a/src/gamma-dummy.c +++ b/src/gamma-dummy.c @@ -25,9 +25,9 @@ /** - * Return the capabilities of the adjustment method + * Return the capabilities of the adjustment method. * - * @param this The data structure to fill with the method's capabilities + * @param this The data structure to fill with the method's capabilities. */ void libgamma_dummy_method_capabilities(libgamma_method_capabilities_t* restrict this) { @@ -35,9 +35,9 @@ void libgamma_dummy_method_capabilities(libgamma_method_capabilities_t* restrict /** - * Initialise an allocated site state + * Initialise an allocated site state. * - * @param this The site state to initialise + * @param this The site state to initialise. * @param site The site identifier, unless it is `NULL` it must a * `free`:able. One the state is destroyed the library * will attempt to free it. There you should not free @@ -45,7 +45,7 @@ void libgamma_dummy_method_capabilities(libgamma_method_capabilities_t* restrict * or allocate on the stack. Note however that it will * not be free:d if this function fails. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_dummy_site_initialise(libgamma_site_state_t* restrict this, char* restrict site) @@ -54,9 +54,9 @@ int libgamma_dummy_site_initialise(libgamma_site_state_t* restrict this, /** - * Release all resources held by a site state + * Release all resources held by a site state. * - * @param this The site state + * @param this The site state. */ void libgamma_dummy_site_destroy(libgamma_site_state_t* restrict this) { @@ -64,11 +64,11 @@ void libgamma_dummy_site_destroy(libgamma_site_state_t* restrict this) /** - * Restore the gamma ramps all CRTCS with a site to the system settings + * Restore the gamma ramps all CRTC:s with a site to the system settings. * - * @param this The site state + * @param this The site state. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_dummy_site_restore(libgamma_site_state_t* restrict this) { @@ -77,13 +77,13 @@ int libgamma_dummy_site_restore(libgamma_site_state_t* restrict this) /** - * Initialise an allocated partition state + * Initialise an allocated partition state. * - * @param this The partition state to initialise + * @param this The partition state to initialise. * @param site The site state for the site that the partition belongs to - * @param partition The the index of the partition within the site + * @param partition The the index of the partition within the site. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_dummy_partition_initialise(libgamma_partition_state_t* restrict this, libgamma_site_state_t* restrict site, size_t partition) @@ -92,9 +92,9 @@ int libgamma_dummy_partition_initialise(libgamma_partition_state_t* restrict thi /** - * Release all resources held by a partition state + * Release all resources held by a partition state. * - * @param this The partition state + * @param this The partition state. */ void libgamma_dummy_partition_destroy(libgamma_partition_state_t* restrict this) { @@ -102,11 +102,11 @@ void libgamma_dummy_partition_destroy(libgamma_partition_state_t* restrict this) /** - * Restore the gamma ramps all CRTCS with a partition to the system settings + * Restore the gamma ramps all CRTC:s with a partition to the system settings. * - * @param this The partition state + * @param this The partition state. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_dummy_partition_restore(libgamma_partition_state_t* restrict this) { @@ -115,13 +115,13 @@ int libgamma_dummy_partition_restore(libgamma_partition_state_t* restrict this) /** - * Initialise an allocated CRTC state + * Initialise an allocated CRTC state. * - * @param this The CRTC state to initialise - * @param partition The partition state for the partition that the CRTC belongs to - * @param crtc The the index of the CRTC within the site + * @param this The CRTC state to initialise. + * @param partition The partition state for the partition that the CRTC belongs to. + * @param crtc The the index of the CRTC within the site. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_dummy_crtc_initialise(libgamma_crtc_state_t* restrict this, libgamma_partition_state_t* restrict partition, size_t crtc) @@ -130,9 +130,9 @@ int libgamma_dummy_crtc_initialise(libgamma_crtc_state_t* restrict this, /** - * Release all resources held by a CRTC state + * Release all resources held by a CRTC state. * - * @param this The CRTC state + * @param this The CRTC state. */ void libgamma_dummy_crtc_destroy(libgamma_crtc_state_t* restrict this) { @@ -140,11 +140,11 @@ void libgamma_dummy_crtc_destroy(libgamma_crtc_state_t* restrict this) /** - * Restore the gamma ramps for a CRTC to the system settings for that CRTC + * Restore the gamma ramps for a CRTC to the system settings for that CRTC. * - * @param this The CRTC state + * @param this The CRTC state. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_dummy_crtc_restore(libgamma_crtc_state_t* restrict this) { @@ -153,11 +153,11 @@ int libgamma_dummy_crtc_restore(libgamma_crtc_state_t* restrict this) /** - * Read information about a CRTC + * Read information about a CRTC. * - * @param this Instance of a data structure to fill with the information about the CRTC - * @param crtc The state of the CRTC whose information should be read - * @param fields OR:ed identifiers for the information about the CRTC that should be read + * @param this Instance of a data structure to fill with the information about the CRTC. + * @param crtc The state of the CRTC whose information should be read. + * @param fields OR:ed identifiers for the information about the CRTC that should be read. * @return Zero on success, -1 on error. On error refer to the error reports in `this`. */ int libgamma_dummy_get_crtc_information(libgamma_crtc_information_t* restrict this, @@ -167,12 +167,12 @@ int libgamma_dummy_get_crtc_information(libgamma_crtc_information_t* restrict th /** - * Get current the gamma ramps for a CRTC, 16-bit gamma-depth version + * Get current the gamma ramps for a CRTC, 16-bit gamma-depth version. * - * @param this The CRTC state - * @param ramps The gamma ramps to fill with the current values + * @param this The CRTC state. + * @param ramps The gamma ramps to fill with the current values. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_dummy_crtc_get_gamma_ramps(libgamma_crtc_state_t* restrict this, libgamma_gamma_ramps_t* restrict ramps) @@ -181,12 +181,12 @@ int libgamma_dummy_crtc_get_gamma_ramps(libgamma_crtc_state_t* restrict this, /** - * Set the gamma ramps for a CRTC, 16-bit gamma-depth version + * Set the gamma ramps for a CRTC, 16-bit gamma-depth version. * - * @param this The CRTC state - * @param ramps The gamma ramps to apply + * @param this The CRTC state. + * @param ramps The gamma ramps to apply. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_dummy_crtc_set_gamma_ramps(libgamma_crtc_state_t* restrict this, libgamma_gamma_ramps_t ramps) @@ -196,12 +196,12 @@ int libgamma_dummy_crtc_set_gamma_ramps(libgamma_crtc_state_t* restrict this, /** - * Get current the gamma ramps for a CRTC, 32-bit gamma-depth version + * Get current the gamma ramps for a CRTC, 32-bit gamma-depth version. * - * @param this The CRTC state - * @param ramps The gamma ramps to fill with the current values + * @param this The CRTC state. + * @param ramps The gamma ramps to fill with the current values. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_dummy_crtc_get_gamma_ramps32(libgamma_crtc_state_t* restrict this, libgamma_gamma_ramps32_t* restrict ramps) @@ -210,12 +210,12 @@ int libgamma_dummy_crtc_get_gamma_ramps32(libgamma_crtc_state_t* restrict this, /** - * Set the gamma ramps for a CRTC, 32-bit gamma-depth version + * Set the gamma ramps for a CRTC, 32-bit gamma-depth version. * - * @param this The CRTC state - * @param ramps The gamma ramps to apply + * @param this The CRTC state. + * @param ramps The gamma ramps to apply. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_dummy_crtc_set_gamma_ramps32(libgamma_crtc_state_t* restrict this, libgamma_gamma_ramps32_t ramps) @@ -225,12 +225,12 @@ int libgamma_dummy_crtc_set_gamma_ramps32(libgamma_crtc_state_t* restrict this, /** - * Get current the gamma ramps for a CRTC, 64-bit gamma-depth version + * Get current the gamma ramps for a CRTC, 64-bit gamma-depth version. * - * @param this The CRTC state - * @param ramps The gamma ramps to fill with the current values + * @param this The CRTC state. + * @param ramps The gamma ramps to fill with the current values. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_dummy_crtc_get_gamma_ramps64(libgamma_crtc_state_t* restrict this, libgamma_gamma_ramps64_t* restrict ramps) @@ -239,12 +239,12 @@ int libgamma_dummy_crtc_get_gamma_ramps64(libgamma_crtc_state_t* restrict this, /** - * Set the gamma ramps for a CRTC, 64-bit gamma-depth version + * Set the gamma ramps for a CRTC, 64-bit gamma-depth version. * - * @param this The CRTC state - * @param ramps The gamma ramps to apply + * @param this The CRTC state. + * @param ramps The gamma ramps to apply. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_dummy_crtc_set_gamma_ramps64(libgamma_crtc_state_t* restrict this, libgamma_gamma_ramps64_t ramps) @@ -254,12 +254,12 @@ int libgamma_dummy_crtc_set_gamma_ramps64(libgamma_crtc_state_t* restrict this, /** - * Get current the gamma ramps for a CRTC, `float` version + * Get current the gamma ramps for a CRTC, `float` version. * - * @param this The CRTC state - * @param ramps The gamma ramps to fill with the current values + * @param this The CRTC state. + * @param ramps The gamma ramps to fill with the current values. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_dummy_crtc_get_gamma_rampsf(libgamma_crtc_state_t* restrict this, libgamma_gamma_rampsf_t* restrict ramps) @@ -268,12 +268,12 @@ int libgamma_dummy_crtc_get_gamma_rampsf(libgamma_crtc_state_t* restrict this, /** - * Set the gamma ramps for a CRTC, `float` version + * Set the gamma ramps for a CRTC, `float` version. * - * @param this The CRTC state - * @param ramps The gamma ramps to apply + * @param this The CRTC state. + * @param ramps The gamma ramps to apply. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_dummy_crtc_set_gamma_rampsf(libgamma_crtc_state_t* restrict this, libgamma_gamma_rampsf_t ramps) @@ -282,12 +282,12 @@ int libgamma_dummy_crtc_set_gamma_rampsf(libgamma_crtc_state_t* restrict this, /** - * Get current the gamma ramps for a CRTC, `double` version + * Get current the gamma ramps for a CRTC, `double` version. * - * @param this The CRTC state - * @param ramps The gamma ramps to fill with the current values + * @param this The CRTC state. + * @param ramps The gamma ramps to fill with the current values. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_dummy_crtc_get_gamma_rampsd(libgamma_crtc_state_t* restrict this, libgamma_gamma_rampsd_t* restrict ramps) @@ -296,12 +296,12 @@ int libgamma_dummy_crtc_get_gamma_rampsd(libgamma_crtc_state_t* restrict this, /** - * Set the gamma ramps for a CRTC, `double` version + * Set the gamma ramps for a CRTC, `double` version. * - * @param this The CRTC state - * @param ramps The gamma ramps to apply + * @param this The CRTC state. + * @param ramps The gamma ramps to apply. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_dummy_crtc_set_gamma_rampsd(libgamma_crtc_state_t* restrict this, libgamma_gamma_rampsd_t ramps) diff --git a/src/gamma-dummy.h b/src/gamma-dummy.h index e7733f5..bbdda5c 100644 --- a/src/gamma-dummy.h +++ b/src/gamma-dummy.h @@ -27,16 +27,16 @@ /** - * Return the capabilities of the adjustment method + * Return the capabilities of the adjustment method. * - * @param this The data structure to fill with the method's capabilities + * @param this The data structure to fill with the method's capabilities. */ void libgamma_dummy_method_capabilities(libgamma_method_capabilities_t* restrict this); /** - * Initialise an allocated site state + * Initialise an allocated site state. * - * @param this The site state to initialise + * @param this The site state to initialise. * @param site The site identifier, unless it is `NULL` it must a * `free`:able. One the state is destroyed the library * will attempt to free it. There you should not free @@ -44,206 +44,206 @@ void libgamma_dummy_method_capabilities(libgamma_method_capabilities_t* restrict * or allocate on the stack. Note however that it will * not be free:d if this function fails. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_dummy_site_initialise(libgamma_site_state_t* restrict this, char* restrict site); /** - * Release all resources held by a site state + * Release all resources held by a site state. * - * @param this The site state + * @param this The site state. */ void libgamma_dummy_site_destroy(libgamma_site_state_t* restrict this); /** - * Restore the gamma ramps all CRTCS with a site to the system settings + * Restore the gamma ramps all CRTC:s with a site to the system settings. * - * @param this The site state + * @param this The site state. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_dummy_site_restore(libgamma_site_state_t* restrict this); /** - * Initialise an allocated partition state + * Initialise an allocated partition state. * - * @param this The partition state to initialise - * @param site The site state for the site that the partition belongs to + * @param this The partition state to initialise. + * @param site The site state for the site that the partition belongs to. * @param partition The the index of the partition within the site * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_dummy_partition_initialise(libgamma_partition_state_t* restrict this, libgamma_site_state_t* restrict site, size_t partition); /** - * Release all resources held by a partition state + * Release all resources held by a partition state. * - * @param this The partition state + * @param this The partition state. */ void libgamma_dummy_partition_destroy(libgamma_partition_state_t* restrict this); /** - * Restore the gamma ramps all CRTCS with a partition to the system settings + * Restore the gamma ramps all CRTC:s with a partition to the system settings. * - * @param this The partition state + * @param this The partition state. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_dummy_partition_restore(libgamma_partition_state_t* restrict this); /** - * Initialise an allocated CRTC state + * Initialise an allocated CRTC state. * - * @param this The CRTC state to initialise - * @param partition The partition state for the partition that the CRTC belongs to - * @param crtc The the index of the CRTC within the site + * @param this The CRTC state to initialise. + * @param partition The partition state for the partition that the CRTC belongs to. + * @param crtc The the index of the CRTC within the site. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_dummy_crtc_initialise(libgamma_crtc_state_t* restrict this, libgamma_partition_state_t* restrict partition, size_t crtc); /** - * Release all resources held by a CRTC state + * Release all resources held by a CRTC state. * - * @param this The CRTC state + * @param this The CRTC state. */ void libgamma_dummy_crtc_destroy(libgamma_crtc_state_t* restrict this); /** - * Restore the gamma ramps for a CRTC to the system settings for that CRTC + * Restore the gamma ramps for a CRTC to the system settings for that CRTC. * - * @param this The CRTC state + * @param this The CRTC state. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_dummy_crtc_restore(libgamma_crtc_state_t* restrict this); /** - * Read information about a CRTC + * Read information about a CRTC. * - * @param this Instance of a data structure to fill with the information about the CRTC - * @param crtc The state of the CRTC whose information should be read - * @param fields OR:ed identifiers for the information about the CRTC that should be read + * @param this Instance of a data structure to fill with the information about the CRTC. + * @param crtc The state of the CRTC whose information should be read. + * @param fields OR:ed identifiers for the information about the CRTC that should be read. * @return Zero on success, -1 on error. On error refer to the error reports in `this`. */ int libgamma_dummy_get_crtc_information(libgamma_crtc_information_t* restrict this, libgamma_crtc_state_t* restrict crtc, int32_t fields); /** - * Get current the gamma ramps for a CRTC, 16-bit gamma-depth version + * Get current the gamma ramps for a CRTC, 16-bit gamma-depth version. * - * @param this The CRTC state - * @param ramps The gamma ramps to fill with the current values + * @param this The CRTC state. + * @param ramps The gamma ramps to fill with the current values. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_dummy_crtc_get_gamma_ramps(libgamma_crtc_state_t* restrict this, libgamma_gamma_ramps_t* restrict ramps); /** - * Set the gamma ramps for a CRTC, 16-bit gamma-depth version + * Set the gamma ramps for a CRTC, 16-bit gamma-depth version. * - * @param this The CRTC state - * @param ramps The gamma ramps to apply + * @param this The CRTC state. + * @param ramps The gamma ramps to apply. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_dummy_crtc_set_gamma_ramps(libgamma_crtc_state_t* restrict this, libgamma_gamma_ramps_t ramps); /** - * Get current the gamma ramps for a CRTC, 32-bit gamma-depth version + * Get current the gamma ramps for a CRTC, 32-bit gamma-depth version. * - * @param this The CRTC state - * @param ramps The gamma ramps to fill with the current values + * @param this The CRTC state. + * @param ramps The gamma ramps to fill with the current values. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_dummy_crtc_get_gamma_ramps32(libgamma_crtc_state_t* restrict this, libgamma_gamma_ramps32_t* restrict ramps); /** - * Set the gamma ramps for a CRTC, 32-bit gamma-depth version + * Set the gamma ramps for a CRTC, 32-bit gamma-depth version. * - * @param this The CRTC state - * @param ramps The gamma ramps to apply + * @param this The CRTC state. + * @param ramps The gamma ramps to apply. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_dummy_crtc_set_gamma_ramps32(libgamma_crtc_state_t* restrict this, libgamma_gamma_ramps32_t ramps); /** - * Get current the gamma ramps for a CRTC, 64-bit gamma-depth version + * Get current the gamma ramps for a CRTC, 64-bit gamma-depth version. * - * @param this The CRTC state - * @param ramps The gamma ramps to fill with the current values + * @param this The CRTC state. + * @param ramps The gamma ramps to fill with the current values. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_dummy_crtc_get_gamma_ramps64(libgamma_crtc_state_t* restrict this, libgamma_gamma_ramps64_t* restrict ramps); /** - * Set the gamma ramps for a CRTC, 64-bit gamma-depth version + * Set the gamma ramps for a CRTC, 64-bit gamma-depth version. * - * @param this The CRTC state - * @param ramps The gamma ramps to apply + * @param this The CRTC state. + * @param ramps The gamma ramps to apply. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_dummy_crtc_set_gamma_ramps64(libgamma_crtc_state_t* restrict this, libgamma_gamma_ramps64_t ramps); /** - * Get current the gamma ramps for a CRTC, `float` version + * Get current the gamma ramps for a CRTC, `float` version. * - * @param this The CRTC state - * @param ramps The gamma ramps to fill with the current values + * @param this The CRTC state. + * @param ramps The gamma ramps to fill with the current values. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_dummy_crtc_get_gamma_rampsf(libgamma_crtc_state_t* restrict this, libgamma_gamma_rampsf_t* restrict ramps); /** - * Set the gamma ramps for a CRTC, `float` version + * Set the gamma ramps for a CRTC, `float` version. * - * @param this The CRTC state - * @param ramps The gamma ramps to apply + * @param this The CRTC state. + * @param ramps The gamma ramps to apply. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_dummy_crtc_set_gamma_rampsf(libgamma_crtc_state_t* restrict this, libgamma_gamma_rampsf_t ramps); /** - * Get current the gamma ramps for a CRTC, `double` version + * Get current the gamma ramps for a CRTC, `double` version. * - * @param this The CRTC state - * @param ramps The gamma ramps to fill with the current values + * @param this The CRTC state. + * @param ramps The gamma ramps to fill with the current values. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_dummy_crtc_get_gamma_rampsd(libgamma_crtc_state_t* restrict this, libgamma_gamma_rampsd_t* restrict ramps); /** - * Set the gamma ramps for a CRTC, `double` version + * Set the gamma ramps for a CRTC, `double` version. * - * @param this The CRTC state - * @param ramps The gamma ramps to apply + * @param this The CRTC state. + * @param ramps The gamma ramps to apply. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_dummy_crtc_set_gamma_rampsd(libgamma_crtc_state_t* restrict this, libgamma_gamma_rampsd_t ramps); diff --git a/src/gamma-helper.c b/src/gamma-helper.c index 5d73b02..69f81ea 100644 --- a/src/gamma-helper.c +++ b/src/gamma-helper.c @@ -29,12 +29,12 @@ /** - * Convert any set of gamma ramps into a 64-bit integer array with all channels + * Convert any set of gamma ramps into a 64-bit integer array with all channels. * - * @param depth The depth of the gamma ramp, `-1` for `float`, `-2` for `double` - * @param n The grand size of gamma ramps (sum of all channels' sizes) - * @param out Output array - * @param in Input gamma ramps + * @param depth The depth of the gamma ramp, `-1` for `float`, `-2` for `double`. + * @param n The grand size of gamma ramps (sum of all channels' sizes.) + * @param out Output array. + * @param in Input gamma ramps. */ static void translate_to_64(signed depth, size_t n, uint64_t* restrict out, libgamma_gamma_ramps_any_t in) { @@ -74,12 +74,12 @@ static void translate_to_64(signed depth, size_t n, uint64_t* restrict out, libg /** - * Undo the actions of `translate_to_64` + * Undo the actions of `translate_to_64`. * - * @param depth The depth of the gamma ramp, `-1` for `float`, `-2` for `double` - * @param n The grand size of gamma ramps (sum of all channels' sizes) - * @param out Output gamma ramps - * @param in Input array, may be modified + * @param depth The depth of the gamma ramp, `-1` for `float`, `-2` for `double`. + * @param n The grand size of gamma ramps (sum of all channels' sizes.) + * @param out Output gamma ramps. + * @param in Input array, may be modified. */ static void translate_from_64(signed depth, size_t n, libgamma_gamma_ramps_any_t out, uint64_t* restrict in) { @@ -122,15 +122,15 @@ static void translate_from_64(signed depth, size_t n, libgamma_gamma_ramps_any_t /** - * Allocate and initalise a gamma ramp with any depth + * Allocate and initalise a gamma ramp with any depth. * - * @param ramps_sys Output gamma ramps - * @param ramps The gamma ramps whose sizes should be duplicated + * @param ramps_sys Output gamma ramps. + * @param ramps The gamma ramps whose sizes should be duplicated. * @param depth The depth of the gamma ramps to allocate, - * `-1` for `float`, `-2` for `double` - * @param elements Output reference for the grand size of the gamma ramps + * `-1` for `float`, `-2` for `double`. + * @param elements Output reference for the grand size of the gamma ramps. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ static int allocated_any_ramp(libgamma_gamma_ramps_any_t* restrict ramps_sys, libgamma_gamma_ramps_any_t ramps, signed depth, size_t* restrict elements) @@ -163,19 +163,19 @@ static int allocated_any_ramp(libgamma_gamma_ramps_any_t* restrict ramps_sys, /** - * Get current the gamma ramps for a CRTC, re-encoding version + * Get current the gamma ramps for a CRTC, re-encoding version. * - * @param this The CRTC state - * @param ramps The gamma ramps to fill with the current values + * @param this The CRTC state. + * @param ramps The gamma ramps to fill with the current values. * @param depth_user The depth of the gamma ramps that are provided by the user, - * `-1` for `float`, `-2` for `double` + * `-1` for `float`, `-2` for `double`. * @param depth_system The depth of the gamma ramps as required by the adjustment method, - * `-1` for `float`, `-2` for `double` + * `-1` for `float`, `-2` for `double`. * @param fun Function that is to be used read the ramps, its parameters have * the same function as those of this function with the same names, - * and the return value too is identical + * and the return value too is identical. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_translated_ramp_get_(libgamma_crtc_state_t* restrict this, libgamma_gamma_ramps_any_t* restrict ramps, @@ -212,19 +212,19 @@ int libgamma_translated_ramp_get_(libgamma_crtc_state_t* restrict this, /** - * Set the gamma ramps for a CRTC, re-encoding version + * Set the gamma ramps for a CRTC, re-encoding version. * - * @param this The CRTC state - * @param ramps The gamma ramps to apply + * @param this The CRTC state. + * @param ramps The gamma ramps to apply. * @param depth_user The depth of the gamma ramps that are provided by the user, - * `-1` for `float`, `-2` for `double` + * `-1` for `float`, `-2` for `double`. * @param depth_system The depth of the gamma ramps as required by the adjustment method, - * `-1` for `float`, `-2` for `double` + * `-1` for `float`, `-2` for `double`. * @param fun Function that is to be used write the ramps, its parameters have * the same function as those of this function with the same names, - * and the return value too is identical + * and the return value too is identical. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_translated_ramp_set_(libgamma_crtc_state_t* restrict this, libgamma_gamma_ramps_any_t ramps, diff --git a/src/gamma-helper.h b/src/gamma-helper.h index 1cd65f0..e0711ff 100644 --- a/src/gamma-helper.h +++ b/src/gamma-helper.h @@ -23,32 +23,32 @@ /** - * Gamma ramp structure union for different depths + * Gamma ramp structure union for different depths. */ typedef union libgamma_gamma_ramps_any { /** - * 16-bit gamma ramps + * 16-bit gamma ramps. */ libgamma_gamma_ramps_t bits16; /** - * 32-bit gamma ramps + * 32-bit gamma ramps. */ libgamma_gamma_ramps32_t bits32; /** - * 64-bit gamma ramps + * 64-bit gamma ramps. */ libgamma_gamma_ramps64_t bits64; /** - * Single precision float gamma ramps + * Single precision float gamma ramps. */ libgamma_gamma_rampsf_t float_single; /** - * Double precision float gamma ramps + * Double precision float gamma ramps. */ libgamma_gamma_rampsd_t float_double; @@ -56,23 +56,23 @@ typedef union libgamma_gamma_ramps_any /** - * A function for reading the gamma ramps from a CRTC + * A function for reading the gamma ramps from a CRTC. * - * @param this The CRTC state - * @param ramps The store for the gamma ramps + * @param this The CRTC state. + * @param ramps The store for the gamma ramps. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ typedef int libgamma_get_ramps_any_fun(libgamma_crtc_state_t* restrict this, libgamma_gamma_ramps_any_t* restrict ramps); /** - * A function for writing the gamma ramps to a CRTC + * A function for writing the gamma ramps to a CRTC. * - * @param this The CRTC state - * @param ramps The gamma ramps + * @param this The CRTC state. + * @param ramps The gamma ramps. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ typedef int libgamma_set_ramps_any_fun(libgamma_crtc_state_t* restrict this, libgamma_gamma_ramps_any_t ramps); @@ -80,19 +80,19 @@ typedef int libgamma_set_ramps_any_fun(libgamma_crtc_state_t* restrict this, /** - * Get current the gamma ramps for a CRTC, re-encoding version + * Get current the gamma ramps for a CRTC, re-encoding versio.n * - * @param this The CRTC state - * @param ramps The gamma ramps to fill with the current values + * @param this The CRTC state. + * @param ramps The gamma ramps to fill with the current values. * @param depth_user The depth of the gamma ramps that are provided by the user, - * `-1` for `float`, `-2` for `double` + * `-1` for `float`, `-2` for `double`. * @param depth_system The depth of the gamma ramps as required by the adjustment method, - * `-1` for `float`, `-2` for `double` + * `-1` for `float`, `-2` for `double`. * @param fun Function that is to be used read the ramps, its parameters have * the same function as those of this function with the same names, - * and the return value too is identical + * and the return value too is identical. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ #define libgamma_translated_ramp_get(this, ramps, depth_user, depth_system, fun) \ libgamma_translated_ramp_get_(this, ramps, depth_user, depth_system, \ @@ -102,17 +102,17 @@ typedef int libgamma_set_ramps_any_fun(libgamma_crtc_state_t* restrict this, /** * Set the gamma ramps for a CRTC, re-encoding version * - * @param this The CRTC state - * @param ramps The gamma ramps to apply + * @param this The CRTC state. + * @param ramps The gamma ramps to apply. * @param depth_user The depth of the gamma ramps that are provided by the user, - * `-1` for `float`, `-2` for `double` + * `-1` for `float`, `-2` for `double`. * @param depth_system The depth of the gamma ramps as required by the adjustment method, - * `-1` for `float`, `-2` for `double` + * `-1` for `float`, `-2` for `double`. * @param fun Function that is to be used write the ramps, its parameters have * the same function as those of this function with the same names, - * and the return value too is identical + * and the return value too is identical. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ #define libgamma_translated_ramp_set(this, ramps, depth_user, depth_system, fun) \ libgamma_translated_ramp_set_(this, ramps, depth_user, depth_system, \ @@ -120,19 +120,19 @@ typedef int libgamma_set_ramps_any_fun(libgamma_crtc_state_t* restrict this, /** - * Get current the gamma ramps for a CRTC, re-encoding version + * Get current the gamma ramps for a CRTC, re-encoding version. * - * @param this The CRTC state - * @param ramps The gamma ramps to fill with the current values + * @param this The CRTC state. + * @param ramps The gamma ramps to fill with the current values. * @param depth_user The depth of the gamma ramps that are provided by the user, - * `-1` for `float`, `-2` for `double` + * `-1` for `float`, `-2` for `double`. * @param depth_system The depth of the gamma ramps as required by the adjustment method, - * `-1` for `float`, `-2` for `double` + * `-1` for `float`, `-2` for `double`. * @param fun Function that is to be used read the ramps, its parameters have * the same function as those of this function with the same names, - * and the return value too is identical + * and the return value too is identical. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_translated_ramp_get_(libgamma_crtc_state_t* restrict this, libgamma_gamma_ramps_any_t* restrict ramps, @@ -141,19 +141,19 @@ int libgamma_translated_ramp_get_(libgamma_crtc_state_t* restrict this, /** - * Set the gamma ramps for a CRTC, re-encoding version + * Set the gamma ramps for a CRTC, re-encoding version. * - * @param this The CRTC state - * @param ramps The gamma ramps to apply + * @param this The CRTC state. + * @param ramps The gamma ramps to apply. * @param depth_user The depth of the gamma ramps that are provided by the user, - * `-1` for `float`, `-2` for `double` + * `-1` for `float`, `-2` for `double`. * @param depth_system The depth of the gamma ramps as required by the adjustment method, - * `-1` for `float`, `-2` for `double` + * `-1` for `float`, `-2` for `double`. * @param fun Function that is to be used write the ramps, its parameters have * the same function as those of this function with the same names, - * and the return value too is identical + * and the return value too is identical. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_translated_ramp_set_(libgamma_crtc_state_t* restrict this, libgamma_gamma_ramps_any_t ramps, diff --git a/src/gamma-linux-drm.c b/src/gamma-linux-drm.c index ec9c1fc..32e3568 100644 --- a/src/gamma-linux-drm.c +++ b/src/gamma-linux-drm.c @@ -53,27 +53,27 @@ /** - * Graphics card data for the Direct Rendering Manager adjustment method + * Graphics card data for the Direct Rendering Manager adjustment method. */ typedef struct libgamma_drm_card_data { /** - * File descriptor for the connection to the graphics card + * File descriptor for the connection to the graphics card. */ int fd; /** - * The graphics card's mode resources + * The graphics card's mode resources. */ drmModeRes* res; /** - * Resources for open connectors + * Resources for open connectors. */ drmModeConnector** connectors; /** - * Resources for open encoders + * Resources for open encoders. */ drmModeEncoder** encoders; @@ -82,9 +82,9 @@ typedef struct libgamma_drm_card_data /** - * Return the capabilities of the adjustment method + * Return the capabilities of the adjustment method. * - * @param this The data structure to fill with the method's capabilities + * @param this The data structure to fill with the method's capabilities. */ void libgamma_linux_drm_method_capabilities(libgamma_method_capabilities_t* restrict this) { @@ -117,9 +117,9 @@ void libgamma_linux_drm_method_capabilities(libgamma_method_capabilities_t* rest /** - * Initialise an allocated site state + * Initialise an allocated site state. * - * @param this The site state to initialise + * @param this The site state to initialise. * @param site The site identifier, unless it is `NULL` it must a * `free`:able. One the state is destroyed the library * will attempt to free it. There you should not free @@ -127,7 +127,7 @@ void libgamma_linux_drm_method_capabilities(libgamma_method_capabilities_t* rest * or allocate on the stack. Note however that it will * not be free:d if this function fails. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_linux_drm_site_initialise(libgamma_site_state_t* restrict this, char* restrict site) @@ -155,9 +155,9 @@ int libgamma_linux_drm_site_initialise(libgamma_site_state_t* restrict this, /** - * Release all resources held by a site state + * Release all resources held by a site state. * - * @param this The site state + * @param this The site state. */ void libgamma_linux_drm_site_destroy(libgamma_site_state_t* restrict this) { @@ -166,11 +166,11 @@ void libgamma_linux_drm_site_destroy(libgamma_site_state_t* restrict this) /** - * Restore the gamma ramps all CRTCS with a site to the system settings + * Restore the gamma ramps all CRTC:s with a site to the system settings. * - * @param this The site state + * @param this The site state. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_linux_drm_site_restore(libgamma_site_state_t* restrict this) { @@ -181,13 +181,13 @@ int libgamma_linux_drm_site_restore(libgamma_site_state_t* restrict this) /** - * Initialise an allocated partition state + * Initialise an allocated partition state. * - * @param this The partition state to initialise - * @param site The site state for the site that the partition belongs to - * @param partition The the index of the partition within the site + * @param this The partition state to initialise. + * @param site The site state for the site that the partition belongs to. + * @param partition The the index of the partition within the site. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_linux_drm_partition_initialise(libgamma_partition_state_t* restrict this, libgamma_site_state_t* restrict site, size_t partition) @@ -301,9 +301,9 @@ int libgamma_linux_drm_partition_initialise(libgamma_partition_state_t* restrict /** - * Release all connectors and encoders + * Release all connectors and encoders. * - * @param this The graphics card data + * @param this The graphics card data. */ static void release_connectors_and_encoders(libgamma_drm_card_data_t* restrict this) { @@ -325,9 +325,9 @@ static void release_connectors_and_encoders(libgamma_drm_card_data_t* restrict t /** - * Release all resources held by a partition state + * Release all resources held by a partition state. * - * @param this The partition state + * @param this The partition state. */ void libgamma_linux_drm_partition_destroy(libgamma_partition_state_t* restrict this) { @@ -342,11 +342,11 @@ void libgamma_linux_drm_partition_destroy(libgamma_partition_state_t* restrict t /** - * Restore the gamma ramps all CRTCS with a partition to the system settings + * Restore the gamma ramps all CRTC:s with a partition to the system settings. * - * @param this The partition state + * @param this The partition state. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_linux_drm_partition_restore(libgamma_partition_state_t* restrict this) { @@ -357,13 +357,13 @@ int libgamma_linux_drm_partition_restore(libgamma_partition_state_t* restrict th /** - * Initialise an allocated CRTC state + * Initialise an allocated CRTC state. * - * @param this The CRTC state to initialise - * @param partition The partition state for the partition that the CRTC belongs to - * @param crtc The the index of the CRTC within the site + * @param this The CRTC state to initialise. + * @param partition The partition state for the partition that the CRTC belongs to. + * @param crtc The the index of the CRTC within the site. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_linux_drm_crtc_initialise(libgamma_crtc_state_t* restrict this, libgamma_partition_state_t* restrict partition, size_t crtc) @@ -382,9 +382,9 @@ int libgamma_linux_drm_crtc_initialise(libgamma_crtc_state_t* restrict this, /** - * Release all resources held by a CRTC state + * Release all resources held by a CRTC state. * - * @param this The CRTC state + * @param this The CRTC state. */ void libgamma_linux_drm_crtc_destroy(libgamma_crtc_state_t* restrict this) { @@ -393,11 +393,11 @@ void libgamma_linux_drm_crtc_destroy(libgamma_crtc_state_t* restrict this) /** - * Restore the gamma ramps for a CRTC to the system settings for that CRTC + * Restore the gamma ramps for a CRTC to the system settings for that CRTC. * - * @param this The CRTC state + * @param this The CRTC state. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_linux_drm_crtc_restore(libgamma_crtc_state_t* restrict this) { @@ -407,11 +407,12 @@ int libgamma_linux_drm_crtc_restore(libgamma_crtc_state_t* restrict this) /** - * Find the connector that a CRTC belongs to + * Find the connector that a CRTC belongs to. * - * @param this The CRTC state - * @param error Output of the error value to store of error report fields for data that requires the connector -'* @return The CRTC's conncetor, `NULL` on error + * @param this The CRTC state. + * @param error Output of the error value to store of error report + * fields for data that requires the connector. +'* @return The CRTC's conncetor, `NULL` on error. */ static drmModeConnector* find_connector(libgamma_crtc_state_t* restrict this, int* restrict error) { @@ -447,11 +448,11 @@ static drmModeConnector* find_connector(libgamma_crtc_state_t* restrict this, in /** - * Get the size of the gamma ramps for a CRTC + * Get the size of the gamma ramps for a CRTC. * - * @param out Instance of a data structure to fill with the information about the CRTC - * @param crtc The state of the CRTC whose information should be read - * @return The value stored in `out->gamma_size_error` + * @param out Instance of a data structure to fill with the information about the CRTC. + * @param crtc The state of the CRTC whose information should be read. + * @return The value stored in `out->gamma_size_error`. */ static int get_gamma_ramp_size(libgamma_crtc_information_t* restrict out, const libgamma_crtc_state_t* restrict crtc) { @@ -474,13 +475,13 @@ static int get_gamma_ramp_size(libgamma_crtc_information_t* restrict out, const /** - * Read information from the CRTC's conncetor + * Read information from the CRTC's conncetor. * - * @param crtc The state of the CRTC whose information should be read - * @param out Instance of a data structure to fill with the information about the CRTC - * @param connector The CRTC's connector - * @param fields OR:ed identifiers for the information about the CRTC that should be read - * @return Non-zero if at least on error occured + * @param crtc The state of the CRTC whose information should be read. + * @param out Instance of a data structure to fill with the information about the CRTC. + * @param connector The CRTC's connector. + * @param fields OR:ed identifiers for the information about the CRTC that should be read. + * @return Non-zero if at least on error occured. */ static int read_connector_data(libgamma_crtc_state_t* restrict crtc, libgamma_crtc_information_t* restrict out, const drmModeConnector* restrict connector, int32_t fields) @@ -583,12 +584,12 @@ static int read_connector_data(libgamma_crtc_state_t* restrict crtc, libgamma_cr /** - * Get the extended display identification data for a monitor + * Get the extended display identification data for a monitor. * - * @param crtc The CRTC state - * @param out Instance of a data structure to fill with the information about the CRTC - * @param connector The CRTC's connector - * @reutnr Non-zero on error + * @param crtc The CRTC state. + * @param out Instance of a data structure to fill with the information about the CRTC. + * @param connector The CRTC's connector. + * @reutnr Non-zero on error. */ static int get_edid(libgamma_crtc_state_t* restrict crtc, libgamma_crtc_information_t* restrict out, drmModeConnector* connector) @@ -632,11 +633,11 @@ static int get_edid(libgamma_crtc_state_t* restrict crtc, /** - * Read information about a CRTC + * Read information about a CRTC. * - * @param this Instance of a data structure to fill with the information about the CRTC - * @param crtc The state of the CRTC whose information should be read - * @param fields OR:ed identifiers for the information about the CRTC that should be read + * @param this Instance of a data structure to fill with the information about the CRTC. + * @param crtc The state of the CRTC whose information should be read. + * @param fields OR:ed identifiers for the information about the CRTC that should be read. * @return Zero on success, -1 on error. On error refer to the error reports in `this`. */ int libgamma_linux_drm_get_crtc_information(libgamma_crtc_information_t* restrict this, @@ -714,12 +715,12 @@ int libgamma_linux_drm_get_crtc_information(libgamma_crtc_information_t* restric /** - * Get current the gamma ramps for a CRTC, 16-bit gamma-depth version + * Get current the gamma ramps for a CRTC, 16-bit gamma-depth version. * - * @param this The CRTC state - * @param ramps The gamma ramps to fill with the current values + * @param this The CRTC state. + * @param ramps The gamma ramps to fill with the current values. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_linux_drm_crtc_get_gamma_ramps(libgamma_crtc_state_t* restrict this, libgamma_gamma_ramps_t* restrict ramps) @@ -738,12 +739,12 @@ int libgamma_linux_drm_crtc_get_gamma_ramps(libgamma_crtc_state_t* restrict this /** - * Set the gamma ramps for a CRTC, 16-bit gamma-depth version + * Set the gamma ramps for a CRTC, 16-bit gamma-depth version. * - * @param this The CRTC state - * @param ramps The gamma ramps to apply + * @param this The CRTC state. + * @param ramps The gamma ramps to apply. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_linux_drm_crtc_set_gamma_ramps(libgamma_crtc_state_t* restrict this, libgamma_gamma_ramps_t ramps) diff --git a/src/gamma-linux-drm.h b/src/gamma-linux-drm.h index 91707ae..24b789e 100644 --- a/src/gamma-linux-drm.h +++ b/src/gamma-linux-drm.h @@ -27,16 +27,16 @@ /** - * Return the capabilities of the adjustment method + * Return the capabilities of the adjustment method. * - * @param this The data structure to fill with the method's capabilities + * @param this The data structure to fill with the method's capabilities. */ void libgamma_linux_drm_method_capabilities(libgamma_method_capabilities_t* restrict this); /** - * Initialise an allocated site state + * Initialise an allocated site state. * - * @param this The site state to initialise + * @param this The site state to initialise. * @param site The site identifier, unless it is `NULL` it must a * `free`:able. One the state is destroyed the library * will attempt to free it. There you should not free @@ -44,115 +44,115 @@ void libgamma_linux_drm_method_capabilities(libgamma_method_capabilities_t* rest * or allocate on the stack. Note however that it will * not be free:d if this function fails. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_linux_drm_site_initialise(libgamma_site_state_t* restrict this, char* restrict site); /** - * Release all resources held by a site state + * Release all resources held by a site state. * - * @param this The site state + * @param this The site state. */ void libgamma_linux_drm_site_destroy(libgamma_site_state_t* restrict this) __attribute__((const)); /** - * Restore the gamma ramps all CRTCS with a site to the system settings + * Restore the gamma ramps all CRTC:s with a site to the system settings. * - * @param this The site state + * @param this The site state. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_linux_drm_site_restore(libgamma_site_state_t* restrict this); /** - * Initialise an allocated partition state + * Initialise an allocated partition state. * - * @param this The partition state to initialise - * @param site The site state for the site that the partition belongs to - * @param partition The the index of the partition within the site + * @param this The partition state to initialise. + * @param site The site state for the site that the partition belongs to. + * @param partition The the index of the partition within the site. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_linux_drm_partition_initialise(libgamma_partition_state_t* restrict this, libgamma_site_state_t* restrict site, size_t partition); /** - * Release all resources held by a partition state + * Release all resources held by a partition state. * - * @param this The partition state + * @param this The partition state. */ void libgamma_linux_drm_partition_destroy(libgamma_partition_state_t* restrict this); /** - * Restore the gamma ramps all CRTCS with a partition to the system settings + * Restore the gamma ramps all CRTC:s with a partition to the system settings. * - * @param this The partition state + * @param this The partition state. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_linux_drm_partition_restore(libgamma_partition_state_t* restrict this); /** - * Initialise an allocated CRTC state + * Initialise an allocated CRTC state. * - * @param this The CRTC state to initialise + * @param this The CRTC state to initialise. * @param partition The partition state for the partition that the CRTC belongs to - * @param crtc The the index of the CRTC within the site + * @param crtc The the index of the CRTC within the site. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_linux_drm_crtc_initialise(libgamma_crtc_state_t* restrict this, libgamma_partition_state_t* restrict partition, size_t crtc); /** - * Release all resources held by a CRTC state + * Release all resources held by a CRTC state. * - * @param this The CRTC state + * @param this The CRTC state. */ void libgamma_linux_drm_crtc_destroy(libgamma_crtc_state_t* restrict this) __attribute__((const)); /** - * Restore the gamma ramps for a CRTC to the system settings for that CRTC + * Restore the gamma ramps for a CRTC to the system settings for that CRTC. * - * @param this The CRTC state + * @param this The CRTC state. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_linux_drm_crtc_restore(libgamma_crtc_state_t* restrict this); /** - * Read information about a CRTC + * Read information about a CRTC. * - * @param this Instance of a data structure to fill with the information about the CRTC - * @param crtc The state of the CRTC whose information should be read - * @param fields OR:ed identifiers for the information about the CRTC that should be read + * @param this Instance of a data structure to fill with the information about the CRTC. + * @param crtc The state of the CRTC whose information should be read. + * @param fields OR:ed identifiers for the information about the CRTC that should be read. * @return Zero on success, -1 on error. On error refer to the error reports in `this`. */ int libgamma_linux_drm_get_crtc_information(libgamma_crtc_information_t* restrict this, libgamma_crtc_state_t* restrict crtc, int32_t fields); /** - * Get current the gamma ramps for a CRTC, 16-bit gamma-depth version + * Get current the gamma ramps for a CRTC, 16-bit gamma-depth version. * - * @param this The CRTC state - * @param ramps The gamma ramps to fill with the current values + * @param this The CRTC state. + * @param ramps The gamma ramps to fill with the current values. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_linux_drm_crtc_get_gamma_ramps(libgamma_crtc_state_t* restrict this, libgamma_gamma_ramps_t* restrict ramps); /** - * Set the gamma ramps for a CRTC, 16-bit gamma-depth version + * Set the gamma ramps for a CRTC, 16-bit gamma-depth version. * - * @param this The CRTC state - * @param ramps The gamma ramps to apply + * @param this The CRTC state. + * @param ramps The gamma ramps to apply. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_linux_drm_crtc_set_gamma_ramps(libgamma_crtc_state_t* restrict this, libgamma_gamma_ramps_t ramps); diff --git a/src/gamma-quartz-cg.c b/src/gamma-quartz-cg.c index 1c25760..05f76bf 100644 --- a/src/gamma-quartz-cg.c +++ b/src/gamma-quartz-cg.c @@ -35,9 +35,9 @@ /** - * Return the capabilities of the adjustment method + * Return the capabilities of the adjustment method. * - * @param this The data structure to fill with the method's capabilities + * @param this The data structure to fill with the method's capabilities. */ void libgamma_quartz_cg_method_capabilities(libgamma_method_capabilities_t* restrict this) { @@ -69,9 +69,9 @@ void libgamma_quartz_cg_method_capabilities(libgamma_method_capabilities_t* rest /** - * Initialise an allocated site state + * Initialise an allocated site state. * - * @param this The site state to initialise + * @param this The site state to initialise. * @param site The site identifier, unless it is `NULL` it must a * `free`:able. One the state is destroyed the library * will attempt to free it. There you should not free @@ -79,7 +79,7 @@ void libgamma_quartz_cg_method_capabilities(libgamma_method_capabilities_t* rest * or allocate on the stack. Note however that it will * not be free:d if this function fails. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_quartz_cg_site_initialise(libgamma_site_state_t* restrict this, char* restrict site) @@ -93,9 +93,9 @@ int libgamma_quartz_cg_site_initialise(libgamma_site_state_t* restrict this, /** - * Release all resources held by a site state + * Release all resources held by a site state. * - * @param this The site state + * @param this The site state. */ void libgamma_quartz_cg_site_destroy(libgamma_site_state_t* restrict this) { @@ -105,11 +105,11 @@ void libgamma_quartz_cg_site_destroy(libgamma_site_state_t* restrict this) /** - * Restore the gamma ramps all CRTCS with a site to the system settings + * Restore the gamma ramps all CRTC:s with a site to the system settings. * - * @param this The site state + * @param this The site state. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_quartz_cg_site_restore(libgamma_site_state_t* restrict this) { @@ -121,13 +121,13 @@ int libgamma_quartz_cg_site_restore(libgamma_site_state_t* restrict this) /** - * Initialise an allocated partition state + * Initialise an allocated partition state. * - * @param this The partition state to initialise - * @param site The site state for the site that the partition belongs to - * @param partition The the index of the partition within the site + * @param this The partition state to initialise. + * @param site The site state for the site that the partition belongs to. + * @param partition The the index of the partition within the site. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_quartz_cg_partition_initialise(libgamma_partition_state_t* restrict this, libgamma_site_state_t* restrict site, size_t partition) @@ -179,9 +179,9 @@ int libgamma_quartz_cg_partition_initialise(libgamma_partition_state_t* restrict /** - * Release all resources held by a partition state + * Release all resources held by a partition state. * - * @param this The partition state + * @param this The partition state. */ void libgamma_quartz_cg_partition_destroy(libgamma_partition_state_t* restrict this) { @@ -190,11 +190,11 @@ void libgamma_quartz_cg_partition_destroy(libgamma_partition_state_t* restrict t /** - * Restore the gamma ramps all CRTCS with a partition to the system settings + * Restore the gamma ramps all CRTC:s with a partition to the system settings. * - * @param this The partition state + * @param this The partition state. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_quartz_cg_partition_restore(libgamma_partition_state_t* restrict this) { @@ -204,13 +204,13 @@ int libgamma_quartz_cg_partition_restore(libgamma_partition_state_t* restrict th /** - * Initialise an allocated CRTC state + * Initialise an allocated CRTC state. * - * @param this The CRTC state to initialise - * @param partition The partition state for the partition that the CRTC belongs to - * @param crtc The the index of the CRTC within the site + * @param this The CRTC state to initialise. + * @param partition The partition state for the partition that the CRTC belongs to. + * @param crtc The the index of the CRTC within the site. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_quartz_cg_crtc_initialise(libgamma_crtc_state_t* restrict this, libgamma_partition_state_t* restrict partition, size_t crtc) @@ -223,9 +223,9 @@ int libgamma_quartz_cg_crtc_initialise(libgamma_crtc_state_t* restrict this, /** - * Release all resources held by a CRTC state + * Release all resources held by a CRTC state. * - * @param this The CRTC state + * @param this The CRTC state. */ void libgamma_quartz_cg_crtc_destroy(libgamma_crtc_state_t* restrict this) { @@ -234,11 +234,11 @@ void libgamma_quartz_cg_crtc_destroy(libgamma_crtc_state_t* restrict this) /** - * Restore the gamma ramps for a CRTC to the system settings for that CRTC + * Restore the gamma ramps for a CRTC to the system settings for that CRTC. * - * @param this The CRTC state + * @param this The CRTC state. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_quartz_cg_crtc_restore(libgamma_crtc_state_t* restrict this) { @@ -249,11 +249,11 @@ int libgamma_quartz_cg_crtc_restore(libgamma_crtc_state_t* restrict this) /** - * Read information about a CRTC + * Read information about a CRTC. * - * @param this Instance of a data structure to fill with the information about the CRTC - * @param crtc The state of the CRTC whose information should be read - * @param fields OR:ed identifiers for the information about the CRTC that should be read + * @param this Instance of a data structure to fill with the information about the CRTC. + * @param crtc The state of the CRTC whose information should be read. + * @param fields OR:ed identifiers for the information about the CRTC that should be read. * @return Zero on success, -1 on error. On error refer to the error reports in `this`. */ int libgamma_quartz_cg_get_crtc_information(libgamma_crtc_information_t* restrict this, @@ -298,12 +298,12 @@ int libgamma_quartz_cg_get_crtc_information(libgamma_crtc_information_t* restric /** - * Get current the gamma ramps for a CRTC, `float` version + * Get current the gamma ramps for a CRTC, `float` version. * - * @param this The CRTC state - * @param ramps The gamma ramps to fill with the current values + * @param this The CRTC state. + * @param ramps The gamma ramps to fill with the current values. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_quartz_cg_crtc_get_gamma_rampsf(libgamma_crtc_state_t* restrict this, libgamma_gamma_rampsf_t* restrict ramps) @@ -328,12 +328,12 @@ int libgamma_quartz_cg_crtc_get_gamma_rampsf(libgamma_crtc_state_t* restrict thi /** - * Set the gamma ramps for a CRTC, `float` version + * Set the gamma ramps for a CRTC, `float` version. * - * @param this The CRTC state - * @param ramps The gamma ramps to apply + * @param this The CRTC state. + * @param ramps The gamma ramps to apply. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_quartz_cg_crtc_set_gamma_rampsf(libgamma_crtc_state_t* restrict this, libgamma_gamma_rampsf_t ramps) diff --git a/src/gamma-quartz-cg.h b/src/gamma-quartz-cg.h index e70ecc5..058c36d 100644 --- a/src/gamma-quartz-cg.h +++ b/src/gamma-quartz-cg.h @@ -27,16 +27,16 @@ /** - * Return the capabilities of the adjustment method + * Return the capabilities of the adjustment method. * - * @param this The data structure to fill with the method's capabilities + * @param this The data structure to fill with the method's capabilities. */ void libgamma_quartz_cg_method_capabilities(libgamma_method_capabilities_t* restrict this); /** - * Initialise an allocated site state + * Initialise an allocated site state. * - * @param this The site state to initialise + * @param this The site state to initialise. * @param site The site identifier, unless it is `NULL` it must a * `free`:able. One the state is destroyed the library * will attempt to free it. There you should not free @@ -44,115 +44,115 @@ void libgamma_quartz_cg_method_capabilities(libgamma_method_capabilities_t* rest * or allocate on the stack. Note however that it will * not be free:d if this function fails. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_quartz_cg_site_initialise(libgamma_site_state_t* restrict this, char* restrict site); /** - * Release all resources held by a site state + * Release all resources held by a site state. * - * @param this The site state + * @param this The site state. */ void libgamma_quartz_cg_site_destroy(libgamma_site_state_t* restrict this); /** - * Restore the gamma ramps all CRTCS with a site to the system settings + * Restore the gamma ramps all CRTC:s with a site to the system settings. * - * @param this The site state + * @param this The site state. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_quartz_cg_site_restore(libgamma_site_state_t* restrict this); /** - * Initialise an allocated partition state + * Initialise an allocated partition state. * - * @param this The partition state to initialise - * @param site The site state for the site that the partition belongs to + * @param this The partition state to initialise. + * @param site The site state for the site that the partition belongs to. * @param partition The the index of the partition within the site * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_quartz_cg_partition_initialise(libgamma_partition_state_t* restrict this, libgamma_site_state_t* restrict site, size_t partition); /** - * Release all resources held by a partition state + * Release all resources held by a partition state. * - * @param this The partition state + * @param this The partition state. */ void libgamma_quartz_cg_partition_destroy(libgamma_partition_state_t* restrict this); /** - * Restore the gamma ramps all CRTCS with a partition to the system settings + * Restore the gamma ramps all CRTC:s with a partition to the system settings. * - * @param this The partition state + * @param this The partition state. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_quartz_cg_partition_restore(libgamma_partition_state_t* restrict this); /** - * Initialise an allocated CRTC state + * Initialise an allocated CRTC state. * - * @param this The CRTC state to initialise - * @param partition The partition state for the partition that the CRTC belongs to - * @param crtc The the index of the CRTC within the site + * @param this The CRTC state to initialise. + * @param partition The partition state for the partition that the CRTC belongs to. + * @param crtc The the index of the CRTC within the site. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_quartz_cg_crtc_initialise(libgamma_crtc_state_t* restrict this, libgamma_partition_state_t* restrict partition, size_t crtc) __attribute__((pure)); /** - * Release all resources held by a CRTC state + * Release all resources held by a CRTC state. * - * @param this The CRTC state + * @param this The CRTC state. */ void libgamma_quartz_cg_crtc_destroy(libgamma_crtc_state_t* restrict this) __attribute__((const)); /** - * Restore the gamma ramps for a CRTC to the system settings for that CRTC + * Restore the gamma ramps for a CRTC to the system settings for that CRTC. * - * @param this The CRTC state + * @param this The CRTC state. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_quartz_cg_crtc_restore(libgamma_crtc_state_t* restrict this); /** - * Read information about a CRTC + * Read information about a CRTC. * - * @param this Instance of a data structure to fill with the information about the CRTC - * @param crtc The state of the CRTC whose information should be read - * @param fields OR:ed identifiers for the information about the CRTC that should be read + * @param this Instance of a data structure to fill with the information about the CRTC. + * @param crtc The state of the CRTC whose information should be read. + * @param fields OR:ed identifiers for the information about the CRTC that should be read. * @return Zero on success, -1 on error. On error refer to the error reports in `this`. */ int libgamma_quartz_cg_get_crtc_information(libgamma_crtc_information_t* restrict this, libgamma_crtc_state_t* restrict crtc, int32_t fields); /** - * Get current the gamma ramps for a CRTC, `float` version + * Get current the gamma ramps for a CRTC, `float` version. * - * @param this The CRTC state - * @param ramps The gamma ramps to fill with the current values + * @param this The CRTC state. + * @param ramps The gamma ramps to fill with the current values. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_quartz_cg_crtc_get_gamma_rampsf(libgamma_crtc_state_t* restrict this, libgamma_gamma_rampsf_t* restrict ramps); /** - * Set the gamma ramps for a CRTC, `float` version + * Set the gamma ramps for a CRTC, `float` version. * - * @param this The CRTC state - * @param ramps The gamma ramps to apply + * @param this The CRTC state. + * @param ramps The gamma ramps to apply. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_quartz_cg_crtc_set_gamma_rampsf(libgamma_crtc_state_t* restrict this, libgamma_gamma_rampsf_t ramps); diff --git a/src/gamma-w32-gdi.c b/src/gamma-w32-gdi.c index 50683a9..a4c438a 100644 --- a/src/gamma-w32-gdi.c +++ b/src/gamma-w32-gdi.c @@ -39,9 +39,9 @@ /** - * Return the capabilities of the adjustment method + * Return the capabilities of the adjustment method. * - * @param this The data structure to fill with the method's capabilities + * @param this The data structure to fill with the method's capabilities. */ void libgamma_w32_gdi_method_capabilities(libgamma_method_capabilities_t* restrict this) { @@ -74,9 +74,9 @@ void libgamma_w32_gdi_method_capabilities(libgamma_method_capabilities_t* restri /** - * Initialise an allocated site state + * Initialise an allocated site state. * - * @param this The site state to initialise + * @param this The site state to initialise. * @param site The site identifier, unless it is `NULL` it must a * `free`:able. One the state is destroyed the library * will attempt to free it. There you should not free @@ -84,7 +84,7 @@ void libgamma_w32_gdi_method_capabilities(libgamma_method_capabilities_t* restri * or allocate on the stack. Note however that it will * not be free:d if this function fails. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_w32_gdi_site_initialise(libgamma_site_state_t* restrict this, char* restrict site) @@ -98,9 +98,9 @@ int libgamma_w32_gdi_site_initialise(libgamma_site_state_t* restrict this, /** - * Release all resources held by a site state + * Release all resources held by a site state. * - * @param this The site state + * @param this The site state. */ void libgamma_w32_gdi_site_destroy(libgamma_site_state_t* restrict this) { @@ -109,11 +109,11 @@ void libgamma_w32_gdi_site_destroy(libgamma_site_state_t* restrict this) /** - * Restore the gamma ramps all CRTCS with a site to the system settings + * Restore the gamma ramps all CRTC:s with a site to the system settings. * - * @param this The site state + * @param this The site state. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_w32_gdi_site_restore(libgamma_site_state_t* restrict this) { @@ -124,13 +124,13 @@ int libgamma_w32_gdi_site_restore(libgamma_site_state_t* restrict this) /** - * Initialise an allocated partition state + * Initialise an allocated partition state. * - * @param this The partition state to initialise - * @param site The site state for the site that the partition belongs to - * @param partition The the index of the partition within the site + * @param this The partition state to initialise. + * @param site The site state for the site that the partition belongs to. + * @param partition The the index of the partition within the site. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_w32_gdi_partition_initialise(libgamma_partition_state_t* restrict this, libgamma_site_state_t* restrict site, size_t partition) @@ -155,9 +155,9 @@ int libgamma_w32_gdi_partition_initialise(libgamma_partition_state_t* restrict t /** - * Release all resources held by a partition state + * Release all resources held by a partition state. * - * @param this The partition state + * @param this The partition state. */ void libgamma_w32_gdi_partition_destroy(libgamma_partition_state_t* restrict this) { @@ -166,11 +166,11 @@ void libgamma_w32_gdi_partition_destroy(libgamma_partition_state_t* restrict thi /** - * Restore the gamma ramps all CRTCS with a partition to the system settings + * Restore the gamma ramps all CRTC:s with a partition to the system settings. * - * @param this The partition state + * @param this The partition state. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_w32_gdi_partition_restore(libgamma_partition_state_t* restrict this) { @@ -181,13 +181,13 @@ int libgamma_w32_gdi_partition_restore(libgamma_partition_state_t* restrict this /** - * Initialise an allocated CRTC state + * Initialise an allocated CRTC state. * - * @param this The CRTC state to initialise - * @param partition The partition state for the partition that the CRTC belongs to - * @param crtc The the index of the CRTC within the site + * @param this The CRTC state to initialise. + * @param partition The partition state for the partition that the CRTC belongs to. + * @param crtc The the index of the CRTC within the site. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_w32_gdi_crtc_initialise(libgamma_crtc_state_t* restrict this, libgamma_partition_state_t* restrict partition, size_t crtc) @@ -217,9 +217,9 @@ int libgamma_w32_gdi_crtc_initialise(libgamma_crtc_state_t* restrict this, /** - * Release all resources held by a CRTC state + * Release all resources held by a CRTC state. * - * @param this The CRTC state + * @param this The CRTC state. */ void libgamma_w32_gdi_crtc_destroy(libgamma_crtc_state_t* restrict this) { @@ -229,11 +229,11 @@ void libgamma_w32_gdi_crtc_destroy(libgamma_crtc_state_t* restrict this) /** - * Restore the gamma ramps for a CRTC to the system settings for that CRTC + * Restore the gamma ramps for a CRTC to the system settings for that CRTC. * - * @param this The CRTC state + * @param this The CRTC state. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_w32_gdi_crtc_restore(libgamma_crtc_state_t* restrict this) { @@ -244,10 +244,10 @@ int libgamma_w32_gdi_crtc_restore(libgamma_crtc_state_t* restrict this) /** - * Read information about a CRTC + * Read information about a CRTC. * - * @param this Instance of a data structure to fill with the information about the CRTC - * @param crtc The state of the CRTC whose information should be read + * @param this Instance of a data structure to fill with the information about the CRTC. + * @param crtc The state of the CRTC whose information should be read. * @param fields OR:ed identifiers for the information about the CRTC that should be read * @return Zero on success, -1 on error. On error refer to the error reports in `this`. */ @@ -287,12 +287,12 @@ int libgamma_w32_gdi_get_crtc_information(libgamma_crtc_information_t* restrict /** - * Get current the gamma ramps for a CRTC, 16-bit gamma-depth version + * Get current the gamma ramps for a CRTC, 16-bit gamma-depth version. * - * @param this The CRTC state - * @param ramps The gamma ramps to fill with the current values + * @param this The CRTC state. + * @param ramps The gamma ramps to fill with the current values. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_w32_gdi_crtc_get_gamma_ramps(libgamma_crtc_state_t* restrict this, libgamma_gamma_ramps_t* restrict ramps) @@ -310,12 +310,12 @@ int libgamma_w32_gdi_crtc_get_gamma_ramps(libgamma_crtc_state_t* restrict this, /** - * Set the gamma ramps for a CRTC, 16-bit gamma-depth version + * Set the gamma ramps for a CRTC, 16-bit gamma-depth version. * - * @param this The CRTC state - * @param ramps The gamma ramps to apply + * @param this The CRTC state. + * @param ramps The gamma ramps to apply. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_w32_gdi_crtc_set_gamma_ramps(libgamma_crtc_state_t* restrict this, libgamma_gamma_ramps_t ramps) diff --git a/src/gamma-w32-gdi.h b/src/gamma-w32-gdi.h index 74c19fb..ad75a47 100644 --- a/src/gamma-w32-gdi.h +++ b/src/gamma-w32-gdi.h @@ -27,16 +27,16 @@ /** - * Return the capabilities of the adjustment method + * Return the capabilities of the adjustment method. * - * @param this The data structure to fill with the method's capabilities + * @param this The data structure to fill with the method's capabilities. */ void libgamma_w32_gdi_method_capabilities(libgamma_method_capabilities_t* restrict this); /** - * Initialise an allocated site state + * Initialise an allocated site state. * - * @param this The site state to initialise + * @param this The site state to initialise. * @param site The site identifier, unless it is `NULL` it must a * `free`:able. One the state is destroyed the library * will attempt to free it. There you should not free @@ -44,115 +44,115 @@ void libgamma_w32_gdi_method_capabilities(libgamma_method_capabilities_t* restri * or allocate on the stack. Note however that it will * not be free:d if this function fails. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_w32_gdi_site_initialise(libgamma_site_state_t* restrict this, char* restrict site); /** - * Release all resources held by a site state + * Release all resources held by a site state. * - * @param this The site state + * @param this The site state. */ void libgamma_w32_gdi_site_destroy(libgamma_site_state_t* restrict this) __attribute__((const)); /** - * Restore the gamma ramps all CRTCS with a site to the system settings + * Restore the gamma ramps all CRTC:s with a site to the system settings. * - * @param this The site state + * @param this The site state. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_w32_gdi_site_restore(libgamma_site_state_t* restrict this); /** - * Initialise an allocated partition state + * Initialise an allocated partition state. * - * @param this The partition state to initialise - * @param site The site state for the site that the partition belongs to - * @param partition The the index of the partition within the site + * @param this The partition state to initialise. + * @param site The site state for the site that the partition belongs to. + * @param partition The the index of the partition within the site. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_w32_gdi_partition_initialise(libgamma_partition_state_t* restrict this, libgamma_site_state_t* restrict site, size_t partition); /** - * Release all resources held by a partition state + * Release all resources held by a partition state. * - * @param this The partition state + * @param this The partition state. */ void libgamma_w32_gdi_partition_destroy(libgamma_partition_state_t* restrict this) __attribute__((const)); /** - * Restore the gamma ramps all CRTCS with a partition to the system settings + * Restore the gamma ramps all CRTC:s with a partition to the system settings. * - * @param this The partition state + * @param this The partition state. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_w32_gdi_partition_restore(libgamma_partition_state_t* restrict this); /** - * Initialise an allocated CRTC state + * Initialise an allocated CRTC state. * - * @param this The CRTC state to initialise - * @param partition The partition state for the partition that the CRTC belongs to - * @param crtc The the index of the CRTC within the site + * @param this The CRTC state to initialise. + * @param partition The partition state for the partition that the CRTC belongs to. + * @param crtc The the index of the CRTC within the site. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_w32_gdi_crtc_initialise(libgamma_crtc_state_t* restrict this, libgamma_partition_state_t* restrict partition, size_t crtc); /** - * Release all resources held by a CRTC state + * Release all resources held by a CRTC state. * - * @param this The CRTC state + * @param this The CRTC state. */ void libgamma_w32_gdi_crtc_destroy(libgamma_crtc_state_t* restrict this); /** - * Restore the gamma ramps for a CRTC to the system settings for that CRTC + * Restore the gamma ramps for a CRTC to the system settings for that CRTC. * - * @param this The CRTC state + * @param this The CRTC state. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_w32_gdi_crtc_restore(libgamma_crtc_state_t* restrict this); /** - * Read information about a CRTC + * Read information about a CRTC. * - * @param this Instance of a data structure to fill with the information about the CRTC - * @param crtc The state of the CRTC whose information should be read - * @param fields OR:ed identifiers for the information about the CRTC that should be read + * @param this Instance of a data structure to fill with the information about the CRTC. + * @param crtc The state of the CRTC whose information should be read. + * @param fields OR:ed identifiers for the information about the CRTC that should be read. * @return Zero on success, -1 on error. On error refer to the error reports in `this`. */ int libgamma_w32_gdi_get_crtc_information(libgamma_crtc_information_t* restrict this, libgamma_crtc_state_t* restrict crtc, int32_t fields); /** - * Get current the gamma ramps for a CRTC, 16-bit gamma-depth version + * Get current the gamma ramps for a CRTC, 16-bit gamma-depth version. * - * @param this The CRTC state - * @param ramps The gamma ramps to fill with the current values + * @param this The CRTC state. + * @param ramps The gamma ramps to fill with the current values. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_w32_gdi_crtc_get_gamma_ramps(libgamma_crtc_state_t* restrict this, libgamma_gamma_ramps_t* restrict ramps); /** - * Set the gamma ramps for a CRTC, 16-bit gamma-depth version + * Set the gamma ramps for a CRTC, 16-bit gamma-depth version. * - * @param this The CRTC state - * @param ramps The gamma ramps to apply + * @param this The CRTC state. + * @param ramps The gamma ramps to apply. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_w32_gdi_crtc_set_gamma_ramps(libgamma_crtc_state_t* restrict this, libgamma_gamma_ramps_t ramps); diff --git a/src/gamma-x-randr.c b/src/gamma-x-randr.c index 69aa095..f97d431 100644 --- a/src/gamma-x-randr.c +++ b/src/gamma-x-randr.c @@ -37,34 +37,34 @@ /** - * The major version of RandR the library expects + * The major version of RandR the library expects. */ #define RANDR_VERSION_MAJOR 1 /** - * The minor version of RandR the library expects + * The minor version of RandR the library expects. */ #define RANDR_VERSION_MINOR 3 /** - * Data structure for partition data + * Data structure for partition data. */ typedef struct libgamma_x_randr_partition_data { /** - * Mapping from CRTC indices to CRTC identifiers + * Mapping from CRTC indices to CRTC identifiers. */ xcb_randr_crtc_t* crtcs; /** - * Mapping from output indices to output identifiers + * Mapping from output indices to output identifiers. */ xcb_randr_output_t* outputs; /** - * The number of outputs available + * The number of outputs available. */ size_t outputs_count; @@ -77,7 +77,7 @@ typedef struct libgamma_x_randr_partition_data size_t* crtc_to_output; /** - * Screen configuration timestamp + * Screen configuration timestamp. */ xcb_timestamp_t config_timestamp; @@ -86,11 +86,11 @@ typedef struct libgamma_x_randr_partition_data /** - * Translate an xcb error into a libgamma error + * Translate an xcb error into a libgamma error. * - * @param error_code The xcb error - * @param default_error The libgamma error to use if the xcb error is not recognised - * @return The libgamma error + * @param error_code The xcb error. + * @param default_error The libgamma error to use if the xcb error is not recognised. + * @return The libgamma error. */ static int translate_error_(int error_code, int default_error) { @@ -110,12 +110,12 @@ static int translate_error_(int error_code, int default_error) /** - * Translate an xcb error into a libgamma error + * Translate an xcb error into a libgamma error. * - * @param error_code The xcb error - * @param default_error The libgamma error to use if the xcb error is not recognised - * @param return_errno Whether an `errno` value may be returned - * @return The libgamma error + * @param error_code The xcb error. + * @param default_error The libgamma error to use if the xcb error is not recognised. + * @param return_errno Whether an `errno` value may be returned. + * @return The libgamma error. */ static int translate_error(int error_code, int default_error, int return_errno) { @@ -125,9 +125,9 @@ static int translate_error(int error_code, int default_error, int return_errno) /** - * Return the capabilities of the adjustment method + * Return the capabilities of the adjustment method. * - * @param this The data structure to fill with the method's capabilities + * @param this The data structure to fill with the method's capabilities. */ void libgamma_x_randr_method_capabilities(libgamma_method_capabilities_t* restrict this) { @@ -164,9 +164,9 @@ void libgamma_x_randr_method_capabilities(libgamma_method_capabilities_t* restri /** - * Initialise an allocated site state + * Initialise an allocated site state. * - * @param this The site state to initialise + * @param this The site state to initialise. * @param site The site identifier, unless it is `NULL` it must a * `free`:able. One the state is destroyed the library * will attempt to free it. There you should not free @@ -174,7 +174,7 @@ void libgamma_x_randr_method_capabilities(libgamma_method_capabilities_t* restri * or allocate on the stack. Note however that it will * not be free:d if this function fails. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_x_randr_site_initialise(libgamma_site_state_t* restrict this, char* restrict site) @@ -228,9 +228,9 @@ int libgamma_x_randr_site_initialise(libgamma_site_state_t* restrict this, /** - * Release all resources held by a site state + * Release all resources held by a site state. * - * @param this The site state + * @param this The site state. */ void libgamma_x_randr_site_destroy(libgamma_site_state_t* restrict this) { @@ -239,11 +239,11 @@ void libgamma_x_randr_site_destroy(libgamma_site_state_t* restrict this) /** - * Restore the gamma ramps all CRTCS with a site to the system settings + * Restore the gamma ramps all CRTC:s with a site to the system settings. * - * @param this The site state + * @param this The site state. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_x_randr_site_restore(libgamma_site_state_t* restrict this) { @@ -253,11 +253,11 @@ int libgamma_x_randr_site_restore(libgamma_site_state_t* restrict this) /** - * Duplicate a memory area + * Duplicate a memory area. * - * @param ptr The memory aree - * @param bytes The size, in bytes, of the memory area - * @return A duplication of the memory, `NULL` if zero-length or on error + * @param ptr The memory aree. + * @param bytes The size, in bytes, of the memory area. + * @return A duplication of the memory, `NULL` if zero-length or on error. */ static inline void* memdup(void* restrict ptr, size_t bytes) { @@ -272,13 +272,13 @@ static inline void* memdup(void* restrict ptr, size_t bytes) /** - * Initialise an allocated partition state + * Initialise an allocated partition state. * - * @param this The partition state to initialise - * @param site The site state for the site that the partition belongs to - * @param partition The the index of the partition within the site + * @param this The partition state to initialise. + * @param site The site state for the site that the partition belongs to. + * @param partition The the index of the partition within the site. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_x_randr_partition_initialise(libgamma_partition_state_t* restrict this, libgamma_site_state_t* restrict site, size_t partition) @@ -390,9 +390,9 @@ int libgamma_x_randr_partition_initialise(libgamma_partition_state_t* restrict t /** - * Release all resources held by a partition state + * Release all resources held by a partition state. * - * @param this The partition state + * @param this The partition state. */ void libgamma_x_randr_partition_destroy(libgamma_partition_state_t* restrict this) { @@ -405,11 +405,11 @@ void libgamma_x_randr_partition_destroy(libgamma_partition_state_t* restrict thi /** - * Restore the gamma ramps all CRTCS with a partition to the system settings + * Restore the gamma ramps all CRTC:s with a partition to the system settings. * - * @param this The partition state + * @param this The partition state. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_x_randr_partition_restore(libgamma_partition_state_t* restrict this) { @@ -420,13 +420,13 @@ int libgamma_x_randr_partition_restore(libgamma_partition_state_t* restrict this /** - * Initialise an allocated CRTC state + * Initialise an allocated CRTC state. * - * @param this The CRTC state to initialise - * @param partition The partition state for the partition that the CRTC belongs to - * @param crtc The the index of the CRTC within the site + * @param this The CRTC state to initialise. + * @param partition The partition state for the partition that the CRTC belongs to. + * @param crtc The the index of the CRTC within the site. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_x_randr_crtc_initialise(libgamma_crtc_state_t* restrict this, libgamma_partition_state_t* restrict partition, size_t crtc) @@ -441,9 +441,9 @@ int libgamma_x_randr_crtc_initialise(libgamma_crtc_state_t* restrict this, /** - * Release all resources held by a CRTC state + * Release all resources held by a CRTC state. * - * @param this The CRTC state + * @param this The CRTC state. */ void libgamma_x_randr_crtc_destroy(libgamma_crtc_state_t* restrict this) { @@ -452,11 +452,11 @@ void libgamma_x_randr_crtc_destroy(libgamma_crtc_state_t* restrict this) /** - * Restore the gamma ramps for a CRTC to the system settings for that CRTC + * Restore the gamma ramps for a CRTC to the system settings for that CRTC. * - * @param this The CRTC state + * @param this The CRTC state. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_x_randr_crtc_restore(libgamma_crtc_state_t* restrict this) { @@ -467,11 +467,11 @@ int libgamma_x_randr_crtc_restore(libgamma_crtc_state_t* restrict this) /** - * Get the gamma ramp size of a CRTC + * Get the gamma ramp size of a CRTC. * - * @param this Instance of a data structure to fill with the information about the CRTC - * @param crtc The state of the CRTC whose information should be read - * @return Non-zero on error + * @param this Instance of a data structure to fill with the information about the CRTC. + * @param crtc The state of the CRTC whose information should be read. + * @return Non-zero on error. */ static int get_gamma_ramp_size(libgamma_crtc_information_t* restrict out, libgamma_crtc_state_t* restrict crtc) { @@ -495,11 +495,11 @@ static int get_gamma_ramp_size(libgamma_crtc_information_t* restrict out, libgam /** - * Read information from the CRTC's output + * Read information from the CRTC's output. * - * @param out Instance of a data structure to fill with the information about the CRTC - * @param output The CRTC's output information - * @return Non-zero if at least on error occured + * @param out Instance of a data structure to fill with the information about the CRTC. + * @param output The CRTC's output information. + * @return Non-zero if at least on error occured. */ static int read_output_data(libgamma_crtc_information_t* restrict out, xcb_randr_get_output_info_reply_t* restrict output) { @@ -545,10 +545,10 @@ static int read_output_data(libgamma_crtc_information_t* restrict out, xcb_randr /** - * Determine the connector type from the connector name + * Determine the connector type from the connector name. * - * @param this The CRTC information to use and extend - * @param Non-zero on error + * @param this The CRTC information to use and extend. + * @param Non-zero on error. */ static int get_connector_type(libgamma_crtc_information_t* restrict this) { @@ -580,11 +580,11 @@ static int get_connector_type(libgamma_crtc_information_t* restrict this) /** - * Get the output name of a CRTC + * Get the output name of a CRTC. * - * @param this Instance of a data structure to fill with the information about the CRTC - * @param output The CRTC's output's information - * @return Non-zero on error + * @param this Instance of a data structure to fill with the information about the CRTC. + * @param output The CRTC's output's information. + * @return Non-zero on error. */ static int get_output_name(libgamma_crtc_information_t* restrict out, xcb_randr_get_output_info_reply_t* restrict output) { @@ -619,12 +619,12 @@ static int get_output_name(libgamma_crtc_information_t* restrict out, xcb_randr_ /** - * Get the Extended Display Information Data of the monitor connected to the connector of a CRTC + * Get the Extended Display Information Data of the monitor connected to the connector of a CRTC. * - * @param out Instance of a data structure to fill with the information about the CRTC - * @param crtc The state of the CRTC whose information should be read - * @param output The CRTC's output - * @return Non-zero on error + * @param out Instance of a data structure to fill with the information about the CRTC. + * @param crtc The state of the CRTC whose information should be read. + * @param output The CRTC's output. + * @return Non-zero on error. */ static int get_edid(libgamma_crtc_information_t* restrict out, libgamma_crtc_state_t* restrict crtc, xcb_randr_output_t output) @@ -735,12 +735,12 @@ static int get_edid(libgamma_crtc_information_t* restrict out, /** - * Read information about a CRTC + * Read information about a CRTC. * - * @param this Instance of a data structure to fill with the information about the CRTC - * @param crtc The state of the CRTC whose information should be read - * @param fields OR:ed identifiers for the information about the CRTC that should be read - * @return Zero on success, -1 on error. On error refer to the error reports in `this`. + * @param this Instance of a data structure to fill with the information about the CRTC. + * @param crtc The state of the CRTC whose information should be read. + * @param fields OR:ed identifiers for the information about the CRTC that should be read. + * @return Zero on success, -1 on error. On error refer to the error reports in `this`.. */ int libgamma_x_randr_get_crtc_information(libgamma_crtc_information_t* restrict this, libgamma_crtc_state_t* restrict crtc, int32_t fields) @@ -843,12 +843,12 @@ int libgamma_x_randr_get_crtc_information(libgamma_crtc_information_t* restrict /** - * Get current the gamma ramps for a CRTC, 16-bit gamma-depth version + * Get current the gamma ramps for a CRTC, 16-bit gamma-depth version. * - * @param this The CRTC state - * @param ramps The gamma ramps to fill with the current values + * @param this The CRTC state. + * @param ramps The gamma ramps to fill with the current values. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_x_randr_crtc_get_gamma_ramps(libgamma_crtc_state_t* restrict this, libgamma_gamma_ramps_t* restrict ramps) @@ -886,12 +886,12 @@ int libgamma_x_randr_crtc_get_gamma_ramps(libgamma_crtc_state_t* restrict this, /** - * Set the gamma ramps for a CRTC, 16-bit gamma-depth version + * Set the gamma ramps for a CRTC, 16-bit gamma-depth version. * - * @param this The CRTC state - * @param ramps The gamma ramps to apply + * @param this The CRTC state. + * @param ramps The gamma ramps to apply. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_x_randr_crtc_set_gamma_ramps(libgamma_crtc_state_t* restrict this, libgamma_gamma_ramps_t ramps) diff --git a/src/gamma-x-randr.h b/src/gamma-x-randr.h index 4a49dc2..cceac81 100644 --- a/src/gamma-x-randr.h +++ b/src/gamma-x-randr.h @@ -27,16 +27,16 @@ /** - * Return the capabilities of the adjustment method + * Return the capabilities of the adjustment method. * - * @param this The data structure to fill with the method's capabilities + * @param this The data structure to fill with the method's capabilities. */ void libgamma_x_randr_method_capabilities(libgamma_method_capabilities_t* restrict this); /** - * Initialise an allocated site state + * Initialise an allocated site state. * - * @param this The site state to initialise + * @param this The site state to initialise. * @param site The site identifier, unless it is `NULL` it must a * `free`:able. One the state is destroyed the library * will attempt to free it. There you should not free @@ -44,115 +44,115 @@ void libgamma_x_randr_method_capabilities(libgamma_method_capabilities_t* restri * or allocate on the stack. Note however that it will * not be free:d if this function fails. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_x_randr_site_initialise(libgamma_site_state_t* restrict this, char* restrict site); /** - * Release all resources held by a site state + * Release all resources held by a site state. * - * @param this The site state + * @param this The site state. */ void libgamma_x_randr_site_destroy(libgamma_site_state_t* restrict this); /** - * Restore the gamma ramps all CRTCS with a site to the system settings + * Restore the gamma ramps all CRTC:s with a site to the system settings. * - * @param this The site state + * @param this The site state. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_x_randr_site_restore(libgamma_site_state_t* restrict this); /** - * Initialise an allocated partition state + * Initialise an allocated partition state. * - * @param this The partition state to initialise - * @param site The site state for the site that the partition belongs to - * @param partition The the index of the partition within the site + * @param this The partition state to initialise. + * @param site The site state for the site that the partition belongs to. + * @param partition The the index of the partition within the site. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_x_randr_partition_initialise(libgamma_partition_state_t* restrict this, libgamma_site_state_t* restrict site, size_t partition); /** - * Release all resources held by a partition state + * Release all resources held by a partition state. * - * @param this The partition state + * @param this The partition state. */ void libgamma_x_randr_partition_destroy(libgamma_partition_state_t* restrict this); /** - * Restore the gamma ramps all CRTCS with a partition to the system settings + * Restore the gamma ramps all CRTC:s with a partition to the system settings. * - * @param this The partition state + * @param this The partition state. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_x_randr_partition_restore(libgamma_partition_state_t* restrict this); /** - * Initialise an allocated CRTC state + * Initialise an allocated CRTC state. * - * @param this The CRTC state to initialise - * @param partition The partition state for the partition that the CRTC belongs to - * @param crtc The the index of the CRTC within the site + * @param this The CRTC state to initialise. + * @param partition The partition state for the partition that the CRTC belongs to. + * @param crtc The the index of the CRTC within the site. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_x_randr_crtc_initialise(libgamma_crtc_state_t* restrict this, libgamma_partition_state_t* restrict partition, size_t crtc); /** - * Release all resources held by a CRTC state + * Release all resources held by a CRTC state. * - * @param this The CRTC state + * @param this The CRTC state. */ void libgamma_x_randr_crtc_destroy(libgamma_crtc_state_t* restrict this) __attribute__((const)); /** - * Restore the gamma ramps for a CRTC to the system settings for that CRTC + * Restore the gamma ramps for a CRTC to the system settings for that CRTC. * - * @param this The CRTC state + * @param this The CRTC state. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_x_randr_crtc_restore(libgamma_crtc_state_t* restrict this); /** - * Read information about a CRTC + * Read information about a CRTC. * - * @param this Instance of a data structure to fill with the information about the CRTC - * @param crtc The state of the CRTC whose information should be read - * @param fields OR:ed identifiers for the information about the CRTC that should be read + * @param this Instance of a data structure to fill with the information about the CRTC. + * @param crtc The state of the CRTC whose information should be read. + * @param fields OR:ed identifiers for the information about the CRTC that should be read. * @return Zero on success, -1 on error. On error refer to the error reports in `this`. */ int libgamma_x_randr_get_crtc_information(libgamma_crtc_information_t* restrict this, libgamma_crtc_state_t* restrict crtc, int32_t fields); /** - * Get current the gamma ramps for a CRTC, 16-bit gamma-depth version + * Get current the gamma ramps for a CRTC, 16-bit gamma-depth version. * - * @param this The CRTC state - * @param ramps The gamma ramps to fill with the current values + * @param this The CRTC state. + * @param ramps The gamma ramps to fill with the current values. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_x_randr_crtc_get_gamma_ramps(libgamma_crtc_state_t* restrict this, libgamma_gamma_ramps_t* restrict ramps); /** - * Set the gamma ramps for a CRTC, 16-bit gamma-depth version + * Set the gamma ramps for a CRTC, 16-bit gamma-depth version. * - * @param this The CRTC state - * @param ramps The gamma ramps to apply + * @param this The CRTC state. + * @param ramps The gamma ramps to apply. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_x_randr_crtc_set_gamma_ramps(libgamma_crtc_state_t* restrict this, libgamma_gamma_ramps_t ramps); diff --git a/src/gamma-x-vidmode.c b/src/gamma-x-vidmode.c index cbed77f..29e954e 100644 --- a/src/gamma-x-vidmode.c +++ b/src/gamma-x-vidmode.c @@ -31,9 +31,9 @@ /** - * Return the capabilities of the adjustment method + * Return the capabilities of the adjustment method. * - * @param this The data structure to fill with the method's capabilities + * @param this The data structure to fill with the method's capabilities. */ void libgamma_x_vidmode_method_capabilities(libgamma_method_capabilities_t* restrict this) { @@ -57,9 +57,9 @@ void libgamma_x_vidmode_method_capabilities(libgamma_method_capabilities_t* rest /** - * Initialise an allocated site state + * Initialise an allocated site state. * - * @param this The site state to initialise + * @param this The site state to initialise. * @param site The site identifier, unless it is `NULL` it must a * `free`:able. One the state is destroyed the library * will attempt to free it. There you should not free @@ -67,7 +67,7 @@ void libgamma_x_vidmode_method_capabilities(libgamma_method_capabilities_t* rest * or allocate on the stack. Note however that it will * not be free:d if this function fails. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_x_vidmode_site_initialise(libgamma_site_state_t* restrict this, char* restrict site) @@ -86,9 +86,9 @@ int libgamma_x_vidmode_site_initialise(libgamma_site_state_t* restrict this, /** - * Release all resources held by a site state + * Release all resources held by a site state. * - * @param this The site state + * @param this The site state. */ void libgamma_x_vidmode_site_destroy(libgamma_site_state_t* restrict this) { @@ -97,11 +97,11 @@ void libgamma_x_vidmode_site_destroy(libgamma_site_state_t* restrict this) /** - * Restore the gamma ramps all CRTCS with a site to the system settings + * Restore the gamma ramps all CRTC:s with a site to the system settings. * - * @param this The site state + * @param this The site state. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_x_vidmode_site_restore(libgamma_site_state_t* restrict this) { @@ -112,13 +112,13 @@ int libgamma_x_vidmode_site_restore(libgamma_site_state_t* restrict this) /** - * Initialise an allocated partition state + * Initialise an allocated partition state. * - * @param this The partition state to initialise - * @param site The site state for the site that the partition belongs to - * @param partition The the index of the partition within the site + * @param this The partition state to initialise. + * @param site The site state for the site that the partition belongs to. + * @param partition The the index of the partition within the site. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_x_vidmode_partition_initialise(libgamma_partition_state_t* restrict this, libgamma_site_state_t* restrict site, size_t partition) @@ -131,9 +131,9 @@ int libgamma_x_vidmode_partition_initialise(libgamma_partition_state_t* restrict /** - * Release all resources held by a partition state + * Release all resources held by a partition state. * - * @param this The partition state + * @param this The partition state. */ void libgamma_x_vidmode_partition_destroy(libgamma_partition_state_t* restrict this) { @@ -142,11 +142,11 @@ void libgamma_x_vidmode_partition_destroy(libgamma_partition_state_t* restrict t /** - * Restore the gamma ramps all CRTCS with a partition to the system settings + * Restore the gamma ramps all CRTC:s with a partition to the system settings. * - * @param this The partition state + * @param this The partition state. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_x_vidmode_partition_restore(libgamma_partition_state_t* restrict this) { @@ -157,13 +157,13 @@ int libgamma_x_vidmode_partition_restore(libgamma_partition_state_t* restrict th /** - * Initialise an allocated CRTC state + * Initialise an allocated CRTC state. * - * @param this The CRTC state to initialise - * @param partition The partition state for the partition that the CRTC belongs to - * @param crtc The the index of the CRTC within the site + * @param this The CRTC state to initialise. + * @param partition The partition state for the partition that the CRTC belongs to. + * @param crtc The the index of the CRTC within the site. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_x_vidmode_crtc_initialise(libgamma_crtc_state_t* restrict this, libgamma_partition_state_t* restrict partition, size_t crtc) @@ -175,9 +175,9 @@ int libgamma_x_vidmode_crtc_initialise(libgamma_crtc_state_t* restrict this, /** - * Release all resources held by a CRTC state + * Release all resources held by a CRTC state. * - * @param this The CRTC state + * @param this The CRTC state. */ void libgamma_x_vidmode_crtc_destroy(libgamma_crtc_state_t* restrict this) { @@ -186,11 +186,11 @@ void libgamma_x_vidmode_crtc_destroy(libgamma_crtc_state_t* restrict this) /** - * Restore the gamma ramps for a CRTC to the system settings for that CRTC + * Restore the gamma ramps for a CRTC to the system settings for that CRTC. * - * @param this The CRTC state + * @param this The CRTC state. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_x_vidmode_crtc_restore(libgamma_crtc_state_t* restrict this) { @@ -201,10 +201,10 @@ int libgamma_x_vidmode_crtc_restore(libgamma_crtc_state_t* restrict this) /** - * Read information about a CRTC + * Read information about a CRTC. * - * @param this Instance of a data structure to fill with the information about the CRTC - * @param crtc The state of the CRTC whose information should be read + * @param this Instance of a data structure to fill with the information about the CRTC. + * @param crtc The state of the CRTC whose information should be read. * @param fields OR:ed identifiers for the information about the CRTC that should be read * @return Zero on success, -1 on error. On error refer to the error reports in `this`. */ @@ -246,12 +246,12 @@ int libgamma_x_vidmode_get_crtc_information(libgamma_crtc_information_t* restric /** - * Get current the gamma ramps for a CRTC, 16-bit gamma-depth version + * Get current the gamma ramps for a CRTC, 16-bit gamma-depth version. * - * @param this The CRTC state - * @param ramps The gamma ramps to fill with the current values + * @param this The CRTC state. + * @param ramps The gamma ramps to fill with the current values. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_x_vidmode_crtc_get_gamma_ramps(libgamma_crtc_state_t* restrict this, libgamma_gamma_ramps_t* restrict ramps) @@ -269,12 +269,12 @@ int libgamma_x_vidmode_crtc_get_gamma_ramps(libgamma_crtc_state_t* restrict this /** - * Set the gamma ramps for a CRTC, 16-bit gamma-depth version + * Set the gamma ramps for a CRTC, 16-bit gamma-depth version. * - * @param this The CRTC state - * @param ramps The gamma ramps to apply + * @param this The CRTC state. + * @param ramps The gamma ramps to apply. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_x_vidmode_crtc_set_gamma_ramps(libgamma_crtc_state_t* restrict this, libgamma_gamma_ramps_t ramps) diff --git a/src/gamma-x-vidmode.h b/src/gamma-x-vidmode.h index f2c915a..52376cc 100644 --- a/src/gamma-x-vidmode.h +++ b/src/gamma-x-vidmode.h @@ -27,16 +27,16 @@ /** - * Return the capabilities of the adjustment method + * Return the capabilities of the adjustment method. * - * @param this The data structure to fill with the method's capabilities + * @param this The data structure to fill with the method's capabilities. */ void libgamma_x_vidmode_method_capabilities(libgamma_method_capabilities_t* restrict this); /** - * Initialise an allocated site state + * Initialise an allocated site state. * - * @param this The site state to initialise + * @param this The site state to initialise. * @param site The site identifier, unless it is `NULL` it must a * `free`:able. One the state is destroyed the library * will attempt to free it. There you should not free @@ -44,115 +44,115 @@ void libgamma_x_vidmode_method_capabilities(libgamma_method_capabilities_t* rest * or allocate on the stack. Note however that it will * not be free:d if this function fails. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_x_vidmode_site_initialise(libgamma_site_state_t* restrict this, char* restrict site); /** - * Release all resources held by a site state + * Release all resources held by a site state. * - * @param this The site state + * @param this The site state. */ void libgamma_x_vidmode_site_destroy(libgamma_site_state_t* restrict this); /** - * Restore the gamma ramps all CRTCS with a site to the system settings + * Restore the gamma ramps all CRTC:s with a site to the system settings. * - * @param this The site state + * @param this The site state. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_x_vidmode_site_restore(libgamma_site_state_t* restrict this); /** - * Initialise an allocated partition state + * Initialise an allocated partition state. * - * @param this The partition state to initialise - * @param site The site state for the site that the partition belongs to - * @param partition The the index of the partition within the site + * @param this The partition state to initialise. + * @param site The site state for the site that the partition belongs to. + * @param partition The the index of the partition within the site. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_x_vidmode_partition_initialise(libgamma_partition_state_t* restrict this, libgamma_site_state_t* restrict site, size_t partition); /** - * Release all resources held by a partition state + * Release all resources held by a partition state. * - * @param this The partition state + * @param this The partition state. */ void libgamma_x_vidmode_partition_destroy(libgamma_partition_state_t* restrict this) __attribute__((const)); /** - * Restore the gamma ramps all CRTCS with a partition to the system settings + * Restore the gamma ramps all CRTC:s with a partition to the system settings. * - * @param this The partition state + * @param this The partition state. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_x_vidmode_partition_restore(libgamma_partition_state_t* restrict this); /** - * Initialise an allocated CRTC state + * Initialise an allocated CRTC state. * - * @param this The CRTC state to initialise - * @param partition The partition state for the partition that the CRTC belongs to - * @param crtc The the index of the CRTC within the site + * @param this The CRTC state to initialise. + * @param partition The partition state for the partition that the CRTC belongs to. + * @param crtc The the index of the CRTC within the site. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_x_vidmode_crtc_initialise(libgamma_crtc_state_t* restrict this, libgamma_partition_state_t* restrict partition, size_t crtc) __attribute__((const)); /** - * Release all resources held by a CRTC state + * Release all resources held by a CRTC state. * - * @param this The CRTC state + * @param this The CRTC state. */ void libgamma_x_vidmode_crtc_destroy(libgamma_crtc_state_t* restrict this) __attribute__((const)); /** - * Restore the gamma ramps for a CRTC to the system settings for that CRTC + * Restore the gamma ramps for a CRTC to the system settings for that CRTC. * - * @param this The CRTC state + * @param this The CRTC state. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_x_vidmode_crtc_restore(libgamma_crtc_state_t* restrict this); /** - * Read information about a CRTC + * Read information about a CRTC. * - * @param this Instance of a data structure to fill with the information about the CRTC - * @param crtc The state of the CRTC whose information should be read - * @param fields OR:ed identifiers for the information about the CRTC that should be read + * @param this Instance of a data structure to fill with the information about the CRTC. + * @param crtc The state of the CRTC whose information should be read. + * @param fields OR:ed identifiers for the information about the CRTC that should be read. * @return Zero on success, -1 on error. On error refer to the error reports in `this`. */ int libgamma_x_vidmode_get_crtc_information(libgamma_crtc_information_t* restrict this, libgamma_crtc_state_t* restrict crtc, int32_t fields); /** - * Get current the gamma ramps for a CRTC, 16-bit gamma-depth version + * Get current the gamma ramps for a CRTC, 16-bit gamma-depth version. * - * @param this The CRTC state - * @param ramps The gamma ramps to fill with the current values + * @param this The CRTC state. + * @param ramps The gamma ramps to fill with the current values. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_x_vidmode_crtc_get_gamma_ramps(libgamma_crtc_state_t* restrict this, libgamma_gamma_ramps_t* restrict ramps); /** - * Set the gamma ramps for a CRTC, 16-bit gamma-depth version + * Set the gamma ramps for a CRTC, 16-bit gamma-depth version. * - * @param this The CRTC state - * @param ramps The gamma ramps to apply + * @param this The CRTC state. + * @param ramps The gamma ramps to apply. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_x_vidmode_crtc_set_gamma_ramps(libgamma_crtc_state_t* restrict this, libgamma_gamma_ramps_t ramps); diff --git a/src/libgamma-error.c b/src/libgamma-error.c index cd63282..9374f8b 100644 --- a/src/libgamma-error.c +++ b/src/libgamma-error.c @@ -23,13 +23,13 @@ /** - * Group that the user needs to be a member of if `LIBGAMMA_DEVICE_REQUIRE_GROUP` is returned + * Group that the user needs to be a member of if `LIBGAMMA_DEVICE_REQUIRE_GROUP` is returned. */ gid_t libgamma_group_gid = 0; /** * Group that the user needs to be a member of if `LIBGAMMA_DEVICE_REQUIRE_GROUP` is returned, - * `NULL` if the name of the group `libgamma_group_gid` cannot be determined + * `NULL` if the name of the group `libgamma_group_gid` cannot be determined. */ const char* libgamma_group_name = NULL; diff --git a/src/libgamma-error.h b/src/libgamma-error.h index 88f9ca7..1edbfcc 100644 --- a/src/libgamma-error.h +++ b/src/libgamma-error.h @@ -26,177 +26,177 @@ /** - * Group that the user needs to be a member of if `LIBGAMMA_DEVICE_REQUIRE_GROUP` is returned + * Group that the user needs to be a member of if `LIBGAMMA_DEVICE_REQUIRE_GROUP` is returned. */ extern gid_t libgamma_group_gid; /** * Group that the user needs to be a member of if `LIBGAMMA_DEVICE_REQUIRE_GROUP` is returned, - * `NULL` if the name of the group `libgamma_group_gid` cannot be determined + * `NULL` if the name of the group `libgamma_group_gid` cannot be determined. */ extern const char* libgamma_group_name; /** * The selected adjustment method does not exist - * or has been excluded at compile-time + * or has been excluded at compile-time. */ #define LIBGAMMA_NO_SUCH_ADJUSTMENT_METHOD (-1) /** * `errno` has be set with a standard error number - * to indicate the what has gone wrong + * to indicate the what has gone wrong. */ #define LIBGAMMA_ERRNO_SET (-2) /** - * The selected site does not exist + * The selected site does not exist. */ #define LIBGAMMA_NO_SUCH_SITE (-3) /** - * The selected partition does not exist + * The selected partition does not exist. */ #define LIBGAMMA_NO_SUCH_PARTITION (-4) /** - * The selected CRTC does not exist + * The selected CRTC does not exist. */ #define LIBGAMMA_NO_SUCH_CRTC (-5) /** - * Counter overflowed when counting the number of available items + * Counter overflowed when counting the number of available items. */ #define LIBGAMMA_IMPOSSIBLE_AMOUNT (-6) /** - * The selected connector is disabled, it does not have a CRTC + * The selected connector is disabled, it does not have a CRTC. */ #define LIBGAMMA_CONNECTOR_DISABLED (-7) /** - * The selected CRTC could not be opened, reason unknown + * The selected CRTC could not be opened, reason unknown. */ #define LIBGAMMA_OPEN_CRTC_FAILED (-8) /** - * The CRTC information field is not supported by the adjustment method + * The CRTC information field is not supported by the adjustment method. */ #define LIBGAMMA_CRTC_INFO_NOT_SUPPORTED (-9) /** - * Failed to read the current gamma ramps for the selected CRTC, reason unknown + * Failed to read the current gamma ramps for the selected CRTC, reason unknown. */ #define LIBGAMMA_GAMMA_RAMP_READ_FAILED (-10) /** - * Failed to write the current gamma ramps for the selected CRTC, reason unknown + * Failed to write the current gamma ramps for the selected CRTC, reason unknown. */ #define LIBGAMMA_GAMMA_RAMP_WRITE_FAILED (-11) /** * The specified ramp sizes does not match the ramps sizes returned by the - * adjustment methods in response to the query/command + * adjustment methods in response to the query/command. */ #define LIBGAMMA_GAMMA_RAMP_SIZE_CHANGED (-12) /** * The specified ramp sizes are not identical which is required by the adjustment method - * (Only returned in debug mode) + * (Only returned in debug mode). */ #define LIBGAMMA_MIXED_GAMMA_RAMP_SIZE (-13) /** * The specified ramp sizes are not supported by the adjustment method - * (Only returned in debug mode) + * (Only returned in debug mode). */ #define LIBGAMMA_WRONG_GAMMA_RAMP_SIZE (-14) /** - * The adjustment method reported that the gamma ramps size is 1, or perhaps even zero or negative + * The adjustment method reported that the gamma ramps size is 1, or perhaps even zero or negative. */ #define LIBGAMMA_SINGLETON_GAMMA_RAMP (-15) /** - * The adjustment method failed to list available CRTC:s, reason unknown + * The adjustment method failed to list available CRTC:s, reason unknown. */ #define LIBGAMMA_LIST_CRTCS_FAILED (-16) /** - * Failed to acquire mode resources from the adjustment method + * Failed to acquire mode resources from the adjustment method. */ #define LIBGAMMA_ACQUIRING_MODE_RESOURCES_FAILED (-17) /** - * The adjustment method reported that a negative number of partitions exists in the site + * The adjustment method reported that a negative number of partitions exists in the site. */ #define LIBGAMMA_NEGATIVE_PARTITION_COUNT (-18) /** - * The adjustment method reported that a negative number of CRTC:s exists in the partition + * The adjustment method reported that a negative number of CRTC:s exists in the partition. */ #define LIBGAMMA_NEGATIVE_CRTC_COUNT (-19) /** - * Device cannot be access becauses of insufficient permissions + * Device cannot be access becauses of insufficient permissions. */ #define LIBGAMMA_DEVICE_RESTRICTED (-20) /** - * Device cannot be access, reason unknown + * Device cannot be access, reason unknown. */ #define LIBGAMMA_DEVICE_ACCESS_FAILED (-21) /** * Device cannot be access, membership of the `libgamma_group_gid` * (named by `libgamma_group_name` (can be `NULL`, if so `errno` may - * have been set to tell why)) is required + * have been set to tell why)) is required. */ #define LIBGAMMA_DEVICE_REQUIRE_GROUP (-22) /** - * The graphics card appear to have been removed + * The graphics card appear to have been removed. */ #define LIBGAMMA_GRAPHICS_CARD_REMOVED (-23) /** - * The state of the requested information is unknown + * The state of the requested information is unknown. */ #define LIBGAMMA_STATE_UNKNOWN (-24) /** - * Failed to determine which connector the CRTC belongs to + * Failed to determine which connector the CRTC belongs to. */ #define LIBGAMMA_CONNECTOR_UNKNOWN (-25) /** - * The detected connector type is not listed in this library and has to be updated + * The detected connector type is not listed in this library and has to be updated. */ #define LIBGAMMA_CONNECTOR_TYPE_NOT_RECOGNISED (-26) /** - * The detected subpixel order is not listed in this library and has to be updated + * The detected subpixel order is not listed in this library and has to be updated. */ #define LIBGAMMA_SUBPIXEL_ORDER_NOT_RECOGNISED (-27) /** - * The length of the EDID does not match that of any supported EDID structure revision + * The length of the EDID does not match that of any supported EDID structure revision. */ #define LIBGAMMA_EDID_LENGTH_UNSUPPORTED (-28) /** - * The magic number in the EDID does not match that of any supported EDID structure revision + * The magic number in the EDID does not match that of any supported EDID structure revision. */ #define LIBGAMMA_EDID_WRONG_MAGIC_NUMBER (-29) /** - * The EDID structure revision used by the monitor is not supported + * The EDID structure revision used by the monitor is not supported. */ #define LIBGAMMA_EDID_REVISION_UNSUPPORTED (-30) /** - * The gamma characteristics field in the EDID is left unspecified - * (This could be considered a non-error) + * The gamma characteristics field in the EDID is left unspecified. + * (This could be considered a non-error.) */ #define LIBGAMMA_GAMMA_NOT_SPECIFIED (-31) @@ -208,72 +208,72 @@ extern const char* libgamma_group_name; /** * Both of the errors `LIBGAMMA_GAMMA_NOT_SPECIFIED` and - * `LIBGAMMA_EDID_CHECKSUM_ERROR` have occurred + * `LIBGAMMA_EDID_CHECKSUM_ERROR` have occurred. */ #define LIBGAMMA_GAMMA_NOT_SPECIFIED_AND_EDID_CHECKSUM_ERROR (-33) /** - * Failed to query the gamma ramps size from the adjustment method, reason unknown + * Failed to query the gamma ramps size from the adjustment method, reason unknown. */ #define LIBGAMMA_GAMMA_RAMPS_SIZE_QUERY_FAILED (-34) /** - * The selected partition could not be opened, reason unknown + * The selected partition could not be opened, reason unknown. */ #define LIBGAMMA_OPEN_PARTITION_FAILED (-35) /** - * The selected site could not be opened, reason unknown + * The selected site could not be opened, reason unknown. */ #define LIBGAMMA_OPEN_SITE_FAILED (-36) /** - * Failed to query the adjustment method for its protocol version, reason unknown + * Failed to query the adjustment method for its protocol version, reason unknown. */ #define LIBGAMMA_PROTOCOL_VERSION_QUERY_FAILED (-37) /** - * The adjustment method's version of its protocol is not supported + * The adjustment method's version of its protocol is not supported. */ #define LIBGAMMA_PROTOCOL_VERSION_NOT_SUPPORTED (-38) /** - * The adjustment method failed to list available partitions, reason unknown + * The adjustment method failed to list available partitions, reason unknown. */ #define LIBGAMMA_LIST_PARTITIONS_FAILED (-39) /** - * Partition exists by index, but the partition at that index does not exist + * Partition exists by index, but the partition at that index does not exist. */ #define LIBGAMMA_NULL_PARTITION (-40) /** - * There is not monitor connected to the connector of the selected CRTC + * There is not monitor connected to the connector of the selected CRTC. */ #define LIBGAMMA_NOT_CONNECTED (-41) /** - * Data extraction from a reply from the adjustment method failed, reason unknown + * Data extraction from a reply from the adjustment method failed, reason unknown. */ #define LIBGAMMA_REPLY_VALUE_EXTRACTION_FAILED (-42) /** - * No EDID property was found on the output + * No EDID property was found on the output. */ #define LIBGAMMA_EDID_NOT_FOUND (-43) /** - * Failed to list properties on the output, reason unknown + * Failed to list properties on the output, reason unknown. */ #define LIBGAMMA_LIST_PROPERTIES_FAILED (-44) /** - * Failed to query a property's value from the output, reason unknown + * Failed to query a property's value from the output, reason unknown. */ #define LIBGAMMA_PROPERTY_VALUE_QUERY_FAILED (-45) /** - * A request for information on an output failed, reason unknown + * A request for information on an output failed, reason unknown. */ #define LIBGAMMA_OUTPUT_INFORMATION_QUERY_FAILED (-46) diff --git a/src/libgamma-facade.c b/src/libgamma-facade.c index 528a2fd..3f199a1 100644 --- a/src/libgamma-facade.c +++ b/src/libgamma-facade.c @@ -80,10 +80,10 @@ #ifdef HAVE_GAMMA_METHODS # ifdef HAVE_GAMMA_METHOD_LINUX_DRM /** - * Test whether a file descriptor refers to a VT + * Test whether a file descriptor refers to a VT. * - * @param fd The file descriptor - * @return Whether the file descriptor refers to a VT + * @param fd The file descriptor. + * @return Whether the file descriptor refers to a VT. */ static int libgamma_is_vt_proper(int fd) { @@ -103,9 +103,9 @@ static int libgamma_is_vt_proper(int fd) /** - * Test the availability of an adjustment method + * Test the availability of an adjustment method. * - * @param method The adjustment method + * @param method The adjustment method. * @param operation Allowed values: * 0: Pass if the environment suggests it will work but is not fake. * 1: Pass if the environment suggests it will work. @@ -113,7 +113,7 @@ static int libgamma_is_vt_proper(int fd) * 3: Pass if real. * 4: Always pass. * Other values invoke undefined behaviour. - * @return Whether the test passed + * @return Whether the test passed. */ static int libgamma_list_method_test(int method, int operation) { @@ -156,12 +156,12 @@ static int libgamma_list_method_test(int method, int operation) /** - * List available adjustment methods by their order of preference based on the environment + * List available adjustment methods by their order of preference based on the environment. * * @param methods Output array of methods, should be able to hold `GAMMA_METHOD_COUNT` elements - * @þaram buf_size The number of elements that fits in `methods`, it should be `GAMMA_METHOD_COUNT`, + * @param buf_size The number of elements that fits in `methods`, it should be `GAMMA_METHOD_COUNT`, * This is used to avoid writing outside the output buffer if this library adds new - * adjustment methods without the users of the library recompiling + * adjustment methods without the users of the library recompiling. * @param operation Allowed values: * 0: Methods that the environment suggests will work, excluding fake. * 1: Methods that the environment suggests will work, including fake. @@ -170,7 +170,7 @@ static int libgamma_list_method_test(int method, int operation) * 4: All methods. * Other values invoke undefined behaviour. * @return The number of element that have been stored in `methods`, or should - * have been stored if the buffer was large enought + * have been stored if the buffer was large enought. */ size_t libgamma_list_methods(int* restrict methods, size_t buf_size, int operation) { @@ -212,10 +212,10 @@ size_t libgamma_list_methods(int* restrict methods, size_t buf_size, int operati /** - * Return the capabilities of an adjustment method + * Return the capabilities of an adjustment method. * - * @param this The data structure to fill with the method's capabilities - * @param method The adjustment method (display server and protocol) + * @param this The data structure to fill with the method's capabilities. + * @param method The adjustment method (display server and protocol.) */ void libgamma_method_capabilities(libgamma_method_capabilities_t* restrict this, int method) { @@ -263,9 +263,9 @@ void libgamma_method_capabilities(libgamma_method_capabilities_t* restrict this, /** - * Return the capabilities of an adjustment method + * Return the capabilities of an adjustment method. * - * @param method The adjustment method (display server and protocol) + * @param method The adjustment method (display server and protocol.) * @return The default site, `NULL` if it cannot be determined or * if multiple sites are not supported by the adjustment * method. This value should not be free:d. @@ -287,9 +287,9 @@ char* libgamma_method_default_site(int method) /** - * Return the capabilities of an adjustment method + * Return the capabilities of an adjustment method. * - * @param method The adjustment method (display server and protocol) + * @param method The adjustment method (display server and protocol.) * @return The environ variables that is used to determine the * default site. `NULL` if there is none, that is, if * the method does not support multiple sites. @@ -317,10 +317,10 @@ const char* libgamma_method_default_site_variable(int method) /** - * Initialise an allocated site state + * Initialise an allocated site state. * - * @param this The site state to initialise - * @param method The adjustment method (display server and protocol) + * @param this The site state to initialise. + * @param method The adjustment method (display server and protocol.) * @param site The site identifier, unless it is `NULL` it must a * `free`:able. One the state is destroyed the library * will attempt to free it. There you should not free @@ -328,7 +328,7 @@ const char* libgamma_method_default_site_variable(int method) * or allocate on the stack. Note however that it will * not be free:d if this function fails. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_site_initialise(libgamma_site_state_t* restrict this, int method, char* restrict site) @@ -370,9 +370,9 @@ int libgamma_site_initialise(libgamma_site_state_t* restrict this, /** - * Release all resources held by a site state + * Release all resources held by a site state. * - * @param this The site state + * @param this The site state. */ void libgamma_site_destroy(libgamma_site_state_t* restrict this) { @@ -420,9 +420,9 @@ void libgamma_site_destroy(libgamma_site_state_t* restrict this) /** * Release all resources held by a site state - * and free the site state pointer + * and free the site state pointer. * - * @param this The site state + * @param this The site state. */ void libgamma_site_free(libgamma_site_state_t* restrict this) { @@ -432,11 +432,11 @@ void libgamma_site_free(libgamma_site_state_t* restrict this) /** - * Restore the gamma ramps all CRTCS with a site to the system settings + * Restore the gamma ramps all CRTC:s with a site to the system settings. * - * @param this The site state + * @param this The site state. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_site_restore(libgamma_site_state_t* restrict this) { @@ -475,13 +475,13 @@ int libgamma_site_restore(libgamma_site_state_t* restrict this) /** - * Initialise an allocated partition state + * Initialise an allocated partition state. * - * @param this The partition state to initialise - * @param site The site state for the site that the partition belongs to - * @param partition The the index of the partition within the site + * @param this The partition state to initialise. + * @param site The site state for the site that the partition belongs to. + * @param partition The the index of the partition within the site. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_partition_initialise(libgamma_partition_state_t* restrict this, libgamma_site_state_t* restrict site, size_t partition) @@ -523,9 +523,9 @@ int libgamma_partition_initialise(libgamma_partition_state_t* restrict this, /** - * Release all resources held by a partition state + * Release all resources held by a partition state. * - * @param this The partition state + * @param this The partition state. */ void libgamma_partition_destroy(libgamma_partition_state_t* restrict this) { @@ -572,9 +572,9 @@ void libgamma_partition_destroy(libgamma_partition_state_t* restrict this) /** * Release all resources held by a partition state - * and free the partition state pointer + * and free the partition state pointer. * - * @param this The partition state + * @param this The partition state. */ void libgamma_partition_free(libgamma_partition_state_t* restrict this) { @@ -584,11 +584,11 @@ void libgamma_partition_free(libgamma_partition_state_t* restrict this) /** - * Restore the gamma ramps all CRTCS with a partition to the system settings + * Restore the gamma ramps all CRTC:s with a partition to the system settings. * - * @param this The partition state + * @param this The partition state. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_partition_restore(libgamma_partition_state_t* restrict this) { @@ -627,13 +627,13 @@ int libgamma_partition_restore(libgamma_partition_state_t* restrict this) /** - * Initialise an allocated CRTC state + * Initialise an allocated CRTC state. * - * @param this The CRTC state to initialise - * @param partition The partition state for the partition that the CRTC belongs to - * @param crtc The the index of the CRTC within the site + * @param this The CRTC state to initialise. + * @param partition The partition state for the partition that the CRTC belongs to. + * @param crtc The the index of the CRTC within the site. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_crtc_initialise(libgamma_crtc_state_t* restrict this, libgamma_partition_state_t* restrict partition, size_t crtc) @@ -675,9 +675,9 @@ int libgamma_crtc_initialise(libgamma_crtc_state_t* restrict this, /** - * Release all resources held by a CRTC state + * Release all resources held by a CRTC state. * - * @param this The CRTC state + * @param this The CRTC state. */ void libgamma_crtc_destroy(libgamma_crtc_state_t* restrict this) { @@ -724,9 +724,9 @@ void libgamma_crtc_destroy(libgamma_crtc_state_t* restrict this) /** * Release all resources held by a CRTC state - * and free the CRTC state pointer + * and free the CRTC state pointer. * - * @param this The CRTC state + * @param this The CRTC state. */ void libgamma_crtc_free(libgamma_crtc_state_t* restrict this) { @@ -736,11 +736,11 @@ void libgamma_crtc_free(libgamma_crtc_state_t* restrict this) /** - * Restore the gamma ramps for a CRTC to the system settings for that CRTC + * Restore the gamma ramps for a CRTC to the system settings for that CRTC. * - * @param this The CRTC state + * @param this The CRTC state. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_crtc_restore(libgamma_crtc_state_t* restrict this) { @@ -779,11 +779,11 @@ int libgamma_crtc_restore(libgamma_crtc_state_t* restrict this) /** - * Read information about a CRTC + * Read information about a CRTC. * - * @param this Instance of a data structure to fill with the information about the CRTC - * @param crtc The state of the CRTC whose information should be read - * @param fields OR:ed identifiers for the information about the CRTC that should be read + * @param this Instance of a data structure to fill with the information about the CRTC. + * @param crtc The state of the CRTC whose information should be read. + * @param fields OR:ed identifiers for the information about the CRTC that should be read. * @return Zero on success, -1 on error. On error refer to the error reports in `this`. */ int libgamma_get_crtc_information(libgamma_crtc_information_t* restrict this, @@ -830,9 +830,9 @@ int libgamma_get_crtc_information(libgamma_crtc_information_t* restrict this, /** - * Release all resources in an information data structure for a CRTC + * Release all resources in an information data structure for a CRTC. * - * @param this The CRTC information + * @param this The CRTC information. */ void libgamma_crtc_information_destroy(libgamma_crtc_information_t* restrict this) { @@ -843,9 +843,9 @@ void libgamma_crtc_information_destroy(libgamma_crtc_information_t* restrict thi /** * Release all resources in an information data structure for a CRTC - * and free the data structure pointer + * and free the data structure pointer. * - * @param this The CRTC information + * @param this The CRTC information. */ void libgamma_crtc_information_free(libgamma_crtc_information_t* restrict this) { @@ -855,12 +855,12 @@ void libgamma_crtc_information_free(libgamma_crtc_information_t* restrict this) /** - * Convert a raw representation of an EDID to a lowercase hexadecimal representation + * Convert a raw representation of an EDID to a lowercase hexadecimal representation. * - * @param edid The EDID in raw representation - * @param length The length of `edid` + * @param edid The EDID in raw representation. + * @param length The length of `edid`. * @retrun The EDID in lowercase hexadecimal representation, - * `NULL` on allocation error, `errno` will be set accordingly + * `NULL` on allocation error, `errno` will be set accordingly. */ char* libgamma_behex_edid_lowercase(const unsigned char* restrict edid, size_t length) { @@ -882,12 +882,12 @@ char* libgamma_behex_edid_lowercase(const unsigned char* restrict edid, size_t l /** - * Convert a raw representation of an EDID to an uppercase hexadecimal representation + * Convert a raw representation of an EDID to an uppercase hexadecimal representation. * - * @param edid The EDID in raw representation - * @param length The length of `edid` + * @param edid The EDID in raw representation. + * @param length The length of `edid`. * @retrun The EDID in uppercase hexadecimal representation, - * NULL` on allocation error, `errno` will be set accordingly + * NULL` on allocation error, `errno` will be set accordingly. */ char* libgamma_behex_edid_uppercase(const unsigned char* restrict edid, size_t length) { @@ -909,9 +909,9 @@ char* libgamma_behex_edid_uppercase(const unsigned char* restrict edid, size_t l /** - * Convert an hexadecimal representation of an EDID to a raw representation + * Convert an hexadecimal representation of an EDID to a raw representation. * - * @param edid The EDID in hexadecimal representation + * @param edid The EDID in hexadecimal representation. * @retrun The EDID in raw representation, it will be half the length * of `edid` (the input value). `NULL` on allocation error or * if the EDID is malformated, `errno` will be set accordingly. @@ -958,12 +958,12 @@ unsigned char* libgamma_unhex_edid(const char* restrict edid) /** - * Get current the gamma ramps for a CRTC, 16-bit gamma-depth version + * Get current the gamma ramps for a CRTC, 16-bit gamma-depth version. * - * @param this The CRTC state - * @param ramps The gamma ramps to fill with the current values + * @param this The CRTC state. + * @param ramps The gamma ramps to fill with the current values. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_crtc_get_gamma_ramps(libgamma_crtc_state_t* restrict this, libgamma_gamma_ramps_t* restrict ramps) @@ -1011,12 +1011,12 @@ int libgamma_crtc_get_gamma_ramps(libgamma_crtc_state_t* restrict this, /** - * Set the gamma ramps for a CRTC, 16-bit gamma-depth version + * Set the gamma ramps for a CRTC, 16-bit gamma-depth version. * - * @param this The CRTC state - * @param ramps The gamma ramps to apply + * @param this The CRTC state. + * @param ramps The gamma ramps to apply. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_crtc_set_gamma_ramps(libgamma_crtc_state_t* restrict this, libgamma_gamma_ramps_t ramps) @@ -1065,12 +1065,12 @@ int libgamma_crtc_set_gamma_ramps(libgamma_crtc_state_t* restrict this, /** - * Get current the gamma ramps for a CRTC, 32-bit gamma-depth version + * Get current the gamma ramps for a CRTC, 32-bit gamma-depth version. * - * @param this The CRTC state - * @param ramps The gamma ramps to fill with the current values + * @param this The CRTC state. + * @param ramps The gamma ramps to fill with the current values. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_crtc_get_gamma_ramps32(libgamma_crtc_state_t* restrict this, libgamma_gamma_ramps32_t* restrict ramps) @@ -1098,12 +1098,12 @@ int libgamma_crtc_get_gamma_ramps32(libgamma_crtc_state_t* restrict this, /** - * Set the gamma ramps for a CRTC, 32-bit gamma-depth version + * Set the gamma ramps for a CRTC, 32-bit gamma-depth version. * - * @param this The CRTC state - * @param ramps The gamma ramps to apply + * @param this The CRTC state. + * @param ramps The gamma ramps to apply. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_crtc_set_gamma_ramps32(libgamma_crtc_state_t* restrict this, libgamma_gamma_ramps32_t ramps) @@ -1132,12 +1132,12 @@ int libgamma_crtc_set_gamma_ramps32(libgamma_crtc_state_t* restrict this, /** - * Get current the gamma ramps for a CRTC, 64-bit gamma-depth version + * Get current the gamma ramps for a CRTC, 64-bit gamma-depth version. * - * @param this The CRTC state - * @param ramps The gamma ramps to fill with the current values + * @param this The CRTC state. + * @param ramps The gamma ramps to fill with the current values. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_crtc_get_gamma_ramps64(libgamma_crtc_state_t* restrict this, libgamma_gamma_ramps64_t* restrict ramps) @@ -1165,12 +1165,12 @@ int libgamma_crtc_get_gamma_ramps64(libgamma_crtc_state_t* restrict this, /** - * Set the gamma ramps for a CRTC, 64-bit gamma-depth version + * Set the gamma ramps for a CRTC, 64-bit gamma-depth version. * - * @param this The CRTC state - * @param ramps The gamma ramps to apply + * @param this The CRTC state. + * @param ramps The gamma ramps to apply. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_crtc_set_gamma_ramps64(libgamma_crtc_state_t* restrict this, libgamma_gamma_ramps64_t ramps) @@ -1199,12 +1199,12 @@ int libgamma_crtc_set_gamma_ramps64(libgamma_crtc_state_t* restrict this, /** - * Get current the gamma ramps for a CRTC, `float` version + * Get current the gamma ramps for a CRTC, `float` version. * - * @param this The CRTC state - * @param ramps The gamma ramps to fill with the current values + * @param this The CRTC state. + * @param ramps The gamma ramps to fill with the current values. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_crtc_get_gamma_rampsf(libgamma_crtc_state_t* restrict this, libgamma_gamma_rampsf_t* restrict ramps) @@ -1230,12 +1230,12 @@ int libgamma_crtc_get_gamma_rampsf(libgamma_crtc_state_t* restrict this, /** - * Set the gamma ramps for a CRTC, `float` version + * Set the gamma ramps for a CRTC, `float` version. * - * @param this The CRTC state - * @param ramps The gamma ramps to apply + * @param this The CRTC state. + * @param ramps The gamma ramps to apply. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_crtc_set_gamma_rampsf(libgamma_crtc_state_t* restrict this, libgamma_gamma_rampsf_t ramps) @@ -1264,12 +1264,12 @@ int libgamma_crtc_set_gamma_rampsf(libgamma_crtc_state_t* restrict this, /** - * Get current the gamma ramps for a CRTC, `double` version + * Get current the gamma ramps for a CRTC, `double` version. * - * @param this The CRTC state - * @param ramps The gamma ramps to fill with the current values + * @param this The CRTC state. + * @param ramps The gamma ramps to fill with the current values. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_crtc_get_gamma_rampsd(libgamma_crtc_state_t* restrict this, libgamma_gamma_rampsd_t* restrict ramps) @@ -1297,12 +1297,12 @@ int libgamma_crtc_get_gamma_rampsd(libgamma_crtc_state_t* restrict this, /** - * Set the gamma ramps for a CRTC, `double` version + * Set the gamma ramps for a CRTC, `double` version. * - * @param this The CRTC state - * @param ramps The gamma ramps to apply + * @param this The CRTC state. + * @param ramps The gamma ramps to apply. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_crtc_set_gamma_rampsd(libgamma_crtc_state_t* restrict this, libgamma_gamma_rampsd_t ramps) @@ -1331,14 +1331,14 @@ int libgamma_crtc_set_gamma_rampsd(libgamma_crtc_state_t* restrict this, /** - * Set the gamma ramps for a CRTC, 16-bit gamma-depth function version + * Set the gamma ramps for a CRTC, 16-bit gamma-depth function version. * - * Note that this will probably involve the library allocating temporary data + * Note that this will probably involve the library allocating temporary data. * - * @param this The CRTC state - * @param ramps The gamma ramps to apply + * @param this The CRTC state. + * @param ramps The gamma ramps to apply. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_crtc_set_gamma_ramps_f(libgamma_crtc_state_t* restrict this, libgamma_gamma_ramps_fun* red_function, @@ -1384,14 +1384,14 @@ int libgamma_crtc_set_gamma_ramps_f(libgamma_crtc_state_t* restrict this, /** - * Set the gamma ramps for a CRTC, 32-bit gamma-depth function version + * Set the gamma ramps for a CRTC, 32-bit gamma-depth function version. * - * Note that this will probably involve the library allocating temporary data + * Note that this will probably involve the library allocating temporary data. * - * @param this The CRTC state - * @param ramps The gamma ramps to apply + * @param this The CRTC state. + * @param ramps The gamma ramps to apply. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_crtc_set_gamma_ramps32_f(libgamma_crtc_state_t* restrict this, libgamma_gamma_ramps32_fun* red_function, @@ -1437,14 +1437,14 @@ int libgamma_crtc_set_gamma_ramps32_f(libgamma_crtc_state_t* restrict this, /** - * Set the gamma ramps for a CRTC, 64-bit gamma-depth function version + * Set the gamma ramps for a CRTC, 64-bit gamma-depth function version. * - * Note that this will probably involve the library allocating temporary data + * Note that this will probably involve the library allocating temporary data. * - * @param this The CRTC state - * @param ramps The gamma ramps to apply + * @param this The CRTC state. + * @param ramps The gamma ramps to apply. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_crtc_set_gamma_ramps64_f(libgamma_crtc_state_t* restrict this, libgamma_gamma_ramps64_fun* red_function, @@ -1490,14 +1490,14 @@ int libgamma_crtc_set_gamma_ramps64_f(libgamma_crtc_state_t* restrict this, /** - * Set the gamma ramps for a CRTC, `float` function version + * Set the gamma ramps for a CRTC, `float` function version. * - * Note that this will probably involve the library allocating temporary data + * Note that this will probably involve the library allocating temporary data. * - * @param this The CRTC state - * @param ramps The gamma ramps to apply + * @param this The CRTC state. + * @param ramps The gamma ramps to apply. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_crtc_set_gamma_rampsf_f(libgamma_crtc_state_t* restrict this, libgamma_gamma_rampsf_fun* red_function, @@ -1543,14 +1543,14 @@ int libgamma_crtc_set_gamma_rampsf_f(libgamma_crtc_state_t* restrict this, /** - * Set the gamma ramps for a CRTC, `double` function version + * Set the gamma ramps for a CRTC, `double` function version. * - * Note that this will probably involve the library allocating temporary data + * Note that this will probably involve the library allocating temporary data. * - * @param this The CRTC state - * @param ramps The gamma ramps to apply + * @param this The CRTC state. + * @param ramps The gamma ramps to apply. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_crtc_set_gamma_rampsd_f(libgamma_crtc_state_t* restrict this, libgamma_gamma_rampsd_fun* red_function, diff --git a/src/libgamma-facade.h b/src/libgamma-facade.h index f3d6ef8..8f17a04 100644 --- a/src/libgamma-facade.h +++ b/src/libgamma-facade.h @@ -31,55 +31,55 @@ /** - * Mapping function from [0, 1] float encoding value to [0, 2¹⁶ − 1] integer output value + * Mapping function from [0, 1] float encoding value to [0, 2¹⁶ − 1] integer output value. * - * @param encoding [0, 1] float encoding value - * @return [0, 2¹⁶ − 1] integer output value + * @param encoding [0, 1] float encoding value. + * @return [0, 2¹⁶ − 1] integer output value. */ typedef uint16_t libgamma_gamma_ramps_fun(float encoding); /** - * Mapping function from [0, 1] float encoding value to [0, 2³² − 1] integer output value + * Mapping function from [0, 1] float encoding value to [0, 2³² − 1] integer output value. * - * @param encoding [0, 1] float encoding value - * @return [0, 2³² − 1] integer output value + * @param encoding [0, 1] float encoding value. + * @return [0, 2³² − 1] integer output value. */ typedef uint32_t libgamma_gamma_ramps32_fun(float encoding); /** - * Mapping function from [0, 1] float encoding value to [0, 2⁶⁴ − 1] integer output value + * Mapping function from [0, 1] float encoding value to [0, 2⁶⁴ − 1] integer output value. * - * @param encoding [0, 1] float encoding value - * @return [0, 2⁶⁴ − 1] integer output value + * @param encoding [0, 1] float encoding value. + * @return [0, 2⁶⁴ − 1] integer output value. */ typedef uint64_t libgamma_gamma_ramps64_fun(float encoding); /** - * Mapping function from [0, 1] float encoding value to [0, 1] float output value + * Mapping function from [0, 1] float encoding value to [0, 1] float output value. * - * @param encoding [0, 1] float encoding value - * @return [0, 1] float output value + * @param encoding [0, 1] float encoding value. + * @return [0, 1] float output value. */ typedef float libgamma_gamma_rampsf_fun(float encoding); /** * Mapping function from [0, 1] double precision float encoding - * value to [0, 1] double precision float output value + * value to [0, 1] double precision float output value. * - * @param encoding [0, 1] float encoding value - * @return [0, 1] float output value + * @param encoding [0, 1] float encoding value. + * @return [0, 1] float output value. */ typedef double libgamma_gamma_rampsd_fun(double encoding); /** - * List available adjustment methods by their order of preference based on the environment + * List available adjustment methods by their order of preference based on the environment. * * @param methods Output array of methods, should be able to hold `GAMMA_METHOD_COUNT` elements - * @þaram buf_size The number of elements that fits in `methods`, it should be `GAMMA_METHOD_COUNT`, + * @param buf_size The number of elements that fits in `methods`, it should be `GAMMA_METHOD_COUNT`, * This is used to avoid writing outside the output buffer if this library adds new - * adjustment methods without the users of the library recompiling + * adjustment methods without the users of the library recompiling. * @param operation Allowed values: * 0: Methods that the environment suggests will work, excluding fake. * 1: Methods that the environment suggests will work, including fake. @@ -88,22 +88,22 @@ typedef double libgamma_gamma_rampsd_fun(double encoding); * 4: All methods. * Other values invoke undefined behaviour. * @return The number of element that have been stored in `methods`, or should - * have been stored if the buffer was large enought + * have been stored if the buffer was large enought. */ size_t libgamma_list_methods(int* restrict methods, size_t buf_size, int operation); /** - * Return the capabilities of an adjustment method + * Return the capabilities of an adjustment method. * * @param this The data structure to fill with the method's capabilities - * @param method The adjustment method (display server and protocol) + * @param method The adjustment method (display server and protocol). */ void libgamma_method_capabilities(libgamma_method_capabilities_t* restrict this, int method); /** - * Return the capabilities of an adjustment method + * Return the capabilities of an adjustment method. * - * @param method The adjustment method (display server and protocol) + * @param method The adjustment method (display server and protocol.) * @return The default site, `NULL` if it cannot be determined or * if multiple sites are not supported by the adjustment * method. This value should not be free:d. @@ -111,9 +111,9 @@ void libgamma_method_capabilities(libgamma_method_capabilities_t* restrict this, char* libgamma_method_default_site(int method); /** - * Return the capabilities of an adjustment method + * Return the capabilities of an adjustment method. * - * @param method The adjustment method (display server and protocol) + * @param method The adjustment method (display server and protocol.) * @return The environ variables that is used to determine the * default site. `NULL` if there is none, that is, if * the method does not support multiple sites. @@ -123,10 +123,10 @@ const char* libgamma_method_default_site_variable(int method) __attribute__((con /** - * Initialise an allocated site state + * Initialise an allocated site state. * - * @param this The site state to initialise - * @param method The adjustment method (display server and protocol) + * @param this The site state to initialise. + * @param method The adjustment method (display server and protocol.) * @param site The site identifier, unless it is `NULL` it must a * `free`:able. One the state is destroyed the library * will attempt to free it. There you should not free @@ -134,171 +134,171 @@ const char* libgamma_method_default_site_variable(int method) __attribute__((con * or allocate on the stack. Note however that it will * not be free:d if this function fails. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_site_initialise(libgamma_site_state_t* restrict this, int method, char* restrict site); /** - * Release all resources held by a site state + * Release all resources held by a site state. * - * @param this The site state + * @param this The site state. */ void libgamma_site_destroy(libgamma_site_state_t* restrict this); /** * Release all resources held by a site state - * and free the site state pointer + * and free the site state pointer. * - * @param this The site state + * @param this The site state. */ void libgamma_site_free(libgamma_site_state_t* restrict this); /** - * Restore the gamma ramps all CRTCS with a site to the system settings + * Restore the gamma ramps all CRTC:s with a site to the system settings. * - * @param this The site state + * @param this The site state. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_site_restore(libgamma_site_state_t* restrict this); /** - * Initialise an allocated partition state + * Initialise an allocated partition state. * - * @param this The partition state to initialise - * @param site The site state for the site that the partition belongs to - * @param partition The the index of the partition within the site + * @param this The partition state to initialise. + * @param site The site state for the site that the partition belongs to. + * @param partition The the index of the partition within the site. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_partition_initialise(libgamma_partition_state_t* restrict this, libgamma_site_state_t* restrict site, size_t partition); /** - * Release all resources held by a partition state + * Release all resources held by a partition state. * - * @param this The partition state + * @param this The partition state. */ void libgamma_partition_destroy(libgamma_partition_state_t* restrict this); /** * Release all resources held by a partition state - * and free the partition state pointer + * and free the partition state pointer. * - * @param this The partition state + * @param this The partition state. */ void libgamma_partition_free(libgamma_partition_state_t* restrict this); /** - * Restore the gamma ramps all CRTCS with a partition to the system settings + * Restore the gamma ramps all CRTC:s with a partition to the system settings. * - * @param this The partition state + * @param this The partition state. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_partition_restore(libgamma_partition_state_t* restrict this); /** - * Initialise an allocated CRTC state + * Initialise an allocated CRTC state. * - * @param this The CRTC state to initialise - * @param partition The partition state for the partition that the CRTC belongs to - * @param crtc The the index of the CRTC within the site + * @param this The CRTC state to initialise. + * @param partition The partition state for the partition that the CRTC belongs to. + * @param crtc The the index of the CRTC within the site. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_crtc_initialise(libgamma_crtc_state_t* restrict this, libgamma_partition_state_t* restrict partition, size_t crtc); /** - * Release all resources held by a CRTC state + * Release all resources held by a CRTC state. * - * @param this The CRTC state + * @param this The CRTC state. */ void libgamma_crtc_destroy(libgamma_crtc_state_t* restrict this); /** * Release all resources held by a CRTC state - * and free the CRTC state pointer + * and free the CRTC state pointer. * - * @param this The CRTC state + * @param this The CRTC state. */ void libgamma_crtc_free(libgamma_crtc_state_t* restrict this); /** - * Restore the gamma ramps for a CRTC to the system settings for that CRTC + * Restore the gamma ramps for a CRTC to the system settings for that CRTC. * * @param this The CRTC state * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_crtc_restore(libgamma_crtc_state_t* restrict this); /** - * Read information about a CRTC + * Read information about a CRTC. * - * @param this Instance of a data structure to fill with the information about the CRTC - * @param crtc The state of the CRTC whose information should be read - * @param fields OR:ed identifiers for the information about the CRTC that should be read + * @param this Instance of a data structure to fill with the information about the CRTC. + * @param crtc The state of the CRTC whose information should be read. + * @param fields OR:ed identifiers for the information about the CRTC that should be read. * @return Zero on success, -1 on error. On error refer to the error reports in `this`. */ int libgamma_get_crtc_information(libgamma_crtc_information_t* restrict this, libgamma_crtc_state_t* restrict crtc, int32_t fields); /** - * Release all resources in an information data structure for a CRTC + * Release all resources in an information data structure for a CRTC. * - * @param this The CRTC information + * @param this The CRTC information. */ void libgamma_crtc_information_destroy(libgamma_crtc_information_t* restrict this); /** * Release all resources in an information data structure for a CRTC - * and free the data structure pointer + * and free the data structure pointer. * - * @param this The CRTC information + * @param this The CRTC information. */ void libgamma_crtc_information_free(libgamma_crtc_information_t* restrict this); /** - * Convert a raw representation of an EDID to a lowercase hexadecimal representation + * Convert a raw representation of an EDID to a lowercase hexadecimal representation. * - * @param edid:const unsigned char* The EDID in raw representation - * @param length:size_t The length of `edid` + * @param edid:const unsigned char* The EDID in raw representation. + * @param length:size_t The length of `edid`. * @return :char* The EDID in lowercase hexadecimal representation, - * `NULL` on allocation error, `errno` will be set accordingly + * `NULL` on allocation error, `errno` will be set accordingly. */ #define libgamma_behex_edid(edid, length) \ libgamma_behex_edid_lowercase(edid, length) /** - * Convert a raw representation of an EDID to a lowercase hexadecimal representation + * Convert a raw representation of an EDID to a lowercase hexadecimal representation. * - * @param edid The EDID in raw representation - * @param length The length of `edid` + * @param edid The EDID in raw representation. + * @param length The length of `edid`. * @retrun The EDID in lowercase hexadecimal representation, - * `NULL` on allocation error, `errno` will be set accordingly + * `NULL` on allocation error, `errno` will be set accordingly. */ char* libgamma_behex_edid_lowercase(const unsigned char* restrict edid, size_t length); /** - * Convert a raw representation of an EDID to an uppercase hexadecimal representation + * Convert a raw representation of an EDID to an uppercase hexadecimal representation. * - * @param edid The EDID in raw representation - * @param length The length of `edid` + * @param edid The EDID in raw representation. + * @param length The length of `edid`. * @retrun The EDID in uppercase hexadecimal representation, - * NULL` on allocation error, `errno` will be set accordingly + * NULL` on allocation error, `errno` will be set accordingly. */ char* libgamma_behex_edid_uppercase(const unsigned char* restrict edid, size_t length); /** - * Convert an hexadecimal representation of an EDID to a raw representation + * Convert an hexadecimal representation of an EDID to a raw representation. * - * @param edid The EDID in hexadecimal representation + * @param edid The EDID in hexadecimal representation. * @retrun The EDID in raw representation, it will be half the length * of `edid` (the input value). `NULL` on allocation error or * if the EDID is malformated, `errno` will be set accordingly. @@ -307,129 +307,129 @@ unsigned char* libgamma_unhex_edid(const char* restrict edid); /** - * Get current the gamma ramps for a CRTC, 16-bit gamma-depth version + * Get current the gamma ramps for a CRTC, 16-bit gamma-depth version. * - * @param this The CRTC state + * @param this The CRTC state. * @param ramps The gamma ramps to fill with the current values * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_crtc_get_gamma_ramps(libgamma_crtc_state_t* restrict this, libgamma_gamma_ramps_t* restrict ramps); /** - * Set the gamma ramps for a CRTC, 16-bit gamma-depth version + * Set the gamma ramps for a CRTC, 16-bit gamma-depth version. * - * @param this The CRTC state - * @param ramps The gamma ramps to apply + * @param this The CRTC state. + * @param ramps The gamma ramps to apply. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_crtc_set_gamma_ramps(libgamma_crtc_state_t* restrict this, libgamma_gamma_ramps_t ramps) __attribute__((hot)); /** - * Get current the gamma ramps for a CRTC, 32-bit gamma-depth version + * Get current the gamma ramps for a CRTC, 32-bit gamma-depth version. * - * @param this The CRTC state - * @param ramps The gamma ramps to fill with the current values + * @param this The CRTC state. + * @param ramps The gamma ramps to fill with the current values. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_crtc_get_gamma_ramps32(libgamma_crtc_state_t* restrict this, libgamma_gamma_ramps32_t* restrict ramps); /** - * Set the gamma ramps for a CRTC, 32-bit gamma-depth version + * Set the gamma ramps for a CRTC, 32-bit gamma-depth version. * - * @param this The CRTC state - * @param ramps The gamma ramps to apply + * @param this The CRTC state. + * @param ramps The gamma ramps to apply. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_crtc_set_gamma_ramps32(libgamma_crtc_state_t* restrict this, libgamma_gamma_ramps32_t ramps); /** - * Get current the gamma ramps for a CRTC, 64-bit gamma-depth version + * Get current the gamma ramps for a CRTC, 64-bit gamma-depth version. * - * @param this The CRTC state - * @param ramps The gamma ramps to fill with the current values + * @param this The CRTC state. + * @param ramps The gamma ramps to fill with the current values. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_crtc_get_gamma_ramps64(libgamma_crtc_state_t* restrict this, libgamma_gamma_ramps64_t* restrict ramps); /** - * Set the gamma ramps for a CRTC, 64-bit gamma-depth version + * Set the gamma ramps for a CRTC, 64-bit gamma-depth version. * - * @param this The CRTC state - * @param ramps The gamma ramps to apply + * @param this The CRTC state. + * @param ramps The gamma ramps to apply. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_crtc_set_gamma_ramps64(libgamma_crtc_state_t* restrict this, libgamma_gamma_ramps64_t ramps); /** - * Set the gamma ramps for a CRTC, `float` version + * Set the gamma ramps for a CRTC, `float` version. * - * @param this The CRTC state - * @param ramps The gamma ramps to apply + * @param this The CRTC state. + * @param ramps The gamma ramps to apply. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_crtc_set_gamma_rampsf(libgamma_crtc_state_t* restrict this, libgamma_gamma_rampsf_t ramps); /** - * Get current the gamma ramps for a CRTC, `float` version + * Get current the gamma ramps for a CRTC, `float` version. * - * @param this The CRTC state - * @param ramps The gamma ramps to fill with the current values + * @param this The CRTC state. + * @param ramps The gamma ramps to fill with the current values. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_crtc_get_gamma_rampsf(libgamma_crtc_state_t* restrict this, libgamma_gamma_rampsf_t* restrict ramps); /** - * Get current the gamma ramps for a CRTC, `double` version + * Get current the gamma ramps for a CRTC, `double` version. * - * @param this The CRTC state - * @param ramps The gamma ramps to fill with the current values + * @param this The CRTC state. + * @param ramps The gamma ramps to fill with the current values. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_crtc_get_gamma_rampsd(libgamma_crtc_state_t* restrict this, libgamma_gamma_rampsd_t* restrict ramps); /** - * Set the gamma ramps for a CRTC, `double` version + * Set the gamma ramps for a CRTC, `double` version. * - * @param this The CRTC state - * @param ramps The gamma ramps to apply + * @param this The CRTC state. + * @param ramps The gamma ramps to apply. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_crtc_set_gamma_rampsd(libgamma_crtc_state_t* restrict this, libgamma_gamma_rampsd_t ramps); /** - * Set the gamma ramps for a CRTC, 16-bit gamma-depth function version + * Set the gamma ramps for a CRTC, 16-bit gamma-depth function version. * - * Note that this will probably involve the library allocating temporary data + * Note that this will probably involve the library allocating temporary data. * - * @param this The CRTC state - * @param ramps The gamma ramps to apply + * @param this The CRTC state. + * @param ramps The gamma ramps to apply. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_crtc_set_gamma_ramps_f(libgamma_crtc_state_t* restrict this, libgamma_gamma_ramps_fun* red_function, @@ -437,14 +437,14 @@ int libgamma_crtc_set_gamma_ramps_f(libgamma_crtc_state_t* restrict this, libgamma_gamma_ramps_fun* blue_function) __attribute__((cold)); /** - * Set the gamma ramps for a CRTC, 32-bit gamma-depth function version + * Set the gamma ramps for a CRTC, 32-bit gamma-depth function version. * - * Note that this will probably involve the library allocating temporary data + * Note that this will probably involve the library allocating temporary data. * - * @param this The CRTC state - * @param ramps The gamma ramps to apply + * @param this The CRTC state. + * @param ramps The gamma ramps to apply. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_crtc_set_gamma_ramps32_f(libgamma_crtc_state_t* restrict this, libgamma_gamma_ramps32_fun* red_function, @@ -452,14 +452,14 @@ int libgamma_crtc_set_gamma_ramps32_f(libgamma_crtc_state_t* restrict this, libgamma_gamma_ramps32_fun* blue_function) __attribute__((cold)); /** - * Set the gamma ramps for a CRTC, 64-bit gamma-depth function version + * Set the gamma ramps for a CRTC, 64-bit gamma-depth function version. * - * Note that this will probably involve the library allocating temporary data + * Note that this will probably involve the library allocating temporary data. * - * @param this The CRTC state - * @param ramps The gamma ramps to apply + * @param this The CRTC state. + * @param ramps The gamma ramps to apply. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_crtc_set_gamma_ramps64_f(libgamma_crtc_state_t* restrict this, libgamma_gamma_ramps64_fun* red_function, @@ -467,14 +467,14 @@ int libgamma_crtc_set_gamma_ramps64_f(libgamma_crtc_state_t* restrict this, libgamma_gamma_ramps64_fun* blue_function) __attribute__((cold)); /** - * Set the gamma ramps for a CRTC, `float` function version + * Set the gamma ramps for a CRTC, `float` function version. * - * Note that this will probably involve the library allocating temporary data + * Note that this will probably involve the library allocating temporary data. * - * @param this The CRTC state - * @param ramps The gamma ramps to apply + * @param this The CRTC state. + * @param ramps The gamma ramps to apply. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_crtc_set_gamma_rampsf_f(libgamma_crtc_state_t* restrict this, libgamma_gamma_rampsf_fun* red_function, @@ -482,14 +482,14 @@ int libgamma_crtc_set_gamma_rampsf_f(libgamma_crtc_state_t* restrict this, libgamma_gamma_rampsf_fun* blue_function) __attribute__((cold)); /** - * Set the gamma ramps for a CRTC, `double` function version + * Set the gamma ramps for a CRTC, `double` function version. * - * Note that this will probably involve the library allocating temporary data + * Note that this will probably involve the library allocating temporary data. * - * @param this The CRTC state - * @param ramps The gamma ramps to apply + * @param this The CRTC state. + * @param ramps The gamma ramps to apply. * @return Zero on success, otherwise (negative) the value of an - * error identifier provided by this library + * error identifier provided by this library. */ int libgamma_crtc_set_gamma_rampsd_f(libgamma_crtc_state_t* restrict this, libgamma_gamma_rampsd_fun* red_function, diff --git a/src/libgamma-method.c b/src/libgamma-method.c index 47afd54..67be316 100644 --- a/src/libgamma-method.c +++ b/src/libgamma-method.c @@ -26,13 +26,13 @@ /** * Initialise a gamma ramp in the proper way that allows all adjustment - * methods to read from and write to it without causing segmentation violation + * methods to read from and write to it without causing segmentation violation. * * The input must have `red_size`, `green_size` and `blue_size` set to the - * sizes of the gamma ramps that should be allocated + * sizes of the gamma ramps that should be allocated. * - * @param this The gamma ramps - * @return Zero on success, -1 on allocation error, `errno` will be set accordingly + * @param this The gamma ramps. + * @return Zero on success, -1 on allocation error, `errno` will be set accordingly. */ int libgamma_gamma_ramps_initialise(libgamma_gamma_ramps_t* restrict this) { @@ -47,9 +47,9 @@ int libgamma_gamma_ramps_initialise(libgamma_gamma_ramps_t* restrict this) /** * Release resources that are held by a gamma ramp strcuture that * has been allocated by `libgamma_gamma_ramps_initialise` or otherwise - * initialises in the proper manner + * initialises in the proper manner. * - * @param this The gamma ramps + * @param this The gamma ramps. */ void libgamma_gamma_ramps_destroy(libgamma_gamma_ramps_t* restrict this) { @@ -61,9 +61,9 @@ void libgamma_gamma_ramps_destroy(libgamma_gamma_ramps_t* restrict this) * Release resources that are held by a gamma ramp strcuture that * has been allocated by `libgamma_gamma_ramps_initialise` or otherwise * initialises in the proper manner, as well as release the pointer - * to the structure + * to the structure. * - * @param this The gamma ramps + * @param this The gamma ramps. */ void libgamma_gamma_ramps_free(libgamma_gamma_ramps_t* restrict this) { @@ -75,13 +75,13 @@ void libgamma_gamma_ramps_free(libgamma_gamma_ramps_t* restrict this) /** * Initialise a gamma ramp in the proper way that allows all adjustment - * methods to read from and write to it without causing segmentation violation + * methods to read from and write to it without causing segmentation violation. * * The input must have `red_size`, `green_size` and `blue_size` set to the - * sizes of the gamma ramps that should be allocated + * sizes of the gamma ramps that should be allocated. * - * @param this The gamma ramps - * @return Zero on success, -1 on allocation error, `errno` will be set accordingly + * @param this The gamma ramps. + * @return Zero on success, -1 on allocation error, `errno` will be set accordingly. */ int libgamma_gamma_ramps32_initialise(libgamma_gamma_ramps32_t* restrict this) { @@ -96,9 +96,9 @@ int libgamma_gamma_ramps32_initialise(libgamma_gamma_ramps32_t* restrict this) /** * Release resources that are held by a gamma ramp strcuture that * has been allocated by `libgamma_gamma_ramps32_initialise` or otherwise - * initialises in the proper manner + * initialises in the proper manner. * - * @param this The gamma ramps + * @param this The gamma ramps. */ void libgamma_gamma_ramps32_destroy(libgamma_gamma_ramps32_t* restrict this) { @@ -110,9 +110,9 @@ void libgamma_gamma_ramps32_destroy(libgamma_gamma_ramps32_t* restrict this) * Release resources that are held by a gamma ramp strcuture that * has been allocated by `libgamma_gamma_ramps32_initialise` or otherwise * initialises in the proper manner, as well as release the pointer - * to the structure + * to the structure. * - * @param this The gamma ramps + * @param this The gamma ramps. */ void libgamma_gamma_ramps32_free(libgamma_gamma_ramps32_t* restrict this) { @@ -124,13 +124,13 @@ void libgamma_gamma_ramps32_free(libgamma_gamma_ramps32_t* restrict this) /** * Initialise a gamma ramp in the proper way that allows all adjustment - * methods to read from and write to it without causing segmentation violation + * methods to read from and write to it without causing segmentation violation. * * The input must have `red_size`, `green_size` and `blue_size` set to the - * sizes of the gamma ramps that should be allocated + * sizes of the gamma ramps that should be allocated. * - * @param this The gamma ramps - * @return Zero on success, -1 on allocation error, `errno` will be set accordingly + * @param this The gamma ramps. + * @return Zero on success, -1 on allocation error, `errno` will be set accordingly. */ int libgamma_gamma_ramps64_initialise(libgamma_gamma_ramps64_t* restrict this) { @@ -145,9 +145,9 @@ int libgamma_gamma_ramps64_initialise(libgamma_gamma_ramps64_t* restrict this) /** * Release resources that are held by a gamma ramp strcuture that * has been allocated by `libgamma_gamma_ramps64_initialise` or otherwise - * initialises in the proper manner + * initialises in the proper manner. * - * @param this The gamma ramps + * @param this The gamma ramps. */ void libgamma_gamma_ramps64_destroy(libgamma_gamma_ramps64_t* restrict this) { @@ -159,9 +159,9 @@ void libgamma_gamma_ramps64_destroy(libgamma_gamma_ramps64_t* restrict this) * Release resources that are held by a gamma ramp strcuture that * has been allocated by `libgamma_gamma_ramps64_initialise` or otherwise * initialises in the proper manner, as well as release the pointer - * to the structure + * to the structure. * - * @param this The gamma ramps + * @param this The gamma ramps. */ void libgamma_gamma_ramps64_free(libgamma_gamma_ramps64_t* restrict this) { @@ -173,13 +173,13 @@ void libgamma_gamma_ramps64_free(libgamma_gamma_ramps64_t* restrict this) /** * Initialise a gamma ramp in the proper way that allows all adjustment - * methods to read from and write to it without causing segmentation violation + * methods to read from and write to it without causing segmentation violation. * * The input must have `red_size`, `green_size` and `blue_size` set to the - * sizes of the gamma ramps that should be allocated + * sizes of the gamma ramps that should be allocated. * - * @param this The gamma ramps - * @return Zero on success, -1 on allocation error, `errno` will be set accordingly + * @param this The gamma ramps. + * @return Zero on success, -1 on allocation error, `errno` will be set accordingly. */ int libgamma_gamma_rampsf_initialise(libgamma_gamma_rampsf_t* restrict this) { @@ -194,9 +194,9 @@ int libgamma_gamma_rampsf_initialise(libgamma_gamma_rampsf_t* restrict this) /** * Release resources that are held by a gamma ramp strcuture that * has been allocated by `libgamma_gamma_rampsf_initialise` or otherwise - * initialises in the proper manner + * initialises in the proper manner. * - * @param this The gamma ramps + * @param this The gamma ramps. */ void libgamma_gamma_rampsf_destroy(libgamma_gamma_rampsf_t* restrict this) { @@ -208,9 +208,9 @@ void libgamma_gamma_rampsf_destroy(libgamma_gamma_rampsf_t* restrict this) * Release resources that are held by a gamma ramp strcuture that * has been allocated by `libgamma_gamma_rampsf_initialise` or otherwise * initialises in the proper manner, as well as release the pointer - * to the structure + * to the structure. * - * @param this The gamma ramps + * @param this The gamma ramps. */ void libgamma_gamma_rampsf_free(libgamma_gamma_rampsf_t* restrict this) { @@ -222,13 +222,13 @@ void libgamma_gamma_rampsf_free(libgamma_gamma_rampsf_t* restrict this) /** * Initialise a gamma ramp in the proper way that allows all adjustment - * methods to read from and write to it without causing segmentation violation + * methods to read from and write to it without causing segmentation violation. * * The input must have `red_size`, `green_size` and `blue_size` set to the - * sizes of the gamma ramps that should be allocated + * sizes of the gamma ramps that should be allocated. * - * @param this The gamma ramps - * @return Zero on success, -1 on allocation error, `errno` will be set accordingly + * @param this The gamma ramps. + * @return Zero on success, -1 on allocation error, `errno` will be set accordingly. */ int libgamma_gamma_rampsd_initialise(libgamma_gamma_rampsd_t* restrict this) { @@ -248,9 +248,9 @@ int libgamma_gamma_rampsd_initialise(libgamma_gamma_rampsd_t* restrict this) /** * Release resources that are held by a gamma ramp strcuture that * has been allocated by `libgamma_gamma_rampsd_initialise` or otherwise - * initialises in the proper manner + * initialises in the proper manner. * - * @param this The gamma ramps + * @param this The gamma ramps. */ void libgamma_gamma_rampsd_destroy(libgamma_gamma_rampsd_t* restrict this) { @@ -262,9 +262,9 @@ void libgamma_gamma_rampsd_destroy(libgamma_gamma_rampsd_t* restrict this) * Release resources that are held by a gamma ramp strcuture that * has been allocated by `libgamma_gamma_rampsd_initialise` or otherwise * initialises in the proper manner, as well as release the pointer - * to the structure + * to the structure. * - * @param this The gamma ramps + * @param this The gamma ramps. */ void libgamma_gamma_rampsd_free(libgamma_gamma_rampsd_t* restrict this) { diff --git a/src/libgamma-method.h b/src/libgamma-method.h index 260ec60..0053491 100644 --- a/src/libgamma-method.h +++ b/src/libgamma-method.h @@ -105,81 +105,81 @@ typedef struct libgamma_method_capabilities { /** * OR of the CRTC information fields in `libgamma_crtc_information_t` - * that may (but can fail) be read successfully + * that may (but can fail) be read successfully. */ int32_t crtc_information; /** * Whether the default site is known, if true the site is integrated - * to the system or can be determined using environment variables + * to the system or can be determined using environment variables. */ unsigned default_site_known : 1; /** * Whether the adjustment method supports multiple sites rather - * than just the default site + * than just the default site. */ unsigned multiple_sites : 1; /** * Whether the adjustment method supports multiple partitions - * per site + * per site. */ unsigned multiple_partitions : 1; /** * Whether the adjustment method supports multiple CRTC:s - * per partition per site + * per partition per site. */ unsigned multiple_crtcs : 1; /** - * Whether the partition to graphics card is a bijection + * Whether the partition to graphics card is a bijection. */ unsigned partitions_are_graphics_cards : 1; /** - * Whether the adjustment method supports `libgamma_site_restore` + * Whether the adjustment method supports `libgamma_site_restore`. */ unsigned site_restore : 1; /** - * Whether the adjustment method supports `libgamma_partition_restore` + * Whether the adjustment method supports `libgamma_partition_restore`. */ unsigned partition_restore : 1; /** - * Whether the adjustment method supports `libgamma_crtc_restore` + * Whether the adjustment method supports `libgamma_crtc_restore`. */ unsigned crtc_restore : 1; /** * Whether the `red_gamma_size`, `green_gamma_size` and `blue_gamma_size` * fields in `libgamma_crtc_information_t` will always have the same - * values as each other for the adjustment method + * values as each other for the adjustment method. */ unsigned identical_gamma_sizes : 1; /** * Whether the `red_gamma_size`, `green_gamma_size` and `blue_gamma_size` * fields in `libgamma_crtc_information_t` will always be filled with the - * same value for the adjustment method + * same value for the adjustment method. */ unsigned fixed_gamma_size : 1; /** * Whether the `gamma_depth` field in `libgamma_crtc_information_t` - * will always be filled with the same value for the adjustment method + * will always be filled with the same value for the adjustment method. */ unsigned fixed_gamma_depth : 1; /** - * Whether the adjustment method will actually perform adjustments + * Whether the adjustment method will actually perform adjustments. */ unsigned real : 1; /** - * Whether the adjustment method is implement using a translation layer + * Whether the adjustment method is implement using a translation layer. */ unsigned fake : 1; @@ -236,7 +236,7 @@ typedef struct libgamma_site_state /** - * Partition state + * Partition state. * * Probably the majority of display server only one partition * per site. However, X.org can, and traditional used to have @@ -256,12 +256,12 @@ typedef struct libgamma_partition_state void* data; /** - * The site this partition belongs to + * The site this partition belongs to. */ libgamma_site_state_t* site; /** - * The index of the partition + * The index of the partition. */ size_t partition; @@ -276,11 +276,11 @@ typedef struct libgamma_partition_state /** - * Cathode ray tube controller state + * Cathode ray tube controller state. * * The CRTC controls the gamma ramps for the * monitor that is plugged in to the connector - * that the CRTC belongs to + * that the CRTC belongs to. */ typedef struct libgamma_crtc_state { @@ -291,7 +291,7 @@ typedef struct libgamma_crtc_state void* data; /** - * The partition this CRTC belongs to + * The partition this CRTC belongs to. */ libgamma_partition_state_t* partition; @@ -304,13 +304,13 @@ typedef struct libgamma_crtc_state /** - * Types for connectors + * Types for connectors. */ typedef enum libgamma_connector_type { /** * The adjustment method does not know the connector's type - * (This could be considered an error) + * (This could be considered an error). */ LIBGAMMA_CONNECTOR_TYPE_Unknown, LIBGAMMA_CONNECTOR_TYPE_VGA, @@ -341,33 +341,33 @@ typedef enum libgamma_connector_type typedef enum libgamma_subpixel_order { /** - * The adjustment method does not know the order of the subpixels - * (This could be considered an error) + * The adjustment method does not know the order of the subpixels. + * (This could be considered an error.) */ LIBGAMMA_SUBPIXEL_ORDER_UNKNOWN, /** - * There are no subpixels in the monitor + * There are no subpixels in the monitor. */ LIBGAMMA_SUBPIXEL_ORDER_NONE, /** - * The subpixels are ordered red, green and then blue, from left to right + * The subpixels are ordered red, green and then blue, from left to right. */ LIBGAMMA_SUBPIXEL_ORDER_HORIZONTAL_RGB, /** - * The subpixels are ordered blue, green and then red, from left to right + * The subpixels are ordered blue, green and then red, from left to right. */ LIBGAMMA_SUBPIXEL_ORDER_HORIZONTAL_BGR, /** - * The subpixels are ordered red, green and then blue, from the top down + * The subpixels are ordered red, green and then blue, from the top down. */ LIBGAMMA_SUBPIXEL_ORDER_VERTICAL_RGB, /** - * The subpixels are ordered blue, green and then red, from the top down + * The subpixels are ordered blue, green and then red, from the top down. */ LIBGAMMA_SUBPIXEL_ORDER_VERTICAL_BGR @@ -376,87 +376,87 @@ typedef enum libgamma_subpixel_order /** * For a `libgamma_crtc_information_t` fill in the - * values for `edid` and `edid_length` and report errors to `edid_error` + * values for `edid` and `edid_length` and report errors to `edid_error`. */ #define CRTC_INFO_EDID (1 << 0) /** * For a `libgamma_crtc_information_t` fill in the - * value for `width_mm` and report errors to `width_mm_error` + * value for `width_mm` and report errors to `width_mm_error`. */ #define CRTC_INFO_WIDTH_MM (1 << 1) /** * For a `libgamma_crtc_information_t` fill in the - * value for `height_mm` and report errors to `height_mm_error` + * value for `height_mm` and report errors to `height_mm_error`. */ #define CRTC_INFO_HEIGHT_MM (1 << 2) /** * For a `libgamma_crtc_information_t` fill in the - * value for `width_mm_edid` and report errors to `width_mm_edid_error` + * value for `width_mm_edid` and report errors to `width_mm_edid_error`. */ #define CRTC_INFO_WIDTH_MM_EDID (1 << 3) /** * For a `libgamma_crtc_information_t` fill in the - * value for `height_mm_edid` and report errors to `height_mm_edid_error` + * value for `height_mm_edid` and report errors to `height_mm_edid_error`. */ #define CRTC_INFO_HEIGHT_MM_EDID (1 << 4) /** * For a `libgamma_crtc_information_t` fill in the - * values for `red_gamma_size`, `green_gamma_size` and `blue_gamma_size` + * values for `red_gamma_size`, `green_gamma_size` and `blue_gamma_size`. * and report errors to `gamma_size_error` */ #define CRTC_INFO_GAMMA_SIZE (1 << 5) /** * For a `libgamma_crtc_information_t` fill in the - * value for `gamma_depth` and report errors to `gamma_depth_error` + * value for `gamma_depth` and report errors to `gamma_depth_error`. */ #define CRTC_INFO_GAMMA_DEPTH (1 << 6) /** * For a `libgamma_crtc_information_t` fill in the - * value for `gamma_support` and report errors to `gamma_support_error` + * value for `gamma_support` and report errors to `gamma_support_error`. */ #define CRTC_INFO_GAMMA_SUPPORT (1 << 7) /** * For a `libgamma_crtc_information_t` fill in the - * value for `subpixel_order` and report errors to `subpixel_order_error` + * value for `subpixel_order` and report errors to `subpixel_order_error`. */ #define CRTC_INFO_SUBPIXEL_ORDER (1 << 8) /** * For a `libgamma_crtc_information_t` fill in the - * value for `active` and report errors to `active_error` + * value for `active` and report errors to `active_error`. */ #define CRTC_INFO_ACTIVE (1 << 9) /** * For a `libgamma_crtc_information_t` fill in the - * value for `connector_name` and report errors to `connector_name_error` + * value for `connector_name` and report errors to `connector_name_error`. */ #define CRTC_INFO_CONNECTOR_NAME (1 << 10) /** * For a `libgamma_crtc_information_t` fill in the - * value for `connector_type` and report errors to `connector_type_error` + * value for `connector_type` and report errors to `connector_type_error`. */ #define CRTC_INFO_CONNECTOR_TYPE (1 << 11) /** * For a `libgamma_crtc_information_t` fill in the * values for `gamma_red`, `gamma_green` and `gamma_blue` - * and report errors to `connector_type_error` + * and report errors to `connector_type_error`. */ #define CRTC_INFO_GAMMA (1 << 12) /** - * Cathode ray tube controller information data structure + * Cathode ray tube controller information data structure. */ typedef struct libgamma_crtc_information { @@ -469,14 +469,14 @@ typedef struct libgamma_crtc_information unsigned char* edid; /** - * The length of `edid` + * The length of `edid`. */ size_t edid_length; /** * Zero on success, positive it holds the value `errno` had * when the reading failed, otherwise (negative) the value - * of an error identifier provided by this library + * of an error identifier provided by this library. */ int edid_error; @@ -495,7 +495,7 @@ typedef struct libgamma_crtc_information /** * Zero on success, positive it holds the value `errno` had * when the reading failed, otherwise (negative) the value - * of an error identifier provided by this library + * of an error identifier provided by this library. */ int width_mm_error; @@ -514,7 +514,7 @@ typedef struct libgamma_crtc_information /** * Zero on success, positive it holds the value `errno` had * when the reading failed, otherwise (negative) the value - * of an error identifier provided by this library + * of an error identifier provided by this library. */ int height_mm_error; @@ -534,7 +534,7 @@ typedef struct libgamma_crtc_information /** * Zero on success, positive it holds the value `errno` had * when the reading failed, otherwise (negative) the value - * of an error identifier provided by this library + * of an error identifier provided by this library. */ int width_mm_edid_error; @@ -554,30 +554,30 @@ typedef struct libgamma_crtc_information /** * Zero on success, positive it holds the value `errno` had * when the reading failed, otherwise (negative) the value - * of an error identifier provided by this library + * of an error identifier provided by this library. */ int height_mm_edid_error; /** - * The size of the encoding axis of the red gamma ramp + * The size of the encoding axis of the red gamma ramp. */ size_t red_gamma_size; /** - * The size of the encoding axis of the green gamma ramp + * The size of the encoding axis of the green gamma ramp. */ size_t green_gamma_size; /** - * The size of the encoding axis of the blue gamma ramp + * The size of the encoding axis of the blue gamma ramp. */ size_t blue_gamma_size; /** * Zero on success, positive it holds the value `errno` had * when the reading failed, otherwise (negative) the value - * of an error identifier provided by this library + * of an error identifier provided by this library. */ int gamma_size_error; @@ -592,20 +592,20 @@ typedef struct libgamma_crtc_information /** * Zero on success, positive it holds the value `errno` had * when the reading failed, otherwise (negative) the value - * of an error identifier provided by this library + * of an error identifier provided by this library. */ int gamma_depth_error; /** - * Non-zero gamma ramp adjustments are supported + * Non-zero gamma ramp adjustments are supported. */ int gamma_support; /** * Zero on success, positive it holds the value `errno` had * when the reading failed, otherwise (negative) the value - * of an error identifier provided by this library + * of an error identifier provided by this library. */ int gamma_support_error; @@ -620,20 +620,20 @@ typedef struct libgamma_crtc_information /** * Zero on success, positive it holds the value `errno` had * when the reading failed, otherwise (negative) the value - * of an error identifier provided by this library + * of an error identifier provided by this library. */ int subpixel_order_error; /** - * Whether there is a monitors connected to the CRTC + * Whether there is a monitors connected to the CRTC. */ int active; /** * Zero on success, positive it holds the value `errno` had * when the reading failed, otherwise (negative) the value - * of an error identifier provided by this library + * of an error identifier provided by this library. */ int active_error; @@ -641,27 +641,27 @@ typedef struct libgamma_crtc_information /** * The name of the connector as designated by the display * server or as give by this library in case the display - * server lacks this feature + * server lacks this feature. */ char* connector_name; /** * Zero on success, positive it holds the value `errno` had * when the reading failed, otherwise (negative) the value - * of an error identifier provided by this library + * of an error identifier provided by this library. */ int connector_name_error; /** - * The type of the connector that is associated with the CRTC + * The type of the connector that is associated with the CRTC. */ libgamma_connector_type_t connector_type; /** * Zero on success, positive it holds the value `errno` had * when the reading failed, otherwise (negative) the value - * of an error identifier provided by this library + * of an error identifier provided by this library. */ int connector_type_error; @@ -702,7 +702,7 @@ typedef struct libgamma_crtc_information /** * Zero on success, positive it holds the value `errno` had * when the reading failed, otherwise (negative) the value - * of an error identifier provided by this library + * of an error identifier provided by this library. */ int gamma_error; @@ -711,37 +711,37 @@ typedef struct libgamma_crtc_information /** - * Gamma ramp structure for 16-bit gamma ramps + * Gamma ramp structure for 16-bit gamma ramps. */ typedef struct libgamma_gamma_ramps { /** - * The size of `red` + * The size of `red`. */ size_t red_size; /** - * The size of `green` + * The size of `green`. */ size_t green_size; /** - * The size of `blue` + * The size of `blue`. */ size_t blue_size; /** - * The gamma ramp for the red channel + * The gamma ramp for the red channel. */ uint16_t* red; /** - * The gamma ramp for the green channel + * The gamma ramp for the green channel. */ uint16_t* green; /** - * The gamma ramp for the blue channel + * The gamma ramp for the blue channel. */ uint16_t* blue; @@ -749,37 +749,37 @@ typedef struct libgamma_gamma_ramps /** - * Gamma ramp structure for 32-bit gamma ramps + * Gamma ramp structure for 32-bit gamma ramps. */ typedef struct libgamma_gamma_ramps32 { /** - * The size of `red` + * The size of `red`. */ size_t red_size; /** - * The size of `green` + * The size of `green`. */ size_t green_size; /** - * The size of `blue` + * The size of `blue`. */ size_t blue_size; /** - * The gamma ramp for the red channel + * The gamma ramp for the red channel. */ uint32_t* red; /** - * The gamma ramp for the green channel + * The gamma ramp for the green channel. */ uint32_t* green; /** - * The gamma ramp for the blue channel + * The gamma ramp for the blue channel. */ uint32_t* blue; @@ -787,37 +787,37 @@ typedef struct libgamma_gamma_ramps32 /** - * Gamma ramp structure for 64-bit gamma ramps + * Gamma ramp structure for 64-bit gamma ramps. */ typedef struct libgamma_gamma_ramps64 { /** - * The size of `red` + * The size of `red`. */ size_t red_size; /** - * The size of `green` + * The size of `green`. */ size_t green_size; /** - * The size of `blue` + * The size of `blue`. */ size_t blue_size; /** - * The gamma ramp for the red channel + * The gamma ramp for the red channel. */ uint64_t* red; /** - * The gamma ramp for the green channel + * The gamma ramp for the green channel. */ uint64_t* green; /** - * The gamma ramp for the blue channel + * The gamma ramp for the blue channel. */ uint64_t* blue; @@ -825,37 +825,37 @@ typedef struct libgamma_gamma_ramps64 /** - * Gamma ramp structure for `float` gamma ramps + * Gamma ramp structure for `float` gamma ramps. */ typedef struct libgamma_gamma_rampsf { /** - * The size of `red` + * The size of `red`. */ size_t red_size; /** - * The size of `green` + * The size of `green`. */ size_t green_size; /** - * The size of `blue` + * The size of `blue`. */ size_t blue_size; /** - * The gamma ramp for the red channel + * The gamma ramp for the red channel. */ float* red; /** - * The gamma ramp for the green channel + * The gamma ramp for the green channel. */ float* green; /** - * The gamma ramp for the blue channel + * The gamma ramp for the blue channel. */ float* blue; @@ -863,37 +863,37 @@ typedef struct libgamma_gamma_rampsf /** - * Gamma ramp structure for `double` gamma ramps + * Gamma ramp structure for `double` gamma ramps. */ typedef struct libgamma_gamma_rampsd { /** - * The size of `red` + * The size of `red`. */ size_t red_size; /** - * The size of `green` + * The size of `green`. */ size_t green_size; /** - * The size of `blue` + * The size of `blue`. */ size_t blue_size; /** - * The gamma ramp for the red channel + * The gamma ramp for the red channel. */ double* red; /** - * The gamma ramp for the green channel + * The gamma ramp for the green channel. */ double* green; /** - * The gamma ramp for the blue channel + * The gamma ramp for the blue channel. */ double* blue; @@ -903,22 +903,22 @@ typedef struct libgamma_gamma_rampsd /** * Initialise a gamma ramp in the proper way that allows all adjustment - * methods to read from and write to it without causing segmentation violation + * methods to read from and write to it without causing segmentation violation. * * The input must have `red_size`, `green_size` and `blue_size` set to the - * sizes of the gamma ramps that should be allocated + * sizes of the gamma ramps that should be allocated. * - * @param this The gamma ramps - * @return Zero on success, -1 on allocation error, `errno` will be set accordingly + * @param this The gamma ramps. + * @return Zero on success, -1 on allocation error, `errno` will be set accordingly. */ int libgamma_gamma_ramps_initialise(libgamma_gamma_ramps_t* restrict this); /** * Release resources that are held by a gamma ramp strcuture that * has been allocated by `libgamma_gamma_ramps_initialise` or otherwise - * initialises in the proper manner + * initialises in the proper manner. * - * @param this The gamma ramps + * @param this The gamma ramps. */ void libgamma_gamma_ramps_destroy(libgamma_gamma_ramps_t* restrict this); @@ -926,31 +926,31 @@ void libgamma_gamma_ramps_destroy(libgamma_gamma_ramps_t* restrict this); * Release resources that are held by a gamma ramp strcuture that * has been allocated by `libgamma_gamma_ramps_initialise` or otherwise * initialises in the proper manner, as well as release the pointer - * to the structure + * to the structure. * - * @param this The gamma ramps + * @param this The gamma ramps. */ void libgamma_gamma_ramps_free(libgamma_gamma_ramps_t* restrict this); /** * Initialise a gamma ramp in the proper way that allows all adjustment - * methods to read from and write to it without causing segmentation violation + * methods to read from and write to it without causing segmentation violation. * * The input must have `red_size`, `green_size` and `blue_size` set to the - * sizes of the gamma ramps that should be allocated + * sizes of the gamma ramps that should be allocated. * - * @param this The gamma ramps - * @return Zero on success, -1 on allocation error, `errno` will be set accordingly + * @param this The gamma ramps. + * @return Zero on success, -1 on allocation error, `errno` will be set accordingly. */ int libgamma_gamma_ramps32_initialise(libgamma_gamma_ramps32_t* restrict this); /** * Release resources that are held by a gamma ramp strcuture that * has been allocated by `libgamma_gamma_ramps32_initialise` or otherwise - * initialises in the proper manner + * initialises in the proper manner. * - * @param this The gamma ramps + * @param this The gamma ramps. */ void libgamma_gamma_ramps32_destroy(libgamma_gamma_ramps32_t* restrict this); @@ -958,31 +958,31 @@ void libgamma_gamma_ramps32_destroy(libgamma_gamma_ramps32_t* restrict this); * Release resources that are held by a gamma ramp strcuture that * has been allocated by `libgamma_gamma_ramps32_initialise` or otherwise * initialises in the proper manner, as well as release the pointer - * to the structure + * to the structure. * - * @param this The gamma ramps + * @param this The gamma ramps. */ void libgamma_gamma_ramps32_free(libgamma_gamma_ramps32_t* restrict this); /** * Initialise a gamma ramp in the proper way that allows all adjustment - * methods to read from and write to it without causing segmentation violation + * methods to read from and write to it without causing segmentation violation. * * The input must have `red_size`, `green_size` and `blue_size` set to the - * sizes of the gamma ramps that should be allocated + * sizes of the gamma ramps that should be allocated. * - * @param this The gamma ramps - * @return Zero on success, -1 on allocation error, `errno` will be set accordingly + * @param this The gamma ramps. + * @return Zero on success, -1 on allocation error, `errno` will be set accordingly. */ int libgamma_gamma_ramps64_initialise(libgamma_gamma_ramps64_t* restrict this); /** * Release resources that are held by a gamma ramp strcuture that * has been allocated by `libgamma_gamma_ramps64_initialise` or otherwise - * initialises in the proper manner + * initialises in the proper manner. * - * @param this The gamma ramps + * @param this The gamma ramps. */ void libgamma_gamma_ramps64_destroy(libgamma_gamma_ramps64_t* restrict this); @@ -990,31 +990,31 @@ void libgamma_gamma_ramps64_destroy(libgamma_gamma_ramps64_t* restrict this); * Release resources that are held by a gamma ramp strcuture that * has been allocated by `libgamma_gamma_ramps64_initialise` or otherwise * initialises in the proper manner, as well as release the pointer - * to the structure + * to the structure. * - * @param this The gamma ramps + * @param this The gamma ramps. */ void libgamma_gamma_ramps64_free(libgamma_gamma_ramps64_t* restrict this); /** * Initialise a gamma ramp in the proper way that allows all adjustment - * methods to read from and write to it without causing segmentation violation + * methods to read from and write to it without causing segmentation violation. * * The input must have `red_size`, `green_size` and `blue_size` set to the - * sizes of the gamma ramps that should be allocated + * sizes of the gamma ramps that should be allocated. * - * @param this The gamma ramps - * @return Zero on success, -1 on allocation error, `errno` will be set accordingly + * @param this The gamma ramps. + * @return Zero on success, -1 on allocation error, `errno` will be set accordingly. */ int libgamma_gamma_rampsf_initialise(libgamma_gamma_rampsf_t* restrict this); /** * Release resources that are held by a gamma ramp strcuture that * has been allocated by `libgamma_gamma_rampsf_initialise` or otherwise - * initialises in the proper manner + * initialises in the proper manner. * - * @param this The gamma ramps + * @param this The gamma ramps. */ void libgamma_gamma_rampsf_destroy(libgamma_gamma_rampsf_t* restrict this); @@ -1022,31 +1022,31 @@ void libgamma_gamma_rampsf_destroy(libgamma_gamma_rampsf_t* restrict this); * Release resources that are held by a gamma ramp strcuture that * has been allocated by `libgamma_gamma_rampsf_initialise` or otherwise * initialises in the proper manner, as well as release the pointer - * to the structure + * to the structure. * - * @param this The gamma ramps + * @param this The gamma ramps. */ void libgamma_gamma_rampsf_free(libgamma_gamma_rampsf_t* restrict this); /** * Initialise a gamma ramp in the proper way that allows all adjustment - * methods to read from and write to it without causing segmentation violation + * methods to read from and write to it without causing segmentation violation. * * The input must have `red_size`, `green_size` and `blue_size` set to the - * sizes of the gamma ramps that should be allocated + * sizes of the gamma ramps that should be allocated. * * @param this The gamma ramps - * @return Zero on success, -1 on allocation error, `errno` will be set accordingly + * @return Zero on success, -1 on allocation error, `errno` will be set accordingly. */ int libgamma_gamma_rampsd_initialise(libgamma_gamma_rampsd_t* restrict this); /** * Release resources that are held by a gamma ramp strcuture that * has been allocated by `libgamma_gamma_rampsd_initialise` or otherwise - * initialises in the proper manner + * initialises in the proper manner. * - * @param this The gamma ramps + * @param this The gamma ramps. */ void libgamma_gamma_rampsd_destroy(libgamma_gamma_rampsd_t* restrict this); @@ -1054,9 +1054,9 @@ void libgamma_gamma_rampsd_destroy(libgamma_gamma_rampsd_t* restrict this); * Release resources that are held by a gamma ramp strcuture that * has been allocated by `libgamma_gamma_rampsd_initialise` or otherwise * initialises in the proper manner, as well as release the pointer - * to the structure + * to the structure. * - * @param this The gamma ramps + * @param this The gamma ramps. */ void libgamma_gamma_rampsd_free(libgamma_gamma_rampsd_t* restrict this); |