aboutsummaryrefslogtreecommitdiffstats
path: root/src/libgamma-method.c
diff options
context:
space:
mode:
authorMattias Andrée <maandree@operamail.com>2014-05-28 04:58:51 +0200
committerMattias Andrée <maandree@operamail.com>2014-05-28 04:58:51 +0200
commitd8c194e3868ff7cc74e6b990e458a1814814c427 (patch)
tree477fdd9e6cb21a2c67c62fbfb6d7565a4eb51c79 /src/libgamma-method.c
parenton GAMMA_METHOD_MAX and GAMMA_METHOD_COUNT (diff)
downloadlibgamma-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>
Diffstat (limited to '')
-rw-r--r--src/libgamma-method.c80
1 files changed, 40 insertions, 40 deletions
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)
{