From 333e8460896742805f81676c392cb989c2a19fe6 Mon Sep 17 00:00:00 2001
From: David Zeuthen <davidz@redhat.com>
Date: Tue, 7 Sep 2010 13:18:58 -0400
Subject: [PATCH] Add docs for UDisksJobImpl

Signed-off-by: David Zeuthen <davidz@redhat.com>
---
 doc/udisks-docs.xml        |  3 ++-
 doc/udisks-sections.txt.in | 13 +++++++++++++
 doc/udisks.types.in        |  1 +
 src/udisksjobimpl.c        | 21 +++++++++++++++++++++
 4 files changed, 37 insertions(+), 1 deletion(-)

diff --git a/doc/udisks-docs.xml b/doc/udisks-docs.xml
index 0c6bfb1..25ebe70 100644
--- a/doc/udisks-docs.xml
+++ b/doc/udisks-docs.xml
@@ -85,9 +85,10 @@
   <part id="ref-daemon">
     <title>Daemon Implementation Details</title>
     <xi:include href="xml/udisksdaemon.xml"/>
-    <xi:include href="xml/udisksfilesystemimpl.xml"/>
     <xi:include href="xml/udiskslinuxblock.xml"/>
     <xi:include href="xml/udiskslinuxprovider.xml"/>
+    <xi:include href="xml/udisksfilesystemimpl.xml"/>
+    <xi:include href="xml/udisksjobimpl.xml"/>
   </part>
 
   <part id="tools-fileformats">
diff --git a/doc/udisks-sections.txt.in b/doc/udisks-sections.txt.in
index 7981260..ec1fffb 100644
--- a/doc/udisks-sections.txt.in
+++ b/doc/udisks-sections.txt.in
@@ -26,6 +26,19 @@ udisks_filesystem_impl_get_type
 </SECTION>
 
 <SECTION>
+<FILE>udisksjobimpl</FILE>
+<TITLE>UDisksJobImpl</TITLE>
+UDisksJobImpl
+udisks_job_impl_new
+<SUBSECTION Standard>
+UDISKS_TYPE_JOB_IMPL
+UDISKS_JOB_IMPL
+UDISKS_IS_JOB_IMPL
+<SUBSECTION Private>
+udisks_job_impl_get_type
+</SECTION>
+
+<SECTION>
 <FILE>udiskslinuxblock</FILE>
 <TITLE>UDisksLinuxBlock</TITLE>
 UDisksLinuxBlock
diff --git a/doc/udisks.types.in b/doc/udisks.types.in
index 454fadc..e05e6d0 100644
--- a/doc/udisks.types.in
+++ b/doc/udisks.types.in
@@ -2,3 +2,4 @@ udisks_daemon_get_type
 udisks_filesystem_impl_get_type
 udisks_linux_block_get_type
 udisks_linux_provider_get_type
+udisks_job_impl_get_type
diff --git a/src/udisksjobimpl.c b/src/udisksjobimpl.c
index 5fbbda6..f69fa98 100644
--- a/src/udisksjobimpl.c
+++ b/src/udisksjobimpl.c
@@ -22,8 +22,22 @@
 
 #include "udisksjobimpl.h"
 
+/**
+ * SECTION:udisksjobimpl
+ * @title: UDisksJobImpl
+ * @short_description: Job Implementation
+ *
+ * This type provides an implementation of the #UDisksJob interface.
+ */
+
 typedef struct _UDisksJobImplClass   UDisksJobImplClass;
 
+/**
+ * UDisksJobImpl:
+ *
+ * The #UDisksJobImpl structure contains only private data and should
+ * only be accessed using the provided API.
+ */
 struct _UDisksJobImpl
 {
   UDisksJobStub parent_instance;
@@ -49,6 +63,13 @@ udisks_job_impl_class_init (UDisksJobImplClass *klass)
 {
 }
 
+/**
+ * udisks_job_impl_new:
+ *
+ * Creates a new #UDisksJobImpl instance.
+ *
+ * Returns: A new #UDisksJob. Free with g_object_unref().
+ */
 UDisksJob *
 udisks_job_impl_new (void)
 {
-- 
2.7.4