diff options
author | Romain B <skunnyk@alteroot.org> | 2017-05-09 18:41:51 +0200 |
---|---|---|
committer | Ali Abdallah <ali@xfce.org> | 2017-06-23 11:04:23 +0200 |
commit | 0ff115e6c431177555e9a404ae2f78cb343dc449 (patch) | |
tree | acb245b87b81b1344888346c6c49397066b7947b /docs | |
parent | 32c896cadaa5f1227d23cc0681a05154ba23a690 (diff) | |
download | xfconf-0ff115e6c431177555e9a404ae2f78cb343dc449.tar.gz |
Better documentation processing
- No more sgml things.
- You only need to add new functions to docs/xfconf-sections.txt to add them to the doc.
Diffstat (limited to 'docs')
-rw-r--r-- | docs/reference/Makefile.am | 2 | ||||
-rw-r--r-- | docs/reference/setup-build.stamp | 0 | ||||
-rw-r--r-- | docs/reference/tmpl/xfconf-backend.sgml | 147 | ||||
-rw-r--r-- | docs/reference/tmpl/xfconf-binding.sgml | 82 | ||||
-rw-r--r-- | docs/reference/tmpl/xfconf-channel.sgml | 469 | ||||
-rw-r--r-- | docs/reference/tmpl/xfconf-errors.sgml | 46 | ||||
-rw-r--r-- | docs/reference/tmpl/xfconf-types.sgml | 60 | ||||
-rw-r--r-- | docs/reference/tmpl/xfconf-unused.sgml | 167 | ||||
-rw-r--r-- | docs/reference/tmpl/xfconf.sgml | 62 | ||||
-rw-r--r-- | docs/reference/xfconf-docs.xml (renamed from docs/reference/xfconf-docs.sgml) | 0 | ||||
-rw-r--r-- | docs/reference/xfconf-undeclared.txt | 0 |
11 files changed, 1 insertions, 1034 deletions
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am index 17c6e68..1ea7c47 100644 --- a/docs/reference/Makefile.am +++ b/docs/reference/Makefile.am @@ -6,7 +6,7 @@ AUTOMAKE_OPTIONS = 1.8 DOC_MODULE=xfconf # The top-level SGML file. -DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml +DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml # Extra options to supply to gtkdoc-scan SCAN_OPTIONS=--deprecated-guards="XFCONF_DISABLE_DEPRECATED" diff --git a/docs/reference/setup-build.stamp b/docs/reference/setup-build.stamp new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/docs/reference/setup-build.stamp diff --git a/docs/reference/tmpl/xfconf-backend.sgml b/docs/reference/tmpl/xfconf-backend.sgml deleted file mode 100644 index 56c514b..0000000 --- a/docs/reference/tmpl/xfconf-backend.sgml +++ /dev/null @@ -1,147 +0,0 @@ -<!-- ##### SECTION Title ##### --> -XfconfBackend - -<!-- ##### SECTION Short_Description ##### --> -Interface for configuration store backends - -<!-- ##### SECTION Long_Description ##### --> -<para> -XfconfBackend is an abstract interface that allows the Xfconf Daemon -to use different backends for storing configuration data. These backends -can be flat text or binary files, a database, or just about anything -one could think of to store data. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### STRUCT XfconfBackendInterface ##### --> -<para> - -</para> - -@parent: GObject interface parent. -@initialize: See xfconf_backend_initialize(). -@set: See xfconf_backend_set(). -@get: See xfconf_backend_get(). -@get_all: See xfconf_backend_get_all(). -@exists: See xfconf_backend_exists(). -@reset: See xfconf_backend_reset(). -@list_channels: See xfconf_backend_list_channels(). -@is_property_locked: See xfconf_backend_is_property_locked(). -@flush: See xfconf_backend_flush(). -@register_property_changed_func: See xfconf_backend_register_property_changed_func(). -@_xb_reserved0: Reserved for future expansion. -@_xb_reserved1: Reserved for future expansion. -@_xb_reserved2: Reserved for future expansion. -@_xb_reserved3: Reserved for future expansion. - -<!-- ##### STRUCT XfconfBackend ##### --> -<para> - -</para> - - -<!-- ##### FUNCTION xfconf_backend_initialize ##### --> -<para> - -</para> - -@backend: -@error: -@Returns: - - -<!-- ##### FUNCTION xfconf_backend_set ##### --> -<para> - -</para> - -@backend: -@channel: -@property: -@value: -@error: -@Returns: - - -<!-- ##### FUNCTION xfconf_backend_get ##### --> -<para> - -</para> - -@backend: -@channel: -@property: -@value: -@error: -@Returns: - - -<!-- ##### FUNCTION xfconf_backend_get_all ##### --> -<para> - -</para> - -@backend: -@channel: -@property_base: -@properties: -@error: -@Returns: - - -<!-- ##### FUNCTION xfconf_backend_exists ##### --> -<para> - -</para> - -@backend: -@channel: -@property: -@exists: -@error: -@Returns: - - -<!-- ##### FUNCTION xfconf_backend_reset ##### --> -<para> - -</para> - -@backend: -@channel: -@property: -@recursive: -@error: -@Returns: - - -<!-- ##### FUNCTION xfconf_backend_flush ##### --> -<para> - -</para> - -@backend: -@error: -@Returns: - - -<!-- ##### FUNCTION xfconf_backend_register_property_changed_func ##### --> -<para> - -</para> - -@backend: -@func: -@user_data: - - diff --git a/docs/reference/tmpl/xfconf-binding.sgml b/docs/reference/tmpl/xfconf-binding.sgml deleted file mode 100644 index 77ce4ee..0000000 --- a/docs/reference/tmpl/xfconf-binding.sgml +++ /dev/null @@ -1,82 +0,0 @@ -<!-- ##### SECTION Title ##### --> -Xfconf-GObject Binding - -<!-- ##### SECTION Short_Description ##### --> -Functions to bind Xfconf properties to GObject properties - -<!-- ##### SECTION Long_Description ##### --> -<para> -Often it may be useful to bind an Xfconf property to a GObject property. -Settings dialogs often display the current value of an Xfconf property, -and a user may edit the value to change the value in the Xfconf store. -If the Xfconf property changes outside the settings dialog, the user will -usually want to see the settings dialog automatically update to reflect -the new value. - -With a single line of code, Xfconf's binding functionality can automate -all this. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### FUNCTION xfconf_g_property_bind ##### --> -<para> - -</para> - -@channel: -@xfconf_property: -@xfconf_property_type: -@object: -@object_property: -@Returns: - - -<!-- ##### FUNCTION xfconf_g_property_bind_gdkcolor ##### --> -<para> - -</para> - -@channel: -@xfconf_property: -@object: -@object_property: -@Returns: - - -<!-- ##### FUNCTION xfconf_g_property_unbind ##### --> -<para> - -</para> - -@id: - - -<!-- ##### FUNCTION xfconf_g_property_unbind_by_property ##### --> -<para> - -</para> - -@channel: -@xfconf_property: -@object: -@object_property: - - -<!-- ##### FUNCTION xfconf_g_property_unbind_all ##### --> -<para> - -</para> - -@channel_or_object: - - diff --git a/docs/reference/tmpl/xfconf-channel.sgml b/docs/reference/tmpl/xfconf-channel.sgml deleted file mode 100644 index ef669c5..0000000 --- a/docs/reference/tmpl/xfconf-channel.sgml +++ /dev/null @@ -1,469 +0,0 @@ -<!-- ##### SECTION Title ##### --> -XfconfChannel - -<!-- ##### SECTION Short_Description ##### --> -An application-defined domain for storing configuration settings - -<!-- ##### SECTION Long_Description ##### --> -<para> -An XfconfChannel is a representation of a restricted domain or -namespace that an application can define to store configuration -settings. This is to ensure that different applications do not store -configuration keys with the same names. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### STRUCT XfconfChannel ##### --> -<para> - -</para> - - -<!-- ##### SIGNAL XfconfChannel::property-changed ##### --> -<para> - -</para> - -@channel: the object which received the signal. -@property: -@value: - -<!-- ##### ARG XfconfChannel:channel-name ##### --> -<para> - -</para> - -<!-- ##### ARG XfconfChannel:is-singleton ##### --> -<para> - -</para> - -<!-- ##### ARG XfconfChannel:property-base ##### --> -<para> - -</para> - -<!-- ##### FUNCTION xfconf_channel_get ##### --> -<para> - -</para> - -@channel_name: -@Returns: - - -<!-- ##### FUNCTION xfconf_channel_new ##### --> -<para> - -</para> - -@channel_name: -@Returns: - - -<!-- ##### FUNCTION xfconf_channel_new_with_property_base ##### --> -<para> - -</para> - -@channel_name: -@property_base: -@Returns: - - -<!-- ##### FUNCTION xfconf_channel_has_property ##### --> -<para> - -</para> - -@channel: -@property: -@Returns: - - -<!-- ##### FUNCTION xfconf_channel_is_property_locked ##### --> -<para> - -</para> - -@channel: -@property: -@Returns: - - -<!-- ##### FUNCTION xfconf_channel_reset_property ##### --> -<para> - -</para> - -@channel: -@property_base: -@recursive: - - -<!-- ##### FUNCTION xfconf_channel_get_properties ##### --> -<para> - -</para> - -@channel: -@property_base: -@Returns: - - -<!-- ##### FUNCTION xfconf_channel_get_string ##### --> -<para> - -</para> - -@channel: -@property: -@default_value: -@Returns: - - -<!-- ##### FUNCTION xfconf_channel_get_string_list ##### --> -<para> - -</para> - -@channel: -@property: -@Returns: - - -<!-- ##### FUNCTION xfconf_channel_get_int ##### --> -<para> - -</para> - -@channel: -@property: -@default_value: -@Returns: - - -<!-- ##### FUNCTION xfconf_channel_get_uint ##### --> -<para> - -</para> - -@channel: -@property: -@default_value: -@Returns: - - -<!-- ##### FUNCTION xfconf_channel_get_uint64 ##### --> -<para> - -</para> - -@channel: -@property: -@default_value: -@Returns: - - -<!-- ##### FUNCTION xfconf_channel_get_double ##### --> -<para> - -</para> - -@channel: -@property: -@default_value: -@Returns: - - -<!-- ##### FUNCTION xfconf_channel_get_bool ##### --> -<para> - -</para> - -@channel: -@property: -@default_value: -@Returns: - - -<!-- ##### FUNCTION xfconf_channel_set_string ##### --> -<para> - -</para> - -@channel: -@property: -@value: -@Returns: - - -<!-- ##### FUNCTION xfconf_channel_set_string_list ##### --> -<para> - -</para> - -@channel: -@property: -@values: -@Returns: - - -<!-- ##### FUNCTION xfconf_channel_set_int ##### --> -<para> - -</para> - -@channel: -@property: -@value: -@Returns: - - -<!-- ##### FUNCTION xfconf_channel_set_uint ##### --> -<para> - -</para> - -@channel: -@property: -@value: -@Returns: - - -<!-- ##### FUNCTION xfconf_channel_set_uint64 ##### --> -<para> - -</para> - -@channel: -@property: -@value: -@Returns: - - -<!-- ##### FUNCTION xfconf_channel_set_double ##### --> -<para> - -</para> - -@channel: -@property: -@value: -@Returns: - - -<!-- ##### FUNCTION xfconf_channel_set_bool ##### --> -<para> - -</para> - -@channel: -@property: -@value: -@Returns: - - -<!-- ##### FUNCTION xfconf_channel_get_property ##### --> -<para> - -</para> - -@channel: -@property: -@value: -@Returns: - - -<!-- ##### FUNCTION xfconf_channel_set_property ##### --> -<para> - -</para> - -@channel: -@property: -@value: -@Returns: - - -<!-- ##### FUNCTION xfconf_channel_get_array ##### --> -<para> - -</para> - -@channel: -@property: -@first_value_type: -@Varargs: -@Returns: - - -<!-- ##### FUNCTION xfconf_channel_get_array_valist ##### --> -<para> - -</para> - -@channel: -@property: -@first_value_type: -@var_args: -@Returns: - - -<!-- ##### FUNCTION xfconf_channel_get_arrayv ##### --> -<para> - -</para> - -@channel: -@property: -@Returns: - - -<!-- ##### FUNCTION xfconf_channel_set_array ##### --> -<para> - -</para> - -@channel: -@property: -@first_value_type: -@Varargs: -@Returns: - - -<!-- ##### FUNCTION xfconf_channel_set_array_valist ##### --> -<para> - -</para> - -@channel: -@property: -@first_value_type: -@var_args: -@Returns: - - -<!-- ##### FUNCTION xfconf_channel_set_arrayv ##### --> -<para> - -</para> - -@channel: -@property: -@values: -@Returns: - - -<!-- ##### FUNCTION xfconf_channel_get_named_struct ##### --> -<para> - -</para> - -@channel: -@property: -@struct_name: -@value_struct: -@Returns: - - -<!-- ##### FUNCTION xfconf_channel_set_named_struct ##### --> -<para> - -</para> - -@channel: -@property: -@struct_name: -@value_struct: -@Returns: - - -<!-- ##### FUNCTION xfconf_channel_get_struct ##### --> -<para> - -</para> - -@channel: -@property: -@value_struct: -@first_member_type: -@Varargs: -@Returns: - - -<!-- ##### FUNCTION xfconf_channel_get_struct_valist ##### --> -<para> - -</para> - -@channel: -@property: -@value_struct: -@first_member_type: -@var_args: -@Returns: - - -<!-- ##### FUNCTION xfconf_channel_get_structv ##### --> -<para> - -</para> - -@channel: -@property: -@value_struct: -@n_members: -@member_types: -@Returns: - - -<!-- ##### FUNCTION xfconf_channel_set_struct ##### --> -<para> - -</para> - -@channel: -@property: -@value_struct: -@first_member_type: -@Varargs: -@Returns: - - -<!-- ##### FUNCTION xfconf_channel_set_struct_valist ##### --> -<para> - -</para> - -@channel: -@property: -@value_struct: -@first_member_type: -@var_args: -@Returns: - - -<!-- ##### FUNCTION xfconf_channel_set_structv ##### --> -<para> - -</para> - -@channel: -@property: -@value_struct: -@n_members: -@member_types: -@Returns: - - diff --git a/docs/reference/tmpl/xfconf-errors.sgml b/docs/reference/tmpl/xfconf-errors.sgml deleted file mode 100644 index 110b5f8..0000000 --- a/docs/reference/tmpl/xfconf-errors.sgml +++ /dev/null @@ -1,46 +0,0 @@ -<!-- ##### SECTION Title ##### --> -Error Reporting - -<!-- ##### SECTION Short_Description ##### --> -Xfconf library and daemon error descriptions - -<!-- ##### SECTION Long_Description ##### --> -<para> -Both the Xfconf daemon and library provide error information via the -use of #GError<!-- -->s. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### MACRO XFCONF_ERROR ##### --> -<para> - -</para> - - - -<!-- ##### ENUM XfconfError ##### --> -<para> - -</para> - -@XFCONF_ERROR_UNKNOWN: An unknown error occurred -@XFCONF_ERROR_CHANNEL_NOT_FOUND: The specified channel does not exist -@XFCONF_ERROR_PROPERTY_NOT_FOUND: The specified property does not exist on the channel -@XFCONF_ERROR_READ_FAILURE: There was a failure reading from the configuration store -@XFCONF_ERROR_WRITE_FAILURE: There was a failure writing to the configuration store -@XFCONF_ERROR_PERMISSION_DENIED: The user is not allowed to read or write to the channel or property -@XFCONF_ERROR_INTERNAL_ERROR: An internal error (likely a bug in xfconf) occurred -@XFCONF_ERROR_NO_BACKEND: No backends were found, or those found could not be loaded -@XFCONF_ERROR_INVALID_PROPERTY: The property name specified was invalid -@XFCONF_ERROR_INVALID_CHANNEL: The channel name specified was invalid - diff --git a/docs/reference/tmpl/xfconf-types.sgml b/docs/reference/tmpl/xfconf-types.sgml deleted file mode 100644 index 3ef63ca..0000000 --- a/docs/reference/tmpl/xfconf-types.sgml +++ /dev/null @@ -1,60 +0,0 @@ -<!-- ##### SECTION Title ##### --> -Xfconf Types - -<!-- ##### SECTION Short_Description ##### --> -GObject types used by the Xfconf daemon and library - -<!-- ##### SECTION Long_Description ##### --> -<para> -libgobject lacks GObject fundamental types for 16-bit signed and unsigned -integers, which may be useful to use in an Xfconf store. GObject types for -these primitive types are provided here. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### FUNCTION xfconf_g_value_get_int16 ##### --> -<para> - -</para> - -@value: -@Returns: - - -<!-- ##### FUNCTION xfconf_g_value_get_uint16 ##### --> -<para> - -</para> - -@value: -@Returns: - - -<!-- ##### FUNCTION xfconf_g_value_set_int16 ##### --> -<para> - -</para> - -@value: -@v_int16: - - -<!-- ##### FUNCTION xfconf_g_value_set_uint16 ##### --> -<para> - -</para> - -@value: -@v_uint16: - - diff --git a/docs/reference/tmpl/xfconf-unused.sgml b/docs/reference/tmpl/xfconf-unused.sgml deleted file mode 100644 index 675dc0c..0000000 --- a/docs/reference/tmpl/xfconf-unused.sgml +++ /dev/null @@ -1,167 +0,0 @@ -<!-- ##### SECTION ./tmpl/config.sgml:Long_Description ##### --> -<para> - -</para> - - -<!-- ##### SECTION ./tmpl/config.sgml:See_Also ##### --> -<para> - -</para> - - -<!-- ##### SECTION ./tmpl/config.sgml:Short_Description ##### --> - - - -<!-- ##### SECTION ./tmpl/config.sgml:Stability_Level ##### --> - - - -<!-- ##### SECTION ./tmpl/config.sgml:Title ##### --> -config - - -<!-- ##### SECTION ./tmpl/stamp-xfconf-marshal.sgml:Long_Description ##### --> -<para> - -</para> - - -<!-- ##### SECTION ./tmpl/stamp-xfconf-marshal.sgml:See_Also ##### --> -<para> - -</para> - - -<!-- ##### SECTION ./tmpl/stamp-xfconf-marshal.sgml:Short_Description ##### --> - - - -<!-- ##### SECTION ./tmpl/stamp-xfconf-marshal.sgml:Stability_Level ##### --> - - - -<!-- ##### SECTION ./tmpl/stamp-xfconf-marshal.sgml:Title ##### --> -stamp-xfconf-marshal - - -<!-- ##### MACRO XFCONF_BACKEND_GET_INTERFACE ##### --> -<para> - -</para> - -@obj: - -<!-- ##### MACRO XFCONF_TYPE_ERROR ##### --> -<para> - -</para> - - -<!-- ##### FUNCTION xfconf_backend_get_error_quark ##### --> -<para> - -</para> - -@Returns: - -<!-- ##### FUNCTION xfconf_backend_remove ##### --> -<para> - -</para> - -@backend: -@channel: -@property: -@recursive: -@error: -@Returns: - -<!-- ##### FUNCTION xfconf_backend_remove_channel ##### --> -<para> - -</para> - -@backend: -@channel: -@error: -@Returns: - -<!-- ##### FUNCTION xfconf_channel_begin_transaction ##### --> -<para> - -</para> - -@channel: -@Returns: - -<!-- ##### FUNCTION xfconf_channel_cancel_transaction ##### --> -<para> - -</para> - -@channel: - -<!-- ##### FUNCTION xfconf_channel_commit_transaction ##### --> -<para> - -</para> - -@channel: -@Returns: - -<!-- ##### FUNCTION xfconf_channel_get_all ##### --> -<para> - -</para> - -@channel: -@Returns: - -<!-- ##### FUNCTION xfconf_channel_get_int64 ##### --> -<para> - -</para> - -@channel: -@property: -@default_value: -@Returns: - -<!-- ##### FUNCTION xfconf_channel_remove_properties ##### --> -<para> - -</para> - -@channel: -@property_base: - -<!-- ##### FUNCTION xfconf_channel_remove_property ##### --> -<para> - -</para> - -@channel: -@property: - -<!-- ##### FUNCTION xfconf_channel_set_int64 ##### --> -<para> - -</para> - -@channel: -@property: -@value: -@Returns: - -<!-- ##### FUNCTION xfconf_gtk_widget_bind_property ##### --> -<para> - -</para> - -@widget: -@channel: -@property: -@property_type: - diff --git a/docs/reference/tmpl/xfconf.sgml b/docs/reference/tmpl/xfconf.sgml deleted file mode 100644 index ed8c5e1..0000000 --- a/docs/reference/tmpl/xfconf.sgml +++ /dev/null @@ -1,62 +0,0 @@ -<!-- ##### SECTION Title ##### --> -Xfconf Library Core - -<!-- ##### SECTION Short_Description ##### --> -Init routines and core functionality for libxfconf - -<!-- ##### SECTION Long_Description ##### --> -<para> -Before libxfconf can be used, it must be initialized by calling -xfconf_init(). To free resources used by the library, call -xfconf_shutdown(). These calls are "recursive": multiple calls to -xfconf_init() are allowed, but each call must be matched by a -separate call to xfconf_shutdown() to really free the library's -resources. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### FUNCTION xfconf_init ##### --> -<para> - -</para> - -@error: -@Returns: - - -<!-- ##### FUNCTION xfconf_shutdown ##### --> -<para> - -</para> - -@void: - - -<!-- ##### FUNCTION xfconf_named_struct_register ##### --> -<para> - -</para> - -@struct_name: -@n_members: -@member_types: - - -<!-- ##### FUNCTION xfconf_array_free ##### --> -<para> - -</para> - -@arr: - - diff --git a/docs/reference/xfconf-docs.sgml b/docs/reference/xfconf-docs.xml index 24be72f..24be72f 100644 --- a/docs/reference/xfconf-docs.sgml +++ b/docs/reference/xfconf-docs.xml diff --git a/docs/reference/xfconf-undeclared.txt b/docs/reference/xfconf-undeclared.txt new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/docs/reference/xfconf-undeclared.txt |