diff options
author | Romain B <skunnyk@alteroot.org> | 2017-12-09 18:31:06 +0100 |
---|---|---|
committer | Romain B <skunnyk@alteroot.org> | 2017-12-09 18:31:06 +0100 |
commit | 4785e47190632cc867d85af70ce4738d911e64c7 (patch) | |
tree | cca16eef5f9121618a194fd3523177558b2b0aa2 /docs | |
parent | 09c590d1d7757a33e8ebae10fa85e466112ced54 (diff) | |
download | libxfce4util-4785e47190632cc867d85af70ce4738d911e64c7.tar.gz |
Better documentation processing
- No more sgml things !
- You only need to add new functions to docs/libxfce4utils-sections.txt to add them to the doc.
Diffstat (limited to 'docs')
-rw-r--r-- | docs/Makefile.am | 2 | ||||
-rw-r--r-- | docs/libxfce4util-docs.xml (renamed from docs/libxfce4util-docs.sgml) | 4 | ||||
-rw-r--r-- | docs/tmpl/debug.sgml | 34 | ||||
-rw-r--r-- | docs/tmpl/libxfce4util-config.sgml | 88 | ||||
-rw-r--r-- | docs/tmpl/libxfce4util-unused.sgml | 36 | ||||
-rw-r--r-- | docs/tmpl/xfce-fileutils.sgml | 33 | ||||
-rw-r--r-- | docs/tmpl/xfce-generics.sgml | 110 | ||||
-rw-r--r-- | docs/tmpl/xfce-i18n.sgml | 115 | ||||
-rw-r--r-- | docs/tmpl/xfce-kiosk.sgml | 55 | ||||
-rw-r--r-- | docs/tmpl/xfce-license.sgml | 61 | ||||
-rw-r--r-- | docs/tmpl/xfce-miscutils.sgml | 112 | ||||
-rw-r--r-- | docs/tmpl/xfce-posix-signal-handler.sgml | 73 | ||||
-rw-r--r-- | docs/tmpl/xfce-rc.sgml | 275 | ||||
-rw-r--r-- | docs/tmpl/xfce-resource.sgml | 124 | ||||
-rw-r--r-- | docs/tmpl/xfce-utf8.sgml | 42 |
15 files changed, 3 insertions, 1161 deletions
diff --git a/docs/Makefile.am b/docs/Makefile.am index 706171d..990fd38 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -8,7 +8,7 @@ AUTOMAKE_OPTIONS = 1.8 DOC_MODULE=libxfce4util # The top-level SGML file. -DOC_MAIN_SGML_FILE=libxfce4util-docs.sgml +DOC_MAIN_SGML_FILE=libxfce4util-docs.xml # Extra options to supply to gtkdoc-scan SCAN_OPTIONS=--deprecated-guards="XFCE_DISABLE_DEPRECATED" diff --git a/docs/libxfce4util-docs.sgml b/docs/libxfce4util-docs.xml index fb1830b..67779ba 100644 --- a/docs/libxfce4util-docs.sgml +++ b/docs/libxfce4util-docs.xml @@ -2,7 +2,7 @@ <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [ <!ENTITY libxfce4util-StandardMacros SYSTEM "xml/libxfce4util-config.xml"> -<!ENTITY libxfce4util-Internationalization SYSTEM "xml/xfce-i18n.xml"> +<!ENTITY libxfce4util-Internationalisation SYSTEM "xml/xfce-i18n.xml"> <!ENTITY libxfce4util-License SYSTEM "xml/xfce-license.xml"> <!ENTITY libxfce4util-Kiosk SYSTEM "xml/xfce-kiosk.xml"> <!ENTITY libxfce4util-Resource SYSTEM "xml/xfce-resource.xml"> @@ -33,7 +33,7 @@ <chapter id="libxfce4util-fundamentals"> <title>Xfce Fundamentals</title> &libxfce4util-StandardMacros; - &libxfce4util-Internationalization; + &libxfce4util-Internationalisation; &libxfce4util-License; </chapter> diff --git a/docs/tmpl/debug.sgml b/docs/tmpl/debug.sgml deleted file mode 100644 index 22d7e3f..0000000 --- a/docs/tmpl/debug.sgml +++ /dev/null @@ -1,34 +0,0 @@ -<!-- ##### SECTION Title ##### --> -debug - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### MACRO DBG ##### --> -<para> - -</para> - -@fmt: -@args...: - - -<!-- ##### MACRO TRACE ##### --> -<para> - -</para> - -@fmt: -@args...: - - diff --git a/docs/tmpl/libxfce4util-config.sgml b/docs/tmpl/libxfce4util-config.sgml deleted file mode 100644 index 603d300..0000000 --- a/docs/tmpl/libxfce4util-config.sgml +++ /dev/null @@ -1,88 +0,0 @@ -<!-- ##### SECTION Title ##### --> -Version Information - -<!-- ##### SECTION Short_Description ##### --> -Variables and functions to check the libxfce4util version - -<!-- ##### SECTION Long_Description ##### --> -<para> -These macros provide a few commonly-used features. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> -<ulink url="http://developer.gnome.org/doc/API/2.0/glib/glib-Standard-Macros.html">GLib Standard Macros</ulink> -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### FUNCTION xfce_version_string ##### --> -<para> - -</para> - -@void: -@Returns: - - -<!-- ##### VARIABLE libxfce4util_major_version ##### --> -<para> - -</para> - - -<!-- ##### VARIABLE libxfce4util_minor_version ##### --> -<para> - -</para> - - -<!-- ##### VARIABLE libxfce4util_micro_version ##### --> -<para> - -</para> - - -<!-- ##### MACRO LIBXFCE4UTIL_MAJOR_VERSION ##### --> -<para> -The major version number of the libxfce4util. -</para> - - - -<!-- ##### MACRO LIBXFCE4UTIL_MINOR_VERSION ##### --> -<para> -The minor version number of the libxfce4util. -</para> - - - -<!-- ##### MACRO LIBXFCE4UTIL_MICRO_VERSION ##### --> -<para> -The micro version number of the libxfce4util. -</para> - - - -<!-- ##### MACRO LIBXFCE4UTIL_CHECK_VERSION ##### --> -<para> -Checks the version of the libxfce4util library. It returns TRUE if the -libxfce4util library is the same or newer than the given version. -<example> -<title>Checking the version of the libxfce4util library</title> -<programlisting> - if (!LIBXFCE4UTIL_CHECK_VERSION (4, 1, 6)) - g_error ("libxfce4util version 4.1.6 or above is required."); -</programlisting> -</example> -</para> - -@major: the major version number. -@minor: the minor version number. -@micro: the micro version number. - - diff --git a/docs/tmpl/libxfce4util-unused.sgml b/docs/tmpl/libxfce4util-unused.sgml deleted file mode 100644 index 3589632..0000000 --- a/docs/tmpl/libxfce4util-unused.sgml +++ /dev/null @@ -1,36 +0,0 @@ -<!-- ##### SECTION ./tmpl/debug.sgml:Long_Description ##### --> -<para> - -</para> - - -<!-- ##### SECTION ./tmpl/debug.sgml:See_Also ##### --> -<para> - -</para> - - -<!-- ##### SECTION ./tmpl/debug.sgml:Short_Description ##### --> - - - -<!-- ##### SECTION ./tmpl/debug.sgml:Title ##### --> -debug - - -<!-- ##### MACRO DBG ##### --> -<para> - -</para> - -@fmt: -@args...: - -<!-- ##### MACRO TRACE ##### --> -<para> - -</para> - -@fmt: -@args...: - diff --git a/docs/tmpl/xfce-fileutils.sgml b/docs/tmpl/xfce-fileutils.sgml deleted file mode 100644 index 08cec62..0000000 --- a/docs/tmpl/xfce-fileutils.sgml +++ /dev/null @@ -1,33 +0,0 @@ -<!-- ##### SECTION Title ##### --> -File Utilities - -<!-- ##### SECTION Short_Description ##### --> -miscellaneous file-related utility functions. - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> -<ulink url="http://developer.gnome.org/doc/API/2.0/glib/glib-File-Utilities.html">GLib File Utilities</ulink> -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### FUNCTION xfce_mkdirhier ##### --> -<para> - -</para> - -@whole_path: -@mode: -@error: -@Returns: - - diff --git a/docs/tmpl/xfce-generics.sgml b/docs/tmpl/xfce-generics.sgml deleted file mode 100644 index 5ebc9bc..0000000 --- a/docs/tmpl/xfce-generics.sgml +++ /dev/null @@ -1,110 +0,0 @@ -<!-- ##### SECTION Title ##### --> -Xfce Generics - -<!-- ##### SECTION Short_Description ##### --> -Generic data types and related functions. - -<!-- ##### SECTION Long_Description ##### --> -<para> -This module provides generic data types - as known from the C++ standard -template library - for the brave C programmer. Since C does not provide -any template mechanism, these generics are completely based on C preprocessor -macros and the functions offer no type safety at all (though some common -mistakes will surely be caught by the C compiler). -</para> - -<para> -<example> -<title>Using a generic stack</title> -<programlisting> - typedef XFCE_GENERIC_STACK(int) IntStack; - - IntStack *stack = xfce_stack_new (IntStack); - - xfce_stack_push (stack, 0); - xfce_stack_push (stack, 1); - - printf ("Top is %d\n", xfce_stack_top (stack)); - - xfce_stack_pop (stack); - - printf ("Top is %d\n", xfce_stack_top (stack)); - - xfce_stack_free (stack); -</programlisting> -</example> -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### MACRO XFCE_GENERIC_STACK ##### --> -<para> -This macro is used to create a new stack data type which elements are of -@Type. For example, to create a stack type that handles elements of type -%double, you'd write the following -<programlisting> -typedef XFCE_GENERIC_STACK(double) MyDoubleStack; -</programlisting> -and furtheron refer to your stack type as %MyDoubleStack. -</para> - -@Type: Data type of the elements that should be handled by the stack. Can - be any valid data type from simple int's to complex structures. - - -<!-- ##### MACRO xfce_stack_new ##### --> -<para> -Creates a new instance of @StackType and returns a pointer to the newly -created instance. For example, imagine you declared a type %MyDoubleStack -as shown above, you can instantiate this type with -<programlisting> -MyDoubleStack *my_stack = xfce_stack_new (MyDoubleStack); -</programlisting> -</para> - -@StackType: Type of stack declared with #XFCE_GENERIC_STACK. - - -<!-- ##### MACRO xfce_stack_free ##### --> -<para> -Frees a stack, that was allocated using #xfce_stack_new. -</para> - -@stack: A stack object. - - -<!-- ##### MACRO xfce_stack_top ##### --> -<para> -Returns the top element from @stack. Note that this function does not -pop the top element, it just returns it. -</para> - -@stack: - - -<!-- ##### MACRO xfce_stack_pop ##### --> -<para> -Removes the top element from @stack. -</para> - -@stack: - - -<!-- ##### MACRO xfce_stack_push ##### --> -<para> -Pushes a new @value on top of @stack. -</para> - -@stack: -@value: - - diff --git a/docs/tmpl/xfce-i18n.sgml b/docs/tmpl/xfce-i18n.sgml deleted file mode 100644 index a61bd59..0000000 --- a/docs/tmpl/xfce-i18n.sgml +++ /dev/null @@ -1,115 +0,0 @@ -<!-- ##### SECTION Title ##### --> -Internationalization - -<!-- ##### SECTION Short_Description ##### --> -Internationalization and Localization Support Functions - -<!-- ##### SECTION Long_Description ##### --> -<para> -Provides functions to aid application developers making their software -localizable. It extends the basic internationalization support provided -by GLib 2.4 (and newer). See the <ulink -url="http://developer.gnome.org/doc/API/2.0/glib/glib-I18N.html">GLib -Internationalization</ulink> documentation for the information about the -basic functions and macros. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> -<ulink url="http://developer.gnome.org/doc/API/2.0/glib/glib-I18N.html">GLib -Internationalization</ulink> -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### FUNCTION xfce_textdomain ##### --> -<para> - -</para> - -@package: -@localedir: -@encoding: - - -<!-- ##### FUNCTION xfce_get_file_localized ##### --> -<para> - -</para> - -@filename: -@Returns: - - -<!-- ##### FUNCTION xfce_get_file_localized_r ##### --> -<para> - -</para> - -@buffer: -@length: -@filename: -@Returns: - - -<!-- ##### FUNCTION xfce_get_dir_localized ##### --> -<para> - -</para> - -@directory: -@Returns: - - -<!-- ##### FUNCTION xfce_get_dir_localized_r ##### --> -<para> - -</para> - -@buffer: -@length: -@directory: -@Returns: - - -<!-- ##### FUNCTION xfce_get_path_localized ##### --> -<para> - -</para> - -@dst: -@size: -@paths: -@filename: -@test: -@Returns: - - -<!-- ##### MACRO XFCE_LOCALE_FULL_MATCH ##### --> -<para> -Returned by #xfce_locale_match in case of a full match. -</para> - - - -<!-- ##### MACRO XFCE_LOCALE_NO_MATCH ##### --> -<para> -Returned by #xfce_locale_match if no match could be detected. -</para> - - - -<!-- ##### FUNCTION xfce_locale_match ##### --> -<para> - -</para> - -@locale1: -@locale2: -@Returns: - - diff --git a/docs/tmpl/xfce-kiosk.sgml b/docs/tmpl/xfce-kiosk.sgml deleted file mode 100644 index 49047bb..0000000 --- a/docs/tmpl/xfce-kiosk.sgml +++ /dev/null @@ -1,55 +0,0 @@ -<!-- ##### SECTION Title ##### --> -Xfce Kiosk functions - -<!-- ##### SECTION Short_Description ##### --> -Xfce Kiosk mode support functions. - -<!-- ##### SECTION Long_Description ##### --> -<para> - This module provides a simple Kiosk mode for Xfce. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### STRUCT XfceKiosk ##### --> -<para> - -</para> - - -<!-- ##### FUNCTION xfce_kiosk_new ##### --> -<para> - -</para> - -@module: -@Returns: - - -<!-- ##### FUNCTION xfce_kiosk_query ##### --> -<para> - -</para> - -@kiosk: -@capability: -@Returns: - - -<!-- ##### FUNCTION xfce_kiosk_free ##### --> -<para> - -</para> - -@kiosk: - - diff --git a/docs/tmpl/xfce-license.sgml b/docs/tmpl/xfce-license.sgml deleted file mode 100644 index b70a709..0000000 --- a/docs/tmpl/xfce-license.sgml +++ /dev/null @@ -1,61 +0,0 @@ -<!-- ##### SECTION Title ##### --> -Software Licenses - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### MACRO XFCE_LICENSE_BSD ##### --> -<para> -Contains the text of the BSD license. -</para> - - - -<!-- ##### MACRO XFCE_LICENSE_GPL ##### --> -<para> -Contains the text of the GNU General Public License. -</para> - - - -<!-- ##### MACRO XFCE_LICENSE_LGPL ##### --> -<para> -Contains the text of the GNU Lesser General Public License. -</para> - - - -<!-- ##### ENUM XfceLicenseTextType ##### --> -<para> - -</para> - -@XFCE_LICENSE_TEXT_BSD: -@XFCE_LICENSE_TEXT_GPL: -@XFCE_LICENSE_TEXT_LGPL: - -<!-- ##### FUNCTION xfce_get_license_text ##### --> -<para> - -</para> - -@license_type: -@Returns: - - diff --git a/docs/tmpl/xfce-miscutils.sgml b/docs/tmpl/xfce-miscutils.sgml deleted file mode 100644 index d68b134..0000000 --- a/docs/tmpl/xfce-miscutils.sgml +++ /dev/null @@ -1,112 +0,0 @@ -<!-- ##### SECTION Title ##### --> -Miscellaneous Utilities - -<!-- ##### SECTION Short_Description ##### --> -Miscellaneous utility functions - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### FUNCTION xfce_get_homedir ##### --> -<para> - -</para> - -@void: -@Returns: - - -<!-- ##### MACRO xfce_get_homefile ##### --> -<para> -Returns the path to a file in the user's home directory by taking a -NULL terminated list of strings and appending them to the absolute -path of the current user's home directory. -</para> - -@...: -@Returns: the absolute path to the specified file in the current user's - home directory. The caller is responsible for freeing the - returned string using g_free(). -<!-- # Unused Parameters # --> -@first_element...: NULL terminated list of path components. - - -<!-- ##### FUNCTION xfce_get_homefile_r ##### --> -<para> - -</para> - -@buffer: -@length: -@format: -@Varargs: -@Returns: - - -<!-- ##### FUNCTION xfce_get_userdir ##### --> -<para> - -</para> - -@void: -@Returns: - - -<!-- ##### MACRO xfce_get_userfile ##### --> -<para> -Returns the absolute path to a file within the user's ".xfce4" directory, -formed by a NULL terminated list of path components. -</para> - -@...: -@Returns: the absolute path to the specified file in the user's ".xfce4" - directory. The caller is responsible for freeing the returned - string using g_free(). -<!-- # Unused Parameters # --> -@first_element...: NULL terminated list of path components. - - -<!-- ##### FUNCTION xfce_get_userfile_r ##### --> -<para> - -</para> - -@buffer: -@length: -@format: -@Varargs: -@Returns: - - -<!-- ##### FUNCTION xfce_gethostname ##### --> -<para> - -</para> - -@void: -@Returns: - - -<!-- ##### FUNCTION xfce_expand_variables ##### --> -<para> - -</para> - -@command: -@envp: -@Returns: - - diff --git a/docs/tmpl/xfce-posix-signal-handler.sgml b/docs/tmpl/xfce-posix-signal-handler.sgml deleted file mode 100644 index 281140c..0000000 --- a/docs/tmpl/xfce-posix-signal-handler.sgml +++ /dev/null @@ -1,73 +0,0 @@ -<!-- ##### 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 ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### 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> - -@void: - - diff --git a/docs/tmpl/xfce-rc.sgml b/docs/tmpl/xfce-rc.sgml deleted file mode 100644 index c4ea2a7..0000000 --- a/docs/tmpl/xfce-rc.sgml +++ /dev/null @@ -1,275 +0,0 @@ -<!-- ##### SECTION Title ##### --> -Resource Config File Support - -<!-- ##### SECTION Short_Description ##### --> -functions for reading and writing resource config files. - -<!-- ##### SECTION Long_Description ##### --> -<para> -Provides support for parsing INI-style resource config files like used by for -example KDE and some Xfce components (like xfwm4, who uses rc files for the -themes). -</para> - -<para> -The parser itself is optimized for high-performance using memory and string chunks -to reduce the time spent looking for heap memory (a nice side effect of this is the -reduced heap corruption). But due to this fact, an #XfceRc object might consume quite -a lot of memory after some time of usage. Therefore you should close an #XfceRc object -as soon as possible after loading configuration data from the object. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### STRUCT XfceRc ##### --> -<para> -Opaque struct that encapsulates the resource config data. -</para> - - -<!-- ##### FUNCTION xfce_rc_simple_open ##### --> -<para> - -</para> - -@filename: -@readonly: -@Returns: - - -<!-- ##### FUNCTION xfce_rc_config_open ##### --> -<para> - -</para> - -@type: -@resource: -@readonly: -@Returns: - - -<!-- ##### FUNCTION xfce_rc_close ##### --> -<para> - -</para> - -@rc: - - -<!-- ##### FUNCTION xfce_rc_flush ##### --> -<para> - -</para> - -@rc: - - -<!-- ##### FUNCTION xfce_rc_is_dirty ##### --> -<para> - -</para> - -@rc: -@Returns: - - -<!-- ##### FUNCTION xfce_rc_is_readonly ##### --> -<para> - -</para> - -@rc: -@Returns: - - -<!-- ##### FUNCTION xfce_rc_get_locale ##### --> -<para> - -</para> - -@rc: -@Returns: - - -<!-- ##### FUNCTION xfce_rc_get_groups ##### --> -<para> - -</para> - -@rc: -@Returns: - - -<!-- ##### FUNCTION xfce_rc_get_entries ##### --> -<para> - -</para> - -@rc: -@group: -@Returns: - - -<!-- ##### FUNCTION xfce_rc_delete_group ##### --> -<para> - -</para> - -@rc: -@group: -@global: - - -<!-- ##### FUNCTION xfce_rc_get_group ##### --> -<para> - -</para> - -@rc: -@Returns: - - -<!-- ##### FUNCTION xfce_rc_has_group ##### --> -<para> - -</para> - -@rc: -@group: -@Returns: - - -<!-- ##### FUNCTION xfce_rc_set_group ##### --> -<para> - -</para> - -@rc: -@group: - - -<!-- ##### FUNCTION xfce_rc_delete_entry ##### --> -<para> - -</para> - -@rc: -@key: -@global: - - -<!-- ##### FUNCTION xfce_rc_has_entry ##### --> -<para> - -</para> - -@rc: -@key: -@Returns: - - -<!-- ##### FUNCTION xfce_rc_read_entry ##### --> -<para> - -</para> - -@rc: -@key: -@fallback: -@Returns: - - -<!-- ##### FUNCTION xfce_rc_read_entry_untranslated ##### --> -<para> - -</para> - -@rc: -@key: -@fallback: -@Returns: - - -<!-- ##### FUNCTION xfce_rc_read_bool_entry ##### --> -<para> - -</para> - -@rc: -@key: -@fallback: -@Returns: - - -<!-- ##### FUNCTION xfce_rc_read_int_entry ##### --> -<para> - -</para> - -@rc: -@key: -@fallback: -@Returns: - - -<!-- ##### FUNCTION xfce_rc_read_list_entry ##### --> -<para> - -</para> - -@rc: -@key: -@delimiter: -@Returns: - - -<!-- ##### FUNCTION xfce_rc_write_entry ##### --> -<para> - -</para> - -@rc: -@key: -@value: - - -<!-- ##### FUNCTION xfce_rc_write_bool_entry ##### --> -<para> - -</para> - -@rc: -@key: -@value: - - -<!-- ##### FUNCTION xfce_rc_write_int_entry ##### --> -<para> - -</para> - -@rc: -@key: -@value: - - -<!-- ##### FUNCTION xfce_rc_write_list_entry ##### --> -<para> - -</para> - -@rc: -@key: -@value: -@separator: - - diff --git a/docs/tmpl/xfce-resource.sgml b/docs/tmpl/xfce-resource.sgml deleted file mode 100644 index 450eb82..0000000 --- a/docs/tmpl/xfce-resource.sgml +++ /dev/null @@ -1,124 +0,0 @@ -<!-- ##### SECTION Title ##### --> -Resource lookup functions - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### ENUM XfceResourceType ##### --> -<para> - -</para> - -@XFCE_RESOURCE_DATA: where applications store data. -@XFCE_RESOURCE_CONFIG: configuration files. -@XFCE_RESOURCE_CACHE: cached information. -@XFCE_RESOURCE_ICONS: icon search path. -@XFCE_RESOURCE_THEMES: themes search path. - -<!-- ##### USER_FUNCTION XfceMatchFunc ##### --> -<para> - -</para> - -@basedir: -@relpath: -@user_data: -@Returns: - - -<!-- ##### FUNCTION xfce_resource_dirs ##### --> -<para> - -</para> - -@type: -@Returns: - - -<!-- ##### FUNCTION xfce_resource_lookup ##### --> -<para> - -</para> - -@type: -@filename: -@Returns: - - -<!-- ##### FUNCTION xfce_resource_lookup_all ##### --> -<para> - -</para> - -@type: -@filename: -@Returns: - - -<!-- ##### FUNCTION xfce_resource_match ##### --> -<para> - -</para> - -@type: -@pattern: -@unique: -@Returns: - - -<!-- ##### FUNCTION xfce_resource_match_custom ##### --> -<para> - -</para> - -@type: -@unique: -@func: -@user_data: -@Returns: - - -<!-- ##### FUNCTION xfce_resource_push_path ##### --> -<para> - -</para> - -@type: -@path: - - -<!-- ##### FUNCTION xfce_resource_pop_path ##### --> -<para> - -</para> - -@type: - - -<!-- ##### FUNCTION xfce_resource_save_location ##### --> -<para> - -</para> - -@type: -@relpath: -@create: -@Returns: - - diff --git a/docs/tmpl/xfce-utf8.sgml b/docs/tmpl/xfce-utf8.sgml deleted file mode 100644 index 1cf9e45..0000000 --- a/docs/tmpl/xfce-utf8.sgml +++ /dev/null @@ -1,42 +0,0 @@ -<!-- ##### SECTION Title ##### --> -Unicode Manipulation - -<!-- ##### SECTION Short_Description ##### --> -functions operating on Unicode characters and UTF-8 strings. - -<!-- ##### SECTION Long_Description ##### --> -<para> -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> -<ulink url="http://developer.gnome.org/doc/API/2.0/glib/glib-Unicode-Manipulation.html">Glib Unicode Manipulation</ulink> -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### FUNCTION xfce_utf8_remove_controls ##### --> -<para> - -</para> - -@str: -@max_len: -@end: -@Returns: - - -<!-- ##### FUNCTION xfce_utf8_strndup ##### --> -<para> - -</para> - -@src: -@max_len: -@Returns: - - |