[gimp/soc-2010-cage] libgimpcolor: move docs from template files to inline comments
- From: Michael Muré <mmure src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gimp/soc-2010-cage] libgimpcolor: move docs from template files to inline comments
- Date: Wed, 30 Jun 2010 22:20:18 +0000 (UTC)
commit 273415d0a4af7835b598fd635b895ee2fb89b6a4
Author: Michael Natterer <mitch gimp org>
Date: Tue Jun 29 19:46:37 2010 +0200
libgimpcolor: move docs from template files to inline comments
Only added section headers for now, there was nothing else in the
template files.
devel-docs/libgimpcolor/.gitignore | 1 +
devel-docs/libgimpcolor/tmpl/.gitignore | 2 -
.../libgimpcolor/tmpl/gimpadaptivesupersample.sgml | 72 ---
devel-docs/libgimpcolor/tmpl/gimpbilinear.sgml | 98 -----
devel-docs/libgimpcolor/tmpl/gimpcmyk.sgml | 112 -----
devel-docs/libgimpcolor/tmpl/gimpcolormanaged.sgml | 52 ---
devel-docs/libgimpcolor/tmpl/gimpcolorspace.sgml | 194 ---------
devel-docs/libgimpcolor/tmpl/gimphsv.sgml | 95 ----
devel-docs/libgimpcolor/tmpl/gimprgb.sgml | 451 --------------------
libgimpcolor/gimpadaptivesupersample.c | 10 +
libgimpcolor/gimpbilinear.c | 9 +
libgimpcolor/gimpcmyk.c | 9 +
libgimpcolor/gimpcolormanaged.c | 9 +
libgimpcolor/gimpcolorspace.c | 13 +
libgimpcolor/gimphsv.c | 9 +
libgimpcolor/gimprgb.c | 9 +
16 files changed, 69 insertions(+), 1076 deletions(-)
---
diff --git a/devel-docs/libgimpcolor/.gitignore b/devel-docs/libgimpcolor/.gitignore
index 7ea1bfd..6575581 100644
--- a/devel-docs/libgimpcolor/.gitignore
+++ b/devel-docs/libgimpcolor/.gitignore
@@ -12,6 +12,7 @@
/libgimpcolor-undeclared.txt
/libgimpcolor-undocumented.txt
/html
+/tmpl
/xml
/version
/.libs
diff --git a/libgimpcolor/gimpadaptivesupersample.c b/libgimpcolor/gimpadaptivesupersample.c
index d68b75e..631f34e 100644
--- a/libgimpcolor/gimpadaptivesupersample.c
+++ b/libgimpcolor/gimpadaptivesupersample.c
@@ -28,6 +28,16 @@
#include "gimprgb.h"
+/**
+ * SECTION: GimpAdaptiveSupersample
+ * @title: GimpAdaptiveSupersample
+ * @short_description: Functions to perform adaptive supersampling on
+ * an area.
+ *
+ * Functions to perform adaptive supersampling on an area.
+ **/
+
+
/*********************************************************************/
/* Sumpersampling code (Quartic) */
/* This code is *largely* based on the sources for POV-Ray 3.0. I am */
diff --git a/libgimpcolor/gimpbilinear.c b/libgimpcolor/gimpbilinear.c
index 2cce3e0..c901d26 100644
--- a/libgimpcolor/gimpbilinear.c
+++ b/libgimpcolor/gimpbilinear.c
@@ -27,6 +27,15 @@
#include "gimpbilinear.h"
+/**
+ * SECTION: GimpBilinear
+ * @title: GimpBilinear
+ * @short_description: Utility functions for bilinear interpolation.
+ *
+ * Utility functions for bilinear interpolation.
+ **/
+
+
gdouble
gimp_bilinear (gdouble x,
gdouble y,
diff --git a/libgimpcolor/gimpcmyk.c b/libgimpcolor/gimpcmyk.c
index ebc6a61..471cdba 100644
--- a/libgimpcolor/gimpcmyk.c
+++ b/libgimpcolor/gimpcmyk.c
@@ -27,6 +27,15 @@
#include "gimpcmyk.h"
+/**
+ * SECTION: GimpCMYK
+ * @title: GimpCMYK
+ * @short_description: Definitions and Functions relating to CMYK colors.
+ *
+ * Definitions and Functions relating to CMYK colors.
+ **/
+
+
/*
* GIMP_TYPE_CMYK
*/
diff --git a/libgimpcolor/gimpcolormanaged.c b/libgimpcolor/gimpcolormanaged.c
index 06f03f2..fcba9fb 100644
--- a/libgimpcolor/gimpcolormanaged.c
+++ b/libgimpcolor/gimpcolormanaged.c
@@ -28,6 +28,15 @@
#include "gimpcolormanaged.h"
+/**
+ * SECTION: GimpColorManaged
+ * @title: GimpColorManaged
+ * @short_description: An interface dealing with color profiles.
+ *
+ * An interface dealing with color profiles.
+ **/
+
+
enum
{
PROFILE_CHANGED,
diff --git a/libgimpcolor/gimpcolorspace.c b/libgimpcolor/gimpcolorspace.c
index c6c61a2..98e8277 100644
--- a/libgimpcolor/gimpcolorspace.c
+++ b/libgimpcolor/gimpcolorspace.c
@@ -30,6 +30,19 @@
+/**
+ * SECTION: GimpColorSpace
+ * @title: GimpColorSpace
+ * @short_description: Utility functions which convert colors between
+ * different color models.
+ *
+ * When programming pixel data manipulation functions you will often
+ * use algorithms operating on a color model different from the one
+ * GIMP uses. This file provides utility functions to convert colors
+ * between different color spaces.
+ **/
+
+
#define GIMP_HSV_UNDEFINED -1.0
#define GIMP_HSL_UNDEFINED -1.0
diff --git a/libgimpcolor/gimphsv.c b/libgimpcolor/gimphsv.c
index b261234..12dfde3 100644
--- a/libgimpcolor/gimphsv.c
+++ b/libgimpcolor/gimphsv.c
@@ -25,6 +25,15 @@
#include "gimphsv.h"
+/**
+ * SECTION: GimpHSV
+ * @title: GimpHSV
+ * @short_description: Definitions and Functions relating to HSV colors.
+ *
+ * Definitions and Functions relating to HSV colors.
+ **/
+
+
/*
* GIMP_TYPE_HSV
*/
diff --git a/libgimpcolor/gimprgb.c b/libgimpcolor/gimprgb.c
index 7ad4aaa..a26d7bf 100644
--- a/libgimpcolor/gimprgb.c
+++ b/libgimpcolor/gimprgb.c
@@ -28,6 +28,15 @@
#include "gimprgb.h"
+/**
+ * SECTION: GimpRGB
+ * @title: GimpRGB
+ * @short_description: Definitions and Functions relating to RGB colors.
+ *
+ * Definitions and Functions relating to RGB colors.
+ **/
+
+
/*
* GIMP_TYPE_RGB
*/
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]