[gimp] libgimpcolor: add some missing API docs



commit 6b40652d07d9fc3105c10a12e9c1960ecbecc116
Author: Michael Natterer <mitch gimp org>
Date:   Sun May 31 02:47:24 2015 +0200

    libgimpcolor: add some missing API docs

 libgimpcolor/gimpcairo.c |   23 +++++++++++++++++++++++
 libgimpcolor/gimplcms.c  |    5 ++---
 2 files changed, 25 insertions(+), 3 deletions(-)
---
diff --git a/libgimpcolor/gimpcairo.c b/libgimpcolor/gimpcairo.c
index 628fda6..226c279 100644
--- a/libgimpcolor/gimpcairo.c
+++ b/libgimpcolor/gimpcairo.c
@@ -142,6 +142,17 @@ gimp_cairo_checkerboard_create (cairo_t       *cr,
   return pattern;
 }
 
+/**
+ * gimp_cairo_surface_get_format:
+ * @surface: a Cairo surface
+ *
+ * This function returns a #Babl format that corresponds to @surface's
+ * pixel format.
+ *
+ * Return value: the #Babl format of @surface.
+ *
+ * Since: GIMP 2.10
+ **/
 const Babl *
 gimp_cairo_surface_get_format (cairo_surface_t *surface)
 {
@@ -161,6 +172,18 @@ gimp_cairo_surface_get_format (cairo_surface_t *surface)
   g_return_val_if_reached (NULL);
 }
 
+/**
+ * gimp_cairo_surface_create_buffer:
+ * @surface: a Cairo surface
+ *
+ * This function returns a #GeglBuffer which wraps @surface's pixels.
+ * It must only be called on image surfaces, calling it on other surface
+ * types is an error.
+ *
+ * Return value: a #GeglBuffer
+ *
+ * Since: GIMP 2.10
+ **/
 GeglBuffer *
 gimp_cairo_surface_create_buffer (cairo_surface_t *surface)
 {
diff --git a/libgimpcolor/gimplcms.c b/libgimpcolor/gimplcms.c
index 3b78219..41f1b49 100644
--- a/libgimpcolor/gimplcms.c
+++ b/libgimpcolor/gimplcms.c
@@ -555,8 +555,7 @@ gimp_lcms_create_srgb_profile_internal (void)
   gimp_lcms_profile_set_tag (srgb_profile, cmsSigCopyrightTag,
                              "Public Domain");
 
-  /**
-   * The following line produces a V2 profile with a point curve TRC.
+  /* The following line produces a V2 profile with a point curve TRC.
    * Profiles with point curve TRCs can't be used in LCMS2 unbounded
    * mode ICC profile conversions. A V2 profile might be appropriate
    * for embedding in sRGB images saved to disk, if the image is to be
@@ -564,7 +563,7 @@ gimp_lcms_create_srgb_profile_internal (void)
    * profiles.
    *
    * cmsSetProfileVersion (srgb_profile, 2.1);
-   **/
+   */
 
   return srgb_profile;
 }


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]