[gnome-disk-utility/new-ui] Semi clean-up of API docs
- From: David Zeuthen <davidz src gnome org>
- To: svn-commits-list gnome org
- Cc:
- Subject: [gnome-disk-utility/new-ui] Semi clean-up of API docs
- Date: Sat, 3 Oct 2009 16:48:53 +0000 (UTC)
commit 3b2c427de1aa642519c323b6bae7a2d10f6f4656
Author: David Zeuthen <davidz redhat com>
Date: Sat Oct 3 12:44:58 2009 -0400
Semi clean-up of API docs
Very far from perfect but at least better than what we had.
doc/Makefile.am | 25 +++++++++++++----------
doc/gnome-disk-utility-docs.xml | 40 ++++++++++++++++++++++++++------------
doc/gnome-disk-utility.types | 18 +++++++++++++++++
3 files changed, 59 insertions(+), 24 deletions(-)
---
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 6799fda..002fb8b 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -11,13 +11,13 @@ DOC_MODULE=gnome-disk-utility
DOC_MAIN_SGML_FILE=gnome-disk-utility-docs.xml
# Extra options to supply to gtkdoc-scan
-SCAN_OPTIONS=--ignore-headers="config.h devkit-disks-daemon-glue.h devkit-disks-device-glue.h gdu-private.h gdu-marshal.h gdu-shared.h"
+SCAN_OPTIONS=--ignore-headers="config.h devkit-disks-daemon-glue.h devkit-disks-device-glue.h gdu-private.h gdu-marshal.h gdu-shared.h" --rebuild-sections
# The directory containing the source code. Relative to $(srcdir)
-DOC_SOURCE_DIR=../src/gdu
+DOC_SOURCE_DIR=../src/gdu --source-dir=../src/gdu-gtk
# Used for dependencies
-HFILE_GLOB=$(top_srcdir)/src/gdu/*.h
-CFILE_GLOB=$(top_srcdir)/src/gdu/*.c
+HFILE_GLOB=$(top_srcdir)/src/gdu*/*.h
+CFILE_GLOB=$(top_srcdir)/src/gdu*/*.c
# Headers to ignore
IGNORE_HFILES= \
@@ -28,8 +28,12 @@ IGNORE_HFILES= \
INCLUDES = \
$(GTK_CFLAGS) \
$(DBUS_GLIB_CFLAGS) \
- -I$(top_srcdir) \
- -I$(top_builddir) \
+ -I$(top_srcdir)/src \
+ -I$(top_builddir)/src \
+ -I$(top_srcdir)/src/gdu \
+ -I$(top_builddir)/src/gdu \
+ -I$(top_srcdir)/src/gdu-gtk \
+ -I$(top_builddir)/src/gdu-gtk \
$(NULL)
GTKDOC_LIBS = \
@@ -39,6 +43,7 @@ GTKDOC_LIBS = \
$(DBUS_GLIB_LIBS) \
$(GNOME_KEYRING_LIBS) \
$(top_builddir)/src/gdu/libgdu.la \
+ $(top_builddir)/src/gdu-gtk/libgdu-gtk.la \
$(NULL)
# Extra options to supply to gtkdoc-mkdb
@@ -63,14 +68,12 @@ FIXXREF_OPTIONS=
MAINTAINERCLEANFILES = \
*~ \
Makefile.in \
- gnome-disk-utility.types \
- gnome-disk-utility-*.txt \
$(NULL)
include $(top_srcdir)/gtk-doc.make
CLEANFILES += *~ \
- gnome-disk-utility-scan.* \
+ gnome-disk-utility-scan* \
gnome-disk-utility.args \
gnome-disk-utility.hierarchy \
gnome-disk-utility.interfaces \
@@ -82,9 +85,9 @@ CLEANFILES += *~ \
gnome-disk-utility-overrides.txt \
gnome-disk-utility-undeclared.txt \
gnome-disk-utility-undocumented.txt \
- gnome-disk-utility-sections.txt \ # remove when API is baked
+ gnome-disk-utility-sections.txt \
*.stamp \
- -rf html xml \
+ -rf html xml tmpl \
$(NULL)
# Version information for marking the documentation
diff --git a/doc/gnome-disk-utility-docs.xml b/doc/gnome-disk-utility-docs.xml
index 1f40988..2aa6839 100644
--- a/doc/gnome-disk-utility-docs.xml
+++ b/doc/gnome-disk-utility-docs.xml
@@ -55,15 +55,8 @@
</legalnotice>
</bookinfo>
- <reference id="ref-core">
- <title>API Reference</title>
- <partintro>
- <para>
- This part presents the class and function reference for the
- PolicyKit-gnome library, <literal>libpolkit-gnome</literal>.
- </para>
- </partintro>
- <xi:include href="xml/gdu-error.xml"/>
+ <reference id="ref-libgdu">
+ <title>libgdu API Reference</title>
<xi:include href="xml/gdu-pool.xml"/>
<xi:include href="xml/gdu-device.xml"/>
<xi:include href="xml/gdu-presentable.xml"/>
@@ -71,12 +64,33 @@
<xi:include href="xml/gdu-linux-md-drive.xml"/>
<xi:include href="xml/gdu-volume.xml"/>
<xi:include href="xml/gdu-volume-hole.xml"/>
- <xi:include href="xml/gdu-known-filesystem.xml"/>
+ <xi:include href="xml/gdu-callbacks.xml"/>
+ <xi:include href="xml/gdu-error.xml"/>
<xi:include href="xml/gdu-process.xml"/>
- <xi:include href="xml/gdu-ata-smart-attribute.xml"/>
- <xi:include href="xml/gdu-ata-smart-historical-data.xml"/>
<xi:include href="xml/gdu-util.xml"/>
- <xi:include href="xml/gdu-callbacks.xml"/>
+ <xi:include href="xml/gdu-known-filesystem.xml"/>
+ </reference>
+
+ <reference id="ref-libgdu-gtk">
+ <title>libgdu-gtk API Reference</title>
+ <xi:include href="xml/gdu-details-element.xml"/>
+ <xi:include href="xml/gdu-details-table.xml"/>
+ <xi:include href="xml/gdu-button-element.xml"/>
+ <xi:include href="xml/gdu-button-table.xml"/>
+ <xi:include href="xml/gdu-dialog.xml"/>
+ <xi:include href="xml/gdu-ata-smart-dialog.xml"/>
+ <xi:include href="xml/gdu-create-linux-md-dialog.xml"/>
+ <xi:include href="xml/gdu-edit-partition-dialog.xml"/>
+ <xi:include href="xml/gdu-error-dialog.xml"/>
+ <xi:include href="xml/gdu-gtk-enums.xml"/>
+ <xi:include href="xml/gdu-gtk-enumtypes.xml"/>
+ <xi:include href="xml/gdu-gtk.xml"/>
+ <xi:include href="xml/gdu-pool-tree-model.xml"/>
+ <xi:include href="xml/gdu-pool-tree-view.xml"/>
+ <xi:include href="xml/gdu-size-widget.xml"/>
+ <xi:include href="xml/gdu-spinner.xml"/>
+ <xi:include href="xml/gdu-time-label.xml"/>
+ <xi:include href="xml/gdu-volume-grid.xml"/>
</reference>
<!-- License -->
diff --git a/doc/gnome-disk-utility.types b/doc/gnome-disk-utility.types
index d5a7024..8bf88c8 100644
--- a/doc/gnome-disk-utility.types
+++ b/doc/gnome-disk-utility.types
@@ -7,3 +7,21 @@ gdu_linux_md_drive_get_type
gdu_drive_get_type
gdu_device_get_type
gdu_volume_hole_get_type
+gdu_edit_partition_dialog_get_type
+gdu_spinner_get_type
+gdu_ata_smart_dialog_get_type
+gdu_time_label_get_type
+gdu_create_linux_md_dialog_get_type
+gdu_pool_tree_view_get_type
+gdu_details_table_get_type
+gdu_pool_tree_model_get_type
+gdu_button_table_get_type
+gdu_error_dialog_get_type
+gdu_button_element_get_type
+gdu_size_widget_get_type
+gdu_volume_grid_get_type
+gdu_pool_tree_model_column_get_type
+gdu_pool_tree_view_flags_get_type
+gdu_pool_tree_model_flags_get_type
+gdu_dialog_get_type
+gdu_details_element_get_type
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]