summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorBenedikt Meurer <benny@xfce.org>2006-04-18 21:35:22 +0000
committerBenedikt Meurer <benny@xfce.org>2006-04-18 21:35:22 +0000
commit6dfd00b8d64c9023c3452445dee9da4e0d0b51a9 (patch)
tree6a3c9fbb06aaca07a15a6bca6af65d3c77b3ddae /docs
parent447292095e5cef73ee8eb5e2856ddf85b173d769 (diff)
downloadlibxfce4util-6dfd00b8d64c9023c3452445dee9da4e0d0b51a9.tar.gz
2006-04-18 Benedikt Meurer <benny@xfce.org>
* libxfce4util/Makefile.am, libxfce4util/libxfce4util.symbols: Fix typos introduced with the previous commit. * libxfce4util/, po/, Makefile.am, configure.in.in, autogen.sh: Add i18n support. This way the software licenses can be translated. * docs/: Update the API documentation. (Old svn revision: 21068)
Diffstat (limited to 'docs')
-rw-r--r--docs/libxfce4util-docs.sgml2
-rw-r--r--docs/libxfce4util-sections.txt20
-rw-r--r--docs/tmpl/libxfce4util-config.sgml18
-rw-r--r--docs/tmpl/xfce-i18n.sgml2
-rw-r--r--docs/tmpl/xfce-license.sgml58
-rw-r--r--docs/tmpl/xfce-miscutils.sgml21
6 files changed, 97 insertions, 24 deletions
diff --git a/docs/libxfce4util-docs.sgml b/docs/libxfce4util-docs.sgml
index df1ac7d..1848a40 100644
--- a/docs/libxfce4util-docs.sgml
+++ b/docs/libxfce4util-docs.sgml
@@ -3,6 +3,7 @@
"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-License SYSTEM "xml/xfce-license.xml">
<!ENTITY libxfce4util-Kiosk SYSTEM "xml/xfce-kiosk.xml">
<!ENTITY libxfce4util-Resource SYSTEM "xml/xfce-resource.xml">
<!ENTITY libxfce4util-RcParser SYSTEM "xml/xfce-rc.xml">
@@ -33,6 +34,7 @@
<title>Xfce Fundamentals</title>
&libxfce4util-StandardMacros;
&libxfce4util-Internationalization;
+ &libxfce4util-License;
</chapter>
<chapter id="libxfce4util-core">
diff --git a/docs/libxfce4util-sections.txt b/docs/libxfce4util-sections.txt
index 3636024..984af6b 100644
--- a/docs/libxfce4util-sections.txt
+++ b/docs/libxfce4util-sections.txt
@@ -4,6 +4,9 @@
<TITLE>Version Information</TITLE>
<FILE>libxfce4util-config</FILE>
xfce_version_string
+libxfce4util_major_version
+libxfce4util_minor_version
+libxfce4util_micro_version
<SUBSECTION>
LIBXFCE4UTIL_MAJOR_VERSION
LIBXFCE4UTIL_MINOR_VERSION
@@ -94,6 +97,7 @@ xfce_rc_write_int_entry
xfce_rc_write_list_entry
</SECTION>
+
<SECTION>
<TITLE>Unicode Support Functions</TITLE>
<FILE>xfce-utf8</FILE>
@@ -101,18 +105,30 @@ xfce_utf8_remove_controls
xfce_utf8_strndup
</SECTION>
+
<SECTION>
<TITLE>File Utilities</TITLE>
<FILE>xfce-fileutils</FILE>
xfce_mkdirhier
</SECTION>
+
<SECTION>
-<TITLE>Miscellaneous Utilities</TITLE>
-<FILE>xfce-miscutils</FILE>
+<TITLE>Software Licenses</TITLE>
+<FILE>xfce-license</FILE>
XFCE_LICENSE_BSD
XFCE_LICENSE_GPL
XFCE_LICENSE_LGPL
+XfceLicenseTextType
+xfce_get_license_text
+<SUBSECTION Private>
+xfce_license_text_type_get_type
+</SECTION>
+
+
+<SECTION>
+<TITLE>Miscellaneous Utilities</TITLE>
+<FILE>xfce-miscutils</FILE>
xfce_get_homedir
xfce_get_homefile
xfce_get_homefile_r
diff --git a/docs/tmpl/libxfce4util-config.sgml b/docs/tmpl/libxfce4util-config.sgml
index af66ea3..4422c7b 100644
--- a/docs/tmpl/libxfce4util-config.sgml
+++ b/docs/tmpl/libxfce4util-config.sgml
@@ -25,6 +25,24 @@ These macros provide a few commonly-used features.
@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.
diff --git a/docs/tmpl/xfce-i18n.sgml b/docs/tmpl/xfce-i18n.sgml
index e91f676..58e45f3 100644
--- a/docs/tmpl/xfce-i18n.sgml
+++ b/docs/tmpl/xfce-i18n.sgml
@@ -25,7 +25,7 @@ Internationalization</ulink>
<!-- ##### FUNCTION xfce_textdomain ##### -->
<para>
-Binds the current text domain for @package to @localedir and sets @encoding.
+
</para>
@package:
diff --git a/docs/tmpl/xfce-license.sgml b/docs/tmpl/xfce-license.sgml
new file mode 100644
index 0000000..3cadd97
--- /dev/null
+++ b/docs/tmpl/xfce-license.sgml
@@ -0,0 +1,58 @@
+<!-- ##### SECTION Title ##### -->
+Software Licenses
+
+<!-- ##### SECTION Short_Description ##### -->
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### 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
index b96c48f..9a38e78 100644
--- a/docs/tmpl/xfce-miscutils.sgml
+++ b/docs/tmpl/xfce-miscutils.sgml
@@ -17,27 +17,6 @@ Miscellaneous utility functions
<!-- ##### SECTION Stability_Level ##### -->
-<!-- ##### 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>
-
-
-
<!-- ##### FUNCTION xfce_get_homedir ##### -->
<para>