From b67ade8022051fa13042a3ea2a398675c6157aea Mon Sep 17 00:00:00 2001
From: Vincent Untz <vuntz@gnome.org>
Date: Wed, 5 Nov 2008 14:21:25 +0000
Subject: add most stuff to have all API listed in the doc. The API is not

2008-11-05  Vincent Untz  <vuntz@gnome.org>

	* docs/reference/gnome-desktop/gnome-desktop-docs.sgml:
	* docs/reference/gnome-desktop/gnome-desktop-sections.txt:
	* docs/reference/gnome-desktop/gnome-desktop.types: add most stuff to
	have all API listed in the doc. The API is not documented, though :/

svn path=/trunk/; revision=5277
---
 .../gnome-desktop/gnome-desktop-docs.sgml          |  33 +++-
 .../gnome-desktop/gnome-desktop-sections.txt       | 186 +++++++++++++++++++++
 docs/reference/gnome-desktop/gnome-desktop.types   |   6 +
 3 files changed, 219 insertions(+), 6 deletions(-)

(limited to 'docs')

diff --git a/docs/reference/gnome-desktop/gnome-desktop-docs.sgml b/docs/reference/gnome-desktop/gnome-desktop-docs.sgml
index a1b1feb8..be54d9ce 100644
--- a/docs/reference/gnome-desktop/gnome-desktop-docs.sgml
+++ b/docs/reference/gnome-desktop/gnome-desktop-docs.sgml
@@ -10,15 +10,36 @@
    <title>GNOME Desktop Library Overview</title>
    <partintro>
     <para>
-The libgnome-desktop library contains APIs that really belong in libgnome[ui] but have not seen enough testing or development to be considered stable. Use at your own risk.
+The libgnome-desktop library contains APIs that can be useful for a few applications, but which do not belong to GTK+ because of the limited use case. There is no guarantee of API or ABI stability, so it's recommended to not depend on it if you do not follow the same development cycle as GNOME. Use at your own risk.
     </para>
    </partintro>
   </part>
 
-  <chapter>
-    <title>API reference</title>
-    <xi:include href="xml/gnome-ditem-edit.xml"/>
-    <xi:include href="xml/gnome-hint.xml"/>
+  <part id="background">
+    <title>Desktop Background</title>
+    <xi:include href="xml/gnome-bg.xml"/>
+  </part>
+
+  <part id="randr">
+    <title>Monitor Configuration</title>
+    <xi:include href="xml/gnome-rr-screen.xml"/>
+    <xi:include href="xml/gnome-rr-output.xml"/>
+    <xi:include href="xml/gnome-rr-crtc.xml"/>
+    <xi:include href="xml/gnome-rr-mode.xml"/>
+    <xi:include href="xml/gnome-rr-config.xml"/>
+    <xi:include href="xml/gnome-rr-labeler.xml"/>
+  </part>
+
+  <part id="thumbnail">
+    <title>Thumbnails</title>
+    <xi:include href="xml/gnome-desktop-thumbnail-factory.xml"/>
+    <xi:include href="xml/gnome-desktop-thumbnail.xml"/>
+  </part>
+
+  <part id="libgnome">
+    <title>Miscellaneous</title>
     <xi:include href="xml/gnome-desktop-item.xml"/>
-  </chapter>
+    <xi:include href="xml/gnome-desktop-utils.xml"/>
+  </part>
+
 </book>
diff --git a/docs/reference/gnome-desktop/gnome-desktop-sections.txt b/docs/reference/gnome-desktop/gnome-desktop-sections.txt
index 98fca009..91e9dcdf 100644
--- a/docs/reference/gnome-desktop/gnome-desktop-sections.txt
+++ b/docs/reference/gnome-desktop/gnome-desktop-sections.txt
@@ -1,3 +1,146 @@
+<SECTION>
+<INCLUDE>libgnomeui/gnome-bg.h</INCLUDE>
+<FILE>gnome-bg</FILE>
+<TITLE>GnomeBG</TITLE>
+GnomeBG
+GnomeBGColorType
+GnomeBGPlacement
+GNOME_BG_KEY_DIR
+gnome_bg_new
+gnome_bg_load_from_preferences
+gnome_bg_save_to_preferences
+gnome_bg_set_filename
+gnome_bg_set_placement
+gnome_bg_set_color
+gnome_bg_get_filename
+gnome_bg_get_placement
+gnome_bg_get_color
+gnome_bg_draw
+gnome_bg_create_pixmap
+gnome_bg_get_image_size
+gnome_bg_create_thumbnail
+gnome_bg_is_dark
+gnome_bg_changes_with_size
+gnome_bg_set_pixmap_as_root
+<SUBSECTION Private>
+gnome_bg_get_type
+<SUBSECTION Standard>
+GNOME_BG
+GNOME_IS_BG
+GNOME_TYPE_BG
+GNOME_BG_CLASS
+GNOME_IS_BG_CLASS
+GNOME_BG_GET_CLASS
+GnomeBGClass
+</SECTION>
+
+<SECTION>
+<INCLUDE>libgnomeui/gnome-rr.h</INCLUDE>
+<FILE>gnome-rr-screen</FILE>
+<TITLE></TITLE>
+GnomeRRScreen
+GnomeRRScreenChanged
+gnome_rr_screen_new
+gnome_rr_screen_destroy
+gnome_rr_screen_refresh
+gnome_rr_screen_list_outputs
+gnome_rr_screen_list_crtcs
+gnome_rr_screen_list_modes
+gnome_rr_screen_list_clone_modes
+gnome_rr_screen_set_size
+gnome_rr_screen_get_output_by_id
+gnome_rr_screen_get_output_by_name
+gnome_rr_screen_get_crtc_by_id
+gnome_rr_screen_get_ranges
+</SECTION>
+
+<SECTION>
+<INCLUDE>libgnomeui/gnome-rr.h</INCLUDE>
+<FILE>gnome-rr-output</FILE>
+<TITLE></TITLE>
+GnomeRROutput
+gnome_rr_output_get_id
+gnome_rr_output_get_name
+gnome_rr_output_is_connected
+gnome_rr_output_get_size_inches
+gnome_rr_output_get_width_mm
+gnome_rr_output_get_height_mm
+gnome_rr_output_get_edid_data
+gnome_rr_output_get_possible_crtcs
+gnome_rr_output_list_modes
+gnome_rr_output_get_current_mode
+gnome_rr_output_get_preferred_mode
+gnome_rr_output_supports_mode
+gnome_rr_output_get_crtc
+gnome_rr_output_get_position
+gnome_rr_output_can_clone
+</SECTION>
+
+<SECTION>
+<INCLUDE>libgnomeui/gnome-rr.h</INCLUDE>
+<FILE>gnome-rr-crtc</FILE>
+<TITLE></TITLE>
+GnomeRRCrtc
+GnomeRRRotation
+gnome_rr_crtc_get_id
+gnome_rr_crtc_set_config
+gnome_rr_crtc_can_drive_output
+gnome_rr_crtc_get_current_mode
+gnome_rr_crtc_get_position
+gnome_rr_crtc_supports_rotation
+gnome_rr_crtc_get_current_rotation
+gnome_rr_crtc_get_rotations
+</SECTION>
+
+<SECTION>
+<INCLUDE>libgnomeui/gnome-rr.h</INCLUDE>
+<FILE>gnome-rr-mode</FILE>
+<TITLE></TITLE>
+GnomeRRMode
+gnome_rr_mode_get_id
+gnome_rr_mode_get_width
+gnome_rr_mode_get_height
+gnome_rr_mode_get_freq
+</SECTION>
+
+<SECTION>
+<INCLUDE>libgnomeui/gnome-rr-config.h</INCLUDE>
+<FILE>gnome-rr-config</FILE>
+<TITLE></TITLE>
+GnomeOutputInfo
+GnomeRRConfig
+gnome_rr_config_new_current
+gnome_rr_config_new_stored
+gnome_rr_config_free
+gnome_rr_config_match
+gnome_rr_config_equal
+gnome_rr_config_save
+gnome_rr_config_sanitize
+gnome_rr_config_apply
+gnome_rr_config_apply_stored
+gnome_rr_config_applicable
+</SECTION>
+
+<SECTION>
+<INCLUDE>libgnomeui/gnome-rr-labeler.h</INCLUDE>
+<FILE>gnome-rr-labeler</FILE>
+<TITLE>GnomeRRLabeler</TITLE>
+GnomeRRLabeler
+gnome_rr_labeler_new
+gnome_rr_labeler_hide
+gnome_rr_labeler_get_color_for_output
+<SUBSECTION Private>
+gnome_rr_labeler_get_type
+<SUBSECTION Standard>
+GNOME_RR_LABELER
+GNOME_IS_RR_LABELER
+GNOME_TYPE_RR_LABELER
+GNOME_RR_LABELER_CLASS
+GNOME_IS_RR_LABELER_CLASS
+GNOME_RR_LABELER_GET_CLASS
+GnomeRRLabelerClass
+</SECTION>
+
 <SECTION>
 <INCLUDE>libgnome/gnome-desktop-item.h</INCLUDE>
 <FILE>gnome-desktop-item</FILE>
@@ -89,3 +232,46 @@ gnome_desktop_item_get_type
 gnome_desktop_item_error_quark
 </SECTION>
 
+<SECTION>
+<INCLUDE>libgnomeui/gnome-thumbnail.h</INCLUDE>
+<FILE>gnome-desktop-thumbnail</FILE>
+<TITLE>Miscellaneous Thumbnail Functions</TITLE>
+gnome_desktop_thumbnail_has_uri
+gnome_desktop_thumbnail_is_valid
+gnome_desktop_thumbnail_md5
+gnome_desktop_thumbnail_path_for_uri
+gnome_desktop_thumbnail_scale_down_pixbuf
+</SECTION>
+
+<SECTION>
+<INCLUDE>libgnomeui/gnome-thumbnail.h</INCLUDE>
+<FILE>gnome-desktop-thumbnail-factory</FILE>
+<TITLE>GnomeDesktopThumbnailFactory</TITLE>
+GnomeDesktopThumbnailFactory
+GnomeDesktopThumbnailSize
+gnome_desktop_thumbnail_factory_new
+gnome_desktop_thumbnail_factory_lookup
+gnome_desktop_thumbnail_factory_has_valid_failed_thumbnail
+gnome_desktop_thumbnail_factory_can_thumbnail
+gnome_desktop_thumbnail_factory_generate_thumbnail
+gnome_desktop_thumbnail_factory_save_thumbnail
+gnome_desktop_thumbnail_factory_create_failed_thumbnail
+<SUBSECTION Private>
+GnomeDesktopThumbnailFactoryPrivate
+gnome_desktop_thumbnail_factory_get_type
+<SUBSECTION Standard>
+GNOME_DESKTOP_THUMBNAIL_FACTORY
+GNOME_DESKTOP_IS_THUMBNAIL_FACTORY
+GNOME_DESKTOP_TYPE_THUMBNAIL_FACTORY
+GNOME_DESKTOP_THUMBNAIL_FACTORY_CLASS
+GNOME_DESKTOP_IS_THUMBNAIL_FACTORY_CLASS
+GnomeDesktopThumbnailFactoryClass
+</SECTION>
+
+<SECTION>
+<INCLUDE>libgnome/gnome-desktop-utils.h</INCLUDE>
+<FILE>gnome-desktop-utils</FILE>
+<TITLE>Miscellaneous Functions</TITLE>
+gnome_desktop_prepend_terminal_to_vector
+</SECTION>
+
diff --git a/docs/reference/gnome-desktop/gnome-desktop.types b/docs/reference/gnome-desktop/gnome-desktop.types
index 7aadd529..2bab9765 100644
--- a/docs/reference/gnome-desktop/gnome-desktop.types
+++ b/docs/reference/gnome-desktop/gnome-desktop.types
@@ -1,3 +1,9 @@
 #include <libgnome/gnome-desktop-item.h>
+#include <libgnomeui/gnome-bg.h>
+#include <libgnomeui/gnome-desktop-thumbnail.h>
+#include <libgnomeui/gnome-rr-labeler.h>
 
 gnome_desktop_item_get_type
+gnome_bg_get_type
+gnome_desktop_thumbnail_factory_get_type
+gnome_rr_labeler_get_type
-- 
cgit v1.2.1