summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRichard Hughes <richard@hughsie.com>2012-05-09 14:59:29 +0100
committerRichard Hughes <richard@hughsie.com>2012-05-09 15:00:11 +0100
commitae9d72d925f073539f9a1ff39996bb2476a88664 (patch)
tree74a529aec0813bf201863836d6ee60854af622da
parentddf8bed4dcc0cb5255107d5f966c3a8567e00506 (diff)
downloadcolord-ae9d72d925f073539f9a1ff39996bb2476a88664.tar.gz
trivial: fix quite a few issues with the gtk-doc documentation
-rw-r--r--doc/api/colord-docs.xml7
-rw-r--r--libcolord-gtk/Makefile.am2
-rw-r--r--libcolord-gtk/colord-gtk.h2
-rw-r--r--libcolord/cd-color.c9
-rw-r--r--libcolord/cd-it8-utils.c16
-rw-r--r--libcolord/cd-it8.c3
6 files changed, 29 insertions, 10 deletions
diff --git a/doc/api/colord-docs.xml b/doc/api/colord-docs.xml
index 11880b1..ef88994 100644
--- a/doc/api/colord-docs.xml
+++ b/doc/api/colord-docs.xml
@@ -64,6 +64,7 @@
colord daemon.
</para>
</partintro>
+ <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
<xi:include href="dbus/org.freedesktop.ColorManager.ref.xml"/>
<xi:include href="dbus/org.freedesktop.ColorManager.Device.ref.xml"/>
<xi:include href="dbus/org.freedesktop.ColorManager.Profile.ref.xml"/>
@@ -80,6 +81,7 @@
<xi:include href="xml/cd-client.xml"/>
<xi:include href="xml/cd-device.xml"/>
<xi:include href="xml/cd-profile.xml"/>
+ <xi:include href="xml/cd-sensor.xml"/>
<xi:include href="xml/cd-it8.xml"/>
</reference>
@@ -93,7 +95,10 @@
<xi:include href="xml/cd-client-sync.xml"/>
<xi:include href="xml/cd-device-sync.xml"/>
<xi:include href="xml/cd-profile-sync.xml"/>
+ <xi:include href="xml/cd-sensor-sync.xml"/>
+ <xi:include href="xml/cd-it8-utils.xml"/>
<xi:include href="xml/cd-version.xml"/>
+ <xi:include href="xml/cd-math.xml"/>
<xi:include href="xml/cd-color.xml"/>
</reference>
@@ -106,7 +111,7 @@
<appendix id="license">
<title>License</title>
<para>
-<programlisting><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../COPYING" parse="text"><xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback></xi:include></programlisting>
+<programlisting><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../COPYING" parse="text"><xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback></xi:include></programlisting>
</para>
</appendix>
</book>
diff --git a/libcolord-gtk/Makefile.am b/libcolord-gtk/Makefile.am
index db5de15..a26b800 100644
--- a/libcolord-gtk/Makefile.am
+++ b/libcolord-gtk/Makefile.am
@@ -80,7 +80,7 @@ introspection_sources = \
$(libcolordgtkbase_include_HEADERS)
ColordGtk-1.0.gir: libcolord-gtk.la
-ColordGtk_1_0_gir_INCLUDES = GObject-2.0 Gio-2.0 Colord-1.0
+ColordGtk_1_0_gir_INCLUDES = GObject-2.0 Gio-2.0 Gtk-3.0 Colord-1.0
ColordGtk_1_0_gir_CFLAGS = $(INCLUDES)
ColordGtk_1_0_gir_SCANNERFLAGS = --identifier-prefix=Cd \
--symbol-prefix=cd_ \
diff --git a/libcolord-gtk/colord-gtk.h b/libcolord-gtk/colord-gtk.h
index 4c77c36..d2a7adf 100644
--- a/libcolord-gtk/colord-gtk.h
+++ b/libcolord-gtk/colord-gtk.h
@@ -33,6 +33,8 @@
#define __COLORD_H_INSIDE__
+#include <gtk/gtk.h>
+
#include <colord/cd-client.h>
#include <colord/cd-device.h>
#include <colord/cd-profile.h>
diff --git a/libcolord/cd-color.c b/libcolord/cd-color.c
index aebe389..a34fd01 100644
--- a/libcolord/cd-color.c
+++ b/libcolord/cd-color.c
@@ -79,9 +79,10 @@ cd_color_yxy_dup (const CdColorYxy *src)
/**
* cd_color_xyz_get_type:
- * Return value: a #GType
*
* Gets a specific type.
+ *
+ * Return value: a #GType
**/
GType
cd_color_xyz_get_type (void)
@@ -96,9 +97,10 @@ cd_color_xyz_get_type (void)
/**
* cd_color_rgb_get_type:
- * Return value: a #GType
*
* Gets a specific type.
+ *
+ * Return value: a #GType
**/
GType
cd_color_rgb_get_type (void)
@@ -113,9 +115,10 @@ cd_color_rgb_get_type (void)
/**
* cd_color_yxy_get_type:
- * Return value: a #GType
*
* Gets a specific type.
+ *
+ * Return value: a #GType
**/
GType
cd_color_yxy_get_type (void)
diff --git a/libcolord/cd-it8-utils.c b/libcolord/cd-it8-utils.c
index 9333531..bdaedf7 100644
--- a/libcolord/cd-it8-utils.c
+++ b/libcolord/cd-it8-utils.c
@@ -20,10 +20,10 @@
*/
/**
- * SECTION:cd-2color
- * @short_description: Color object data functionality
+ * SECTION:cd-it8-utils
+ * @short_description: Utilities for working with CdIt8 objects
*
- * Functions to manipulate color values.
+ * Functions to do cool things with sets of reference and measurements.
*/
#include "config.h"
@@ -173,9 +173,15 @@ out:
/**
* cd_it8_utils_calculate_ccmx:
+ * @it8_reference: The reference data
+ * @it8_measured: The measured data
+ * @it8_ccmx: The calculated correction matrix
+ * @error: A #GError, or %NULL
*
- * This calculates the matrix using the Four-Color Matrix Method
- * (by Yoshihiro Ohno and Jonathan E. Hardis, 1997)
+ * This calculates the colorimter correction matrix using the Four-Color
+ * Matrix Method by Yoshihiro Ohno and Jonathan E. Hardis, 1997.
+ *
+ * Return value: %TRUE if a correction matrix was found.
**/
gboolean
cd_it8_utils_calculate_ccmx (CdIt8 *it8_reference,
diff --git a/libcolord/cd-it8.c b/libcolord/cd-it8.c
index 88ea7f1..4d5244c 100644
--- a/libcolord/cd-it8.c
+++ b/libcolord/cd-it8.c
@@ -1011,6 +1011,9 @@ cd_it8_get_data_size (CdIt8 *it8)
/**
* cd_it8_get_data_item:
* @it8: a #CdIt8 instance.
+ * @idx: the item index
+ * @rgb: the returned RGB value
+ * @xyz: the returned XYZ value
*
* Gets a specific bit of data from this object.
* The returned data are absolute readings and are not normalised.