change doc style to one appropriate for manuals

Signed-off-by: Mattias Andrée <maandree@operamail.com>

1 files changed, 41 insertions, 41 deletions

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,