From 5b771a75004ddbd6bfa29b50cdb7a0e188eafbb9 Mon Sep 17 00:00:00 2001 From: Matthew Barnes Date: Tue, 22 Sep 2009 21:06:45 -0400 Subject: Developer documentation improvements. --- doc/reference/shell/tmpl/e-account-utils.sgml | 61 +++ doc/reference/shell/tmpl/e-binding.sgml | 136 ++++++ doc/reference/shell/tmpl/e-bit-array.sgml | 167 ++++++++ doc/reference/shell/tmpl/e-categories-config.sgml | 37 ++ doc/reference/shell/tmpl/e-datetime-format.sgml | 66 +++ doc/reference/shell/tmpl/e-dialog-utils.sgml | 109 +++++ doc/reference/shell/tmpl/e-error.sgml | 139 ++++++ doc/reference/shell/tmpl/e-html-utils.sgml | 96 +++++ doc/reference/shell/tmpl/e-icon-factory.sgml | 73 ++++ doc/reference/shell/tmpl/e-logger.sgml | 87 ++++ doc/reference/shell/tmpl/e-module.sgml | 57 +++ doc/reference/shell/tmpl/e-print.sgml | 35 ++ doc/reference/shell/tmpl/e-shell-backend.sgml | 9 - doc/reference/shell/tmpl/e-signature-list.sgml | 113 +++++ doc/reference/shell/tmpl/e-signature-utils.sgml | 74 ++++ doc/reference/shell/tmpl/e-signature.sgml | 218 ++++++++++ doc/reference/shell/tmpl/e-util.sgml | 493 ++++++++++++++++++++++ doc/reference/shell/tmpl/e-xml-utils.sgml | 216 ++++++++++ doc/reference/shell/tmpl/eshell-unused.sgml | 8 + doc/reference/shell/tmpl/gconf-bridge.sgml | 137 ++++++ 20 files changed, 2322 insertions(+), 9 deletions(-) create mode 100644 doc/reference/shell/tmpl/e-account-utils.sgml create mode 100644 doc/reference/shell/tmpl/e-binding.sgml create mode 100644 doc/reference/shell/tmpl/e-bit-array.sgml create mode 100644 doc/reference/shell/tmpl/e-categories-config.sgml create mode 100644 doc/reference/shell/tmpl/e-datetime-format.sgml create mode 100644 doc/reference/shell/tmpl/e-dialog-utils.sgml create mode 100644 doc/reference/shell/tmpl/e-error.sgml create mode 100644 doc/reference/shell/tmpl/e-html-utils.sgml create mode 100644 doc/reference/shell/tmpl/e-icon-factory.sgml create mode 100644 doc/reference/shell/tmpl/e-logger.sgml create mode 100644 doc/reference/shell/tmpl/e-module.sgml create mode 100644 doc/reference/shell/tmpl/e-print.sgml create mode 100644 doc/reference/shell/tmpl/e-signature-list.sgml create mode 100644 doc/reference/shell/tmpl/e-signature-utils.sgml create mode 100644 doc/reference/shell/tmpl/e-signature.sgml create mode 100644 doc/reference/shell/tmpl/e-util.sgml create mode 100644 doc/reference/shell/tmpl/e-xml-utils.sgml create mode 100644 doc/reference/shell/tmpl/gconf-bridge.sgml (limited to 'doc/reference/shell/tmpl') diff --git a/doc/reference/shell/tmpl/e-account-utils.sgml b/doc/reference/shell/tmpl/e-account-utils.sgml new file mode 100644 index 0000000000..656afb3324 --- /dev/null +++ b/doc/reference/shell/tmpl/e-account-utils.sgml @@ -0,0 +1,61 @@ + +Mail Account Functions + + + + + + + + + + + + + + + + + + + + + + +@Returns: + + + + + + + +@Returns: + + + + + + + +@account: + + + + + + + +@name: +@Returns: + + + + + + + +@uid: +@Returns: + + diff --git a/doc/reference/shell/tmpl/e-binding.sgml b/doc/reference/shell/tmpl/e-binding.sgml new file mode 100644 index 0000000000..f2c4ca66fb --- /dev/null +++ b/doc/reference/shell/tmpl/e-binding.sgml @@ -0,0 +1,136 @@ + +GObject Property Bindings + + + + + + + + + + + + + + + + + + + + + + +@src_object: +@src_property: +@dst_object: +@dst_property: +@Returns: + + + + + + + +@src_object: +@src_property: +@dst_object: +@dst_property: +@transform: +@destroy_notify: +@user_data: +@Returns: + + + + + + + +@src_object: +@src_property: +@dst_object: +@dst_property: +@Returns: + + + + + + + +@binding: + + + + + + + +@object1: +@property1: +@object2: +@property2: +@Returns: + + + + + + + +@object1: +@property1: +@object2: +@property2: +@transform: +@reverse_transform: +@destroy_notify: +@user_data: +@Returns: + + + + + + + +@object1: +@property1: +@object2: +@property2: +@Returns: + + + + + + + +@binding: + + + + + + + +@src_value: +@dst_value: +@user_data: +@Returns: + + + + + + + +@src_value: +@dst_value: +@user_data: +@Returns: + + diff --git a/doc/reference/shell/tmpl/e-bit-array.sgml b/doc/reference/shell/tmpl/e-bit-array.sgml new file mode 100644 index 0000000000..01714047c9 --- /dev/null +++ b/doc/reference/shell/tmpl/e-bit-array.sgml @@ -0,0 +1,167 @@ + +Bit Arrays (Legacy) + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@count: +@Returns: + + + + + + + +@selection: +@n: +@Returns: + + + + + + + +@selection: +@callback: +@closure: + + + + + + + +@selection: +@Returns: + + + + + + + +@selection: + + + + + + + +@selection: + + + + + + + +@selection: +@Returns: + + + + + + + +@selection: +@row: +@grow: + + + + + + + +@selection: +@start: +@end: +@grow: + + + + + + + +@eba: +@row: + + + + + + + +@eba: +@row: + + + + + + + +@esm: +@row: +@count: + + + + + + + +@esm: +@row: +@count: + + + + + + + +@esm: +@row: +@count: + + + + + + + +@esm: +@old_row: +@new_row: + + diff --git a/doc/reference/shell/tmpl/e-categories-config.sgml b/doc/reference/shell/tmpl/e-categories-config.sgml new file mode 100644 index 0000000000..8ee544ec23 --- /dev/null +++ b/doc/reference/shell/tmpl/e-categories-config.sgml @@ -0,0 +1,37 @@ + +Category Functions + + + + + + + + + + + + + + + + + + + + + + +@category: +@pixbuf: +@Returns: + + + + + + + +@entry: + + diff --git a/doc/reference/shell/tmpl/e-datetime-format.sgml b/doc/reference/shell/tmpl/e-datetime-format.sgml new file mode 100644 index 0000000000..1dd1c7f24a --- /dev/null +++ b/doc/reference/shell/tmpl/e-datetime-format.sgml @@ -0,0 +1,66 @@ + +Date and Time Formatting Functions + + + + + + + + + + + + + + + + + + + + + + +@DTFormatKindDate: +@DTFormatKindTime: +@DTFormatKindDateTime: +@DTFormatKindShortDate: + + + + + + +@table: +@row: +@component: +@part: +@kind: +@caption: + + + + + + + +@component: +@part: +@kind: +@value: +@Returns: + + + + + + + +@component: +@part: +@kind: +@tm_time: +@Returns: + + diff --git a/doc/reference/shell/tmpl/e-dialog-utils.sgml b/doc/reference/shell/tmpl/e-dialog-utils.sgml new file mode 100644 index 0000000000..08bac749fe --- /dev/null +++ b/doc/reference/shell/tmpl/e-dialog-utils.sgml @@ -0,0 +1,109 @@ + +Dialog Window Functions (Legacy) + + + + + + + + + + + + + + + + + + + + + + +@parent: +@type: +@format: +@Varargs: + + + + + + + +@title: +@fname: +@Returns: + + + + + + + +@parent: +@title: +@name: +@action: +@Returns: + + + + + + + +@parent: +@uri: +@Returns: + + + + + + + +@name: +@Returns: + + + + + + + +@widget: +@value: + + + + + + + +@widget: +@Returns: + + + + + + + +@widget: +@value: +@value_map: + + + + + + + +@widget: +@value_map: +@Returns: + + diff --git a/doc/reference/shell/tmpl/e-error.sgml b/doc/reference/shell/tmpl/e-error.sgml new file mode 100644 index 0000000000..21055001f5 --- /dev/null +++ b/doc/reference/shell/tmpl/e-error.sgml @@ -0,0 +1,139 @@ + +Error Dialog Functions + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@parent: +@tag: +@arg0: +@Varargs: +@Returns: + + + + + + + +@parent: +@tag: +@arg0: +@ap: +@Returns: + + + + + + + +@parent: +@tag: +@arg0: +@Varargs: +@Returns: + + + + + + + +@parent: +@tag: +@arg0: +@ap: +@Returns: + + + + + + + +@dialog: +@Returns: + + diff --git a/doc/reference/shell/tmpl/e-html-utils.sgml b/doc/reference/shell/tmpl/e-html-utils.sgml new file mode 100644 index 0000000000..0588b32c5b --- /dev/null +++ b/doc/reference/shell/tmpl/e-html-utils.sgml @@ -0,0 +1,96 @@ + +Text to HTML Conversion + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@input: +@flags: +@color: +@Returns: + + + + + + + +@input: +@flags: +@Returns: + + diff --git a/doc/reference/shell/tmpl/e-icon-factory.sgml b/doc/reference/shell/tmpl/e-icon-factory.sgml new file mode 100644 index 0000000000..66d8008060 --- /dev/null +++ b/doc/reference/shell/tmpl/e-icon-factory.sgml @@ -0,0 +1,73 @@ + +Icon Functions (Legacy) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@icon_name: +@icon_size: +@Returns: + + + + + + + +@icon_name: +@icon_size: +@Returns: + + + + + + + +@pixbuf: +@width: +@height: +@Returns: + + + + + + + +@filename: +@Returns: + + diff --git a/doc/reference/shell/tmpl/e-logger.sgml b/doc/reference/shell/tmpl/e-logger.sgml new file mode 100644 index 0000000000..95145bd709 --- /dev/null +++ b/doc/reference/shell/tmpl/e-logger.sgml @@ -0,0 +1,87 @@ + +Error Logging + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@line: +@data: + + + + + + + +@E_LOG_ERROR: +@E_LOG_WARNING: +@E_LOG_DEBUG: + + + + + + +@name: +@Returns: + + + + + + + +@logger: +@Returns: + + + + + + + +@logger: +@level: +@primary: +@secondary: + + + + + + + +@logger: +@func: +@user_data: + + diff --git a/doc/reference/shell/tmpl/e-module.sgml b/doc/reference/shell/tmpl/e-module.sgml new file mode 100644 index 0000000000..b27b5b3c90 --- /dev/null +++ b/doc/reference/shell/tmpl/e-module.sgml @@ -0,0 +1,57 @@ + +Generic Module Loader + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@filename: +@Returns: + + + + + + + +@module: +@Returns: + + + + + + + +@dirname: +@Returns: + + diff --git a/doc/reference/shell/tmpl/e-print.sgml b/doc/reference/shell/tmpl/e-print.sgml new file mode 100644 index 0000000000..59a7795843 --- /dev/null +++ b/doc/reference/shell/tmpl/e-print.sgml @@ -0,0 +1,35 @@ + +Printing Functions + + + + + + + + + + + + + + + + + + + + + + +@Returns: + + + + + + + +@parent: + + diff --git a/doc/reference/shell/tmpl/e-shell-backend.sgml b/doc/reference/shell/tmpl/e-shell-backend.sgml index 10e2845d59..79456dcfea 100644 --- a/doc/reference/shell/tmpl/e-shell-backend.sgml +++ b/doc/reference/shell/tmpl/e-shell-backend.sgml @@ -64,15 +64,6 @@ EShellBackend @Returns: - - - - - -@shell_backend: -@Returns: - - diff --git a/doc/reference/shell/tmpl/e-signature-list.sgml b/doc/reference/shell/tmpl/e-signature-list.sgml new file mode 100644 index 0000000000..42e7f5d042 --- /dev/null +++ b/doc/reference/shell/tmpl/e-signature-list.sgml @@ -0,0 +1,113 @@ + +Container for Signatures + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@esignaturelist: the object which received the signal. +@arg1: + + + + + + +@esignaturelist: the object which received the signal. +@arg1: + + + + + + +@esignaturelist: the object which received the signal. +@arg1: + + + + + + +@gconf: +@Returns: + + + + + + + +@signature_list: +@gconf: + + + + + + + +@signature_list: + + + + + + + +@signature_list: +@signature: + + + + + + + +@signature_list: +@signature: + + + + + + + +@signature_list: +@signature: + + + + + + + +@signature_list: +@type: +@key: +@Returns: + + diff --git a/doc/reference/shell/tmpl/e-signature-utils.sgml b/doc/reference/shell/tmpl/e-signature-utils.sgml new file mode 100644 index 0000000000..a5a04475e9 --- /dev/null +++ b/doc/reference/shell/tmpl/e-signature-utils.sgml @@ -0,0 +1,74 @@ + +More Signature Functions + + + + + + + + + + + + + + + + + + + + + + +@Returns: + + + + + + + +@name: +@Returns: + + + + + + + +@uid: +@Returns: + + + + + + + +@error: +@Returns: + + + + + + + +@signature: +@convert_to_html: +@error: +@Returns: + + + + + + + +@filename: +@Returns: + + diff --git a/doc/reference/shell/tmpl/e-signature.sgml b/doc/reference/shell/tmpl/e-signature.sgml new file mode 100644 index 0000000000..19e07bae87 --- /dev/null +++ b/doc/reference/shell/tmpl/e-signature.sgml @@ -0,0 +1,218 @@ + +Personalized Signatures + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@Returns: + + + + + + + +@xml: +@Returns: + + + + + + + +@xml: +@Returns: + + + + + + + +@signature: +@xml: +@Returns: + + + + + + + +@signature: +@Returns: + + + + + + + +@signature1: +@signature2: +@Returns: + + + + + + + +@signature: +@Returns: + + + + + + + +@signature: +@autogenerated: + + + + + + + +@signature: +@Returns: + + + + + + + +@signature: +@filename: + + + + + + + +@signature: +@Returns: + + + + + + + +@signature: +@is_html: + + + + + + + +@signature: +@Returns: + + + + + + + +@signature: +@is_script: + + + + + + + +@signature: +@Returns: + + + + + + + +@signature: +@name: + + + + + + + +@signature: +@Returns: + + + + + + + +@signature: +@uid: + + diff --git a/doc/reference/shell/tmpl/e-util.sgml b/doc/reference/shell/tmpl/e-util.sgml new file mode 100644 index 0000000000..7d2fde14a7 --- /dev/null +++ b/doc/reference/shell/tmpl/e-util.sgml @@ -0,0 +1,493 @@ + +Miscellaneous Utility Functions + + + + + + + + + + + + + + + + + + + + + + +@Returns: + + + + + + + +@Returns: + + + + + + + +@parent: +@uri: + + + + + + + +@parent: +@link_id: + + + + + + + +@ui_manager: +@action_name: +@Returns: + + + + + + + +@ui_manager: +@group_name: +@Returns: + + + + + + + +@ui_manager: +@basename: +@Returns: + + + + + + + +@action1: +@action2: +@Returns: + + + + + + + +@action_group: + + + + + + + +@radio_action: +@Returns: + + + + + + + +@func: +@object: + + + + + + + +@parent_type: +@func: +@user_data: + + + + + + + +@s: +@Returns: + + + + + + + +@x: +@y: +@Returns: + + + + + + + +@x: +@y: +@Returns: + + + + + + + +@x: +@y: +@Returns: + + + + + + + +@x: +@y: +@Returns: + + + + + + + +@filename: +@data: +@Returns: + + + + + + + +@color: +@Returns: + + + + + + + +@number: +@Returns: + + + + + + + +@first: +@second: +@closure: +@Returns: + + + + + + + +@key: +@base: +@nmemb: +@size: +@compare: +@closure: +@start: +@end: + + + + + + + +@str: +@max: +@fmt: +@tm: +@Returns: + + + + + + + +@str: +@max: +@fmt: +@tm: +@Returns: + + + + + + + +@month: +@abbreviated: +@Returns: + + + + + + + +@weekday: +@abbreviated: +@Returns: + + + + + + + +@nptr: +@endptr: +@Returns: + + + + + + + +@buffer: +@buf_len: +@format: +@d: +@Returns: + + + + + + + +@Returns: + + + + + + + +@uri: +@free: + + + + + + + +@Returns: + + + + + + + +@Returns: + + + + + + + + + + + + + + +@Returns: + + + + + + + +@filename: +@localfile: +@Returns: + + + + + + + +@filename: +@Returns: + + + + + + + +@uri: +@Returns: + + + + + + + +@filename: +@filename_is_uri: +@buffer: +@read: +@error: +@Returns: + + + + + + + +@Returns: + + + + + + + +@action_group: +@action_prefix: +@default_charset: +@callback: +@user_data: +@Returns: + + + + + + + +@E_CURSOR_FAT_CROSS: +@E_CURSOR_THIN_CROSS: +@E_CURSOR_ARROW: +@E_CURSOR_MOVE: +@E_CURSOR_ZOOM_IN: +@E_CURSOR_ZOOM_OUT: +@E_CURSOR_SIZE_X: +@E_CURSOR_SIZE_Y: +@E_CURSOR_SIZE_TL: +@E_CURSOR_SIZE_TR: +@E_CURSOR_PRESS: +@E_CURSOR_HAND_OPEN: +@E_CURSOR_HAND_CLOSED: +@E_CURSOR_XTERM: +@E_CURSOR_NUM_CURSORS: + + + + + + +@widget: +@cursor: + + + + + + + +@local_dir: +@type: +@Returns: + + + + + + + +@path: +@Returns: + + + + + + + +@path: +@Returns: + + + + + + + +@template: +@Returns: + + + + + + + +@template: +@Returns: + + + + + + + +@template: +@Returns: + + diff --git a/doc/reference/shell/tmpl/e-xml-utils.sgml b/doc/reference/shell/tmpl/e-xml-utils.sgml new file mode 100644 index 0000000000..e9c17a0b35 --- /dev/null +++ b/doc/reference/shell/tmpl/e-xml-utils.sgml @@ -0,0 +1,216 @@ + +Reading and Writing XML + + + + + + + + + + + + + + + + + + + + + + +@parent: +@child_name: +@lang: +@Returns: + + + + + + + +@parent: +@name: +@lang_list: +@Returns: + + + + + + + +@parent: +@name: +@Returns: + + + + + + + +@parent: +@prop_name: +@Returns: + + + + + + + +@parent: +@prop_name: +@def: +@Returns: + + + + + + + +@parent: +@prop_name: +@value: + + + + + + + +@parent: +@prop_name: +@Returns: + + + + + + + +@parent: +@prop_name: +@def: +@Returns: + + + + + + + +@parent: +@prop_name: +@value: + + + + + + + +@parent: +@prop_name: +@Returns: + + + + + + + +@parent: +@prop_name: +@def: +@Returns: + + + + + + + +@parent: +@prop_name: +@value: + + + + + + + +@parent: +@prop_name: +@Returns: + + + + + + + +@parent: +@prop_name: +@def: +@Returns: + + + + + + + +@parent: +@prop_name: +@value: + + + + + + + +@parent: +@prop_name: +@Returns: + + + + + + + +@parent: +@prop_name: +@def: +@Returns: + + + + + + + +@parent: +@prop_name: +@value: + + + + + + + +@parent: +@prop_name: +@Returns: + + diff --git a/doc/reference/shell/tmpl/eshell-unused.sgml b/doc/reference/shell/tmpl/eshell-unused.sgml index 5f6b668d65..23bee36db2 100644 --- a/doc/reference/shell/tmpl/eshell-unused.sgml +++ b/doc/reference/shell/tmpl/eshell-unused.sgml @@ -1850,6 +1850,14 @@ intelligent @revision: @Returns: + + + + + +@shell_backend: +@Returns: + diff --git a/doc/reference/shell/tmpl/gconf-bridge.sgml b/doc/reference/shell/tmpl/gconf-bridge.sgml new file mode 100644 index 0000000000..e7b43dac52 --- /dev/null +++ b/doc/reference/shell/tmpl/gconf-bridge.sgml @@ -0,0 +1,137 @@ + +GConf Bridge + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@Returns: + + + + + + + +@bridge: +@Returns: + + + + + + + +@bridge: +@key: +@object: +@prop: +@delayed_sync: +@Returns: + + + + + + + +@bridge: +@key: +@object: +@prop: + + + + + + + +@bridge: +@key: +@object: +@prop: + + + + + + + +@bridge: +@key_prefix: +@window: +@bind_size: +@bind_pos: +@Returns: + + + + + + + +@bridge: +@key_prefix: +@window: + + + + + + + +@bridge: +@key_prefix: +@window: + + + + + + + +@bridge: +@key: +@list_store: +@Returns: + + + + + + + +@bridge: +@binding_id: + + -- cgit v1.2.3