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/Makefile.am | 6 +- doc/reference/shell/eshell-docs.sgml | 22 + doc/reference/shell/eshell-sections.txt | 346 ++++++++++++++- doc/reference/shell/eshell.types | 5 + 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 ++++++ 24 files changed, 2699 insertions(+), 11 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') diff --git a/doc/reference/shell/Makefile.am b/doc/reference/shell/Makefile.am index 370fd53b99..037ad06b52 100644 --- a/doc/reference/shell/Makefile.am +++ b/doc/reference/shell/Makefile.am @@ -13,7 +13,7 @@ DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml # gtk-doc will search all .c & .h files beneath here for inline comments # documenting the functions and macros. # e.g. DOC_SOURCE_DIR=../../../gtk -DOC_SOURCE_DIR=../../../shell +DOC_SOURCE_DIR=../../../ # Extra options to pass to gtkdoc-scangobj. Not normally needed. SCANGOBJ_OPTIONS= @@ -82,6 +82,7 @@ GTKDOC_LIBS= \ $(top_builddir)/shell/.libs/es-event.o \ $(top_builddir)/e-util/.libs/e-bconf-map.o \ $(top_builddir)/e-util/.libs/e-binding.o \ + $(top_builddir)/e-util/.libs/e-bit-array.o \ $(top_builddir)/e-util/.libs/e-dialog-utils.o \ $(top_builddir)/e-util/.libs/e-error.o \ $(top_builddir)/e-util/.libs/e-event.o \ @@ -95,6 +96,9 @@ GTKDOC_LIBS= \ $(top_builddir)/e-util/.libs/e-plugin.o \ $(top_builddir)/e-util/.libs/e-plugin-ui.o \ $(top_builddir)/e-util/.libs/e-print.o \ + $(top_builddir)/e-util/.libs/e-signature.o \ + $(top_builddir)/e-util/.libs/e-signature-list.o \ + $(top_builddir)/e-util/.libs/e-signature-utils.o \ $(top_builddir)/e-util/.libs/e-unicode.o \ $(top_builddir)/e-util/.libs/e-util.o \ $(top_builddir)/e-util/.libs/e-xml-utils.o \ diff --git a/doc/reference/shell/eshell-docs.sgml b/doc/reference/shell/eshell-docs.sgml index 3d7bdcd36e..c01c399cb3 100644 --- a/doc/reference/shell/eshell-docs.sgml +++ b/doc/reference/shell/eshell-docs.sgml @@ -25,6 +25,28 @@ url="http://mbarnes.fedorapeople.org/docs/eshell/">http://mbarnes.fedorapeople.o + + Basic Utility Functions + + + + + + + + + + + + + + + + + + + + Actions diff --git a/doc/reference/shell/eshell-sections.txt b/doc/reference/shell/eshell-sections.txt index 52217cb9c4..afce147581 100644 --- a/doc/reference/shell/eshell-sections.txt +++ b/doc/reference/shell/eshell-sections.txt @@ -45,7 +45,6 @@ EShellBackend e_shell_backend_compare e_shell_backend_get_config_dir e_shell_backend_get_data_dir -e_shell_backend_get_filename e_shell_backend_get_shell e_shell_backend_add_activity e_shell_backend_start @@ -292,6 +291,351 @@ E_SHELL_WINDOW_ACTION_GROUP e_shell_importer_start_import +
+e-account-utils +Mail Account Functions +e_get_account_list +e_get_default_account +e_set_default_account +e_get_account_by_name +e_get_account_by_uid +
+ +
+e-binding +GObject Property Bindings +e_binding_new +e_binding_new_full +e_binding_new_with_negation +e_binding_unbind +e_mutual_binding_new +e_mutual_binding_new_full +e_mutual_binding_new_with_negation +e_mutual_binding_unbind +e_binding_transform_color_to_string +e_binding_transform_string_to_color +
+ +
+e-bit-array +Bit Arrays (Legacy) +EBitArray +e_bit_array_new +e_bit_array_value_at +e_bit_array_foreach +e_bit_array_selected_count +e_bit_array_select_all +e_bit_array_invert_selection +e_bit_array_bit_count +e_bit_array_change_one_row +e_bit_array_change_range +e_bit_array_select_single_row +e_bit_array_toggle_single_row +e_bit_array_insert +e_bit_array_delete +e_bit_array_delete_single_mode +e_bit_array_move_row + +E_BIT_ARRAY +E_IS_BIT_ARRAY +E_BIT_ARRAY_TYPE +E_BIT_ARRAY_CLASS +E_IS_BIT_ARRAY_CLASS +EBitArrayClass +e_bit_array_get_type +
+ +
+e-categories-config +Category Functions +e_categories_config_get_icon_for +e_categories_config_open_dialog_for_entry +
+ +
+e-datetime-format +Date and Time Formatting Functions +DTFormatKind +e_datetime_format_add_setup_widget +e_datetime_format_format +e_datetime_format_format_tm +
+ +
+e-dialog-utils +Dialog Window Functions (Legacy) +e_notice +e_file_dialog_save +e_file_get_save_filesel +e_file_can_save +e_file_check_local +e_dialog_editable_set +e_dialog_editable_get +e_dialog_combo_box_set +e_dialog_combo_box_get +
+ +
+e-error +Error Dialog Functions +E_ERROR_INFO +E_ERROR_INFO_PRIMARY +E_ERROR_WARNING +E_ERROR_WARNING_PRIMARY +E_ERROR_ERROR +E_ERROR_ERROR_PRIMARY +E_ERROR_ASK_FILE_EXISTS_OVERWRITE +E_ERROR_NO_SAVE_FILE +E_ERROR_NO_LOAD_FILE +e_error_new +e_error_newv +e_error_run +e_error_runv +e_error_count_buttons +
+ +
+e-html-utils +Text to HTML Conversion +E_TEXT_TO_HTML_PRE +E_TEXT_TO_HTML_CONVERT_NL +E_TEXT_TO_HTML_CONVERT_SPACES +E_TEXT_TO_HTML_CONVERT_URLS +E_TEXT_TO_HTML_MARK_CITATION +E_TEXT_TO_HTML_CONVERT_ADDRESSES +E_TEXT_TO_HTML_ESCAPE_8BIT +E_TEXT_TO_HTML_CITE +e_text_to_html_full +e_text_to_html +
+ +
+e-icon-factory +Icon Functions (Legacy) +e_icon_factory_init +e_icon_factory_shutdown +e_icon_factory_get_icon_filename +e_icon_factory_get_icon +e_icon_factory_pixbuf_scale +e_icon_factory_create_thumbnail +
+ +
+e-logger +Error Logging +ELogger +ELogFunction +ELogLevel +e_logger_new +e_logger_get_name +e_logger_log +e_logger_get_logs + +E_LOGGER +E_IS_LOGGER +E_TYPE_LOGGER +E_LOGGER_CLASS +E_IS_LOGGER_CLASS +E_LOGGER_GET_CLASS +ELoggerClass +e_logger_get_type + +ELoggerPrivate +
+ +
+e-module +Generic Module Loader +EModule +e_module_new +e_module_get_filename +e_module_load_all_in_directory + +E_MODULE +E_IS_MODULE +E_TYPE_MODULE +E_MODULE_CLASS +E_IS_MODULE_CLASS +E_MODULE_GET_CLASS +EModuleClass +e_module_get_type + +EModulePrivate +
+ +
+e-print +Printing Functions +e_print_operation_new +e_print_run_page_setup_dialog +
+ +
+e-signature +Personalized Signatures +ESignature +e_signature_new +e_signature_new_from_xml +e_signature_uid_from_xml +e_signature_set_from_xml +e_signature_to_xml +e_signature_is_equal +e_signature_get_autogenerated +e_signature_set_autogenerated +e_signature_get_filename +e_signature_set_filename +e_signature_get_is_html +e_signature_set_is_html +e_signature_get_is_script +e_signature_set_is_script +e_signature_get_name +e_signature_set_name +e_signature_get_uid +e_signature_set_uid + +E_SIGNATURE +E_IS_SIGNATURE +E_TYPE_SIGNATURE +E_SIGNATURE_CLASS +E_IS_SIGNATURE_CLASS +E_SIGNATURE_GET_CLASS +ESignatureClass +e_signature_get_type + +ESignaturePrivate +
+ +
+e-signature-list +Container for Signatures +ESignatureList +e_signature_list_new +e_signature_list_construct +e_signature_list_save +e_signature_list_add +e_signature_list_change +e_signature_list_remove +e_signature_list_find + +E_SIGNATURE_LIST +E_IS_SIGNATURE_LIST +E_TYPE_SIGNATURE_LIST +E_SIGNATURE_LIST_CLASS +E_IS_SIGNATURE_LIST_CLASS +ESignatureListClass +e_signature_list_get_type + +ESignatureListPrivate +
+ +
+e-signature-utils +More Signature Functions +e_get_signature_list +e_get_signature_by_name +e_get_signature_by_uid +e_create_signature_file +e_read_signature_file +e_run_signature_script +
+ +
+e-util +Miscellaneous Utility Functions +e_get_user_data_dir +e_get_accels_filename +e_show_uri +e_display_help +e_lookup_action +e_lookup_action_group +e_load_ui_definition +e_action_compare_by_label +e_action_group_remove_all_actions +e_radio_action_get_current_action +e_categories_add_change_hook +e_type_traverse +e_str_without_underscores +e_str_compare +e_str_case_compare +e_collate_compare +e_int_compare +e_write_file_uri +e_color_to_value +e_format_number +ESortCompareFunc +e_bsearch +e_strftime_fix_am_pm +e_utf8_strftime_fix_am_pm +e_get_month_name +e_get_weekday_name +e_flexible_strtod +e_ascii_dtostr +get_font_options +e_file_update_save_path +e_file_get_save_path +e_file_lock_create +e_file_lock_destroy +e_file_lock_exists +e_util_guess_mime_type +e_util_filename_to_uri +e_util_uri_to_filename +e_util_read_file +e_util_get_category_filter_options +e_charset_add_radio_actions +ECursorType +e_cursor_set +e_folder_map_local_folders +e_fsutils_usage +e_fsutils_avail +e_mktemp +e_mkstemp +e_mkdtemp + +E_TYPE_CAMEL_OBJECT +e_camel_object_get_type +
+ +
+e-xml-utils +Reading and Writing XML +e_xml_get_child_by_name_by_lang +e_xml_get_child_by_name_by_lang_list +e_xml_get_child_by_name_no_lang +e_xml_get_integer_prop_by_name +e_xml_get_integer_prop_by_name_with_default +e_xml_set_integer_prop_by_name +e_xml_get_uint_prop_by_name +e_xml_get_uint_prop_by_name_with_default +e_xml_set_uint_prop_by_name +e_xml_get_bool_prop_by_name +e_xml_get_bool_prop_by_name_with_default +e_xml_set_bool_prop_by_name +e_xml_get_double_prop_by_name +e_xml_get_double_prop_by_name_with_default +e_xml_set_double_prop_by_name +e_xml_get_string_prop_by_name +e_xml_get_string_prop_by_name_with_default +e_xml_set_string_prop_by_name +e_xml_get_translated_string_prop_by_name +
+ +
+gconf-bridge +GConf Bridge +GConfBridge +gconf_bridge_install_default_error_handler +gconf_bridge_get +gconf_bridge_get_client +gconf_bridge_bind_property_full +gconf_bridge_bind_property +gconf_bridge_bind_property_delayed +gconf_bridge_bind_window +gconf_bridge_bind_window_size +gconf_bridge_bind_window_pos +gconf_bridge_bind_string_list_store +gconf_bridge_unbind +
+
shell-actions Shell Actions diff --git a/doc/reference/shell/eshell.types b/doc/reference/shell/eshell.types index 7ad399f7c9..e03302f8d5 100644 --- a/doc/reference/shell/eshell.types +++ b/doc/reference/shell/eshell.types @@ -1,3 +1,8 @@ +e_bit_array_get_type +e_logger_get_type +e_module_get_type +e_signature_get_type +e_signature_list_get_type e_shell_get_type e_shell_backend_get_type e_shell_content_get_type 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