2007-12-17 Brian Tarricone <bjt23@cornell.edu>

    * Fix docs/ stuff to include new signal handling functionality.


(Old svn revision: 26490)

4 files changed, 80 insertions, 5 deletions

diff --git a/docs/libxfce4util-docs.sgml b/docs/libxfce4util-docs.sgml
index 1848a40..cf79f96 100644
--- a/docs/libxfce4util-docs.sgml
+++ b/docs/libxfce4util-docs.sgml
@@ -12,6 +12,7 @@
 <!ENTITY libxfce4util-Unicode-Functions SYSTEM "xml/xfce-utf8.xml">
 <!ENTITY libxfce4util-Desktop-Entries SYSTEM "xml/xfce-desktopentry.xml">
 <!ENTITY libxfce4util-Generics SYSTEM "xml/xfce-generics.xml">
+<!ENTITY libxfce4util-Signal-Handling SYSTEM "xml/xfce-posix-signal-handler.xml">
 <!ENTITY version SYSTEM "version.xml">
 ]>
 
@@ -41,6 +42,7 @@
 		<title>Xfce Core Application support</title>
 		&libxfce4util-Desktop-Entries;
 		&libxfce4util-Kiosk;
+		&libxfce4util-Signal-Handling;
 	</chapter>
 
 	<chapter id="libxfce4util-utilities">
diff --git a/docs/libxfce4util-sections.txt b/docs/libxfce4util-sections.txt
index 984af6b..007856c 100644
--- a/docs/libxfce4util-sections.txt
+++ b/docs/libxfce4util-sections.txt
@@ -165,4 +165,12 @@ XFCE_DESKTOP_ENTRY_GET_CLASS
 xfce_desktop_entry_get_type
 </SECTION>
 
-
+<SECTION>
+<TITLE>POSIX Signal Handling</TITLE>
+<FILE>xfce-posix-signal-handler</FILE>
+XfcePosixSignalHandler
+xfce_posix_signal_handler_init
+xfce_posix_signal_handler_restore_handler
+xfce_posix_signal_handler_set_handler
+xfce_posix_signal_handler_shutdown
+</SECTION>
diff --git a/docs/tmpl/xfce-miscutils.sgml b/docs/tmpl/xfce-miscutils.sgml
index 2aecfb1..9a38e78 100644
--- a/docs/tmpl/xfce-miscutils.sgml
+++ b/docs/tmpl/xfce-miscutils.sgml
@@ -37,8 +37,6 @@ path of the current user's home directory.
           home directory. The caller is responsible for freeing the
 	  returned string using g_free().
 <!-- # Unused Parameters # -->
-@...: 
-@...: 
 @first_element...: NULL terminated list of path components.
 
 
@@ -73,8 +71,6 @@ formed by a NULL terminated list of path components.
           directory. The caller is responsible for freeing the returned
 	  string using g_free().
 <!-- # Unused Parameters # -->
-@...: 
-@...: 
 @first_element...: NULL terminated list of path components.
 
 
diff --git a/docs/tmpl/xfce-posix-signal-handler.sgml b/docs/tmpl/xfce-posix-signal-handler.sgml
new file mode 100644
index 0000000..363f7e8
--- /dev/null
+++ b/docs/tmpl/xfce-posix-signal-handler.sgml
@@ -0,0 +1,69 @@
+<!-- ##### SECTION Title ##### -->
+POSIX Signal Handling
+
+<!-- ##### SECTION Short_Description ##### -->
+a callback system for handling POSIX signals safely
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+Due to reentrancy issues, there is a restricted set of functions/syscalls
+that are allowed to be performed inside a POSIX signal handler.  In
+general, it's safer to defer any signal-related processing until after the
+signal handler has run.  The functionality in this module automatically
+handles this, and allows you to set a handler function (with optional user
+data) for any signal.
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### USER_FUNCTION XfcePosixSignalHandler ##### -->
+<para>
+A function signature to use for POSIX signal handler functions.
+</para>
+
+@signal: The signal that was caught.
+@user_data: The @user_data parameter passed when the handler was registered.
+
+
+<!-- ##### FUNCTION xfce_posix_signal_handler_init ##### -->
+<para>
+
+</para>
+
+@error: 
+@Returns: 
+
+
+<!-- ##### FUNCTION xfce_posix_signal_handler_restore_handler ##### -->
+<para>
+
+</para>
+
+@signal: 
+
+
+<!-- ##### FUNCTION xfce_posix_signal_handler_set_handler ##### -->
+<para>
+
+</para>
+
+@signal: 
+@handler: 
+@user_data: 
+@error: 
+@Returns: 
+
+
+<!-- ##### FUNCTION xfce_posix_signal_handler_shutdown ##### -->
+<para>
+
+</para>
+
+
+