diff options
author | Matthew Barnes <mbarnes@redhat.com> | 2013-05-27 04:18:25 +0800 |
---|---|---|
committer | Matthew Barnes <mbarnes@redhat.com> | 2013-05-28 21:56:30 +0800 |
commit | 04aa0fba1f96cac50e8006e7dd806cf042138851 (patch) | |
tree | d7a73b8679f3fe17ae1c446c3c60e27e5bf8a01e /doc | |
parent | 70a9fcdf9c61c09fcac72ddf99e73cb57ed99017 (diff) | |
download | gsoc2013-evolution-04aa0fba1f96cac50e8006e7dd806cf042138851.tar gsoc2013-evolution-04aa0fba1f96cac50e8006e7dd806cf042138851.tar.gz gsoc2013-evolution-04aa0fba1f96cac50e8006e7dd806cf042138851.tar.bz2 gsoc2013-evolution-04aa0fba1f96cac50e8006e7dd806cf042138851.tar.lz gsoc2013-evolution-04aa0fba1f96cac50e8006e7dd806cf042138851.tar.xz gsoc2013-evolution-04aa0fba1f96cac50e8006e7dd806cf042138851.tar.zst gsoc2013-evolution-04aa0fba1f96cac50e8006e7dd806cf042138851.zip |
Rename libemformat to libevolution-mail-formatter.
To make Evolution's shared libraries more consistent.
Also add an evolution-mail-formatter documentation module.
Diffstat (limited to 'doc')
6 files changed, 530 insertions, 1 deletions
diff --git a/doc/reference/Makefile.am b/doc/reference/Makefile.am index bfa5808884..8ac97d0f8f 100644 --- a/doc/reference/Makefile.am +++ b/doc/reference/Makefile.am @@ -1,3 +1,9 @@ -SUBDIRS = evolution-util evolution-shell +NULL = + +SUBDIRS = \ + evolution-mail-formatter \ + evolution-shell \ + evolution-util \ + $(NULL) -include $(top_srcdir)/git.mk diff --git a/doc/reference/evolution-mail-formatter/Makefile.am b/doc/reference/evolution-mail-formatter/Makefile.am new file mode 100644 index 0000000000..1584f84355 --- /dev/null +++ b/doc/reference/evolution-mail-formatter/Makefile.am @@ -0,0 +1,38 @@ +# The name of the module. +DOC_MODULE=evolution-mail-formatter + +# The top-level SGML file. +DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml + +# The directory containing the source code. Relative to $(srcdir). +DOC_SOURCE_DIR=$(top_srcdir)/em-format + +# Used for dependencies. The docs will be rebuilt if any of these change. +HFILE_GLOB=$(top_srcdir)/em-format/*.h +CFILE_GLOB=$(top_srcdir)/em-format/*.c + +# Header files to ignore when scanning. +IGNORE_HFILES= \ + $(NULL) + +GTKDOC_CFLAGS= \ + -I$(top_srcdir) \ + -I$(top_builddir) \ + $(EVOLUTION_DATA_SERVER_CFLAGS) \ + $(GNOME_PLATFORM_CFLAGS) \ + $(GTKHTML_CFLAGS) \ + $(NULL) + +GTKDOC_LIBS= \ + $(top_builddir)/em-format/libevolution-mail-formatter.la \ + $(EVOLUTION_DATA_SERVER_LIBS) \ + $(GNOME_PLATFORM_LIBS) \ + $(GTKHTML_LIBS) \ + $(NULL) + +# This includes the standard gtk-doc make rules, copied by gtkdocize. +include $(top_srcdir)/gtk-doc.make + +#TESTS = $(GTKDOC_CHECK) + +-include $(top_srcdir)/git.mk diff --git a/doc/reference/evolution-mail-formatter/evolution-mail-formatter-docs.sgml b/doc/reference/evolution-mail-formatter/evolution-mail-formatter-docs.sgml new file mode 100644 index 0000000000..f3d0e38325 --- /dev/null +++ b/doc/reference/evolution-mail-formatter/evolution-mail-formatter-docs.sgml @@ -0,0 +1,53 @@ +<?xml version="1.0"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" + "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" +[ + <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'"> +]> +<book id="index"> + <bookinfo> + <title>Evolution Mail Formatter Reference Manual</title> + <releaseinfo> + The latest version of this documentation can be found on-line at + <ulink role="online-location" url="http://developer.gnome.org/evolution-mail-formatter/">http://developer.gnome.org/evolution-mail-formatter/</ulink>. + </releaseinfo> + </bookinfo> + + <chapter> + <title>Mail Parsing and Formatting</title> + <xi:include href="xml/e-mail-parser.xml"/> + <xi:include href="xml/e-mail-formatter.xml"/> + <xi:include href="xml/e-mail-formatter-print.xml"/> + <xi:include href="xml/e-mail-formatter-quote.xml"/> + <xi:include href="xml/e-mail-part.xml"/> + <xi:include href="xml/e-mail-part-list.xml"/> + <xi:include href="xml/e-mail-part-attachment.xml"/> + <xi:include href="xml/e-mail-part-attachment-bar.xml"/> + <xi:include href="xml/e-mail-part-headers.xml"/> + <xi:include href="xml/e-mail-part-image.xml"/> + </chapter> + + <chapter> + <title>Extensions</title> + <xi:include href="xml/e-mail-extension-registry.xml"/> + <xi:include href="xml/e-mail-parser-extension.xml"/> + <xi:include href="xml/e-mail-formatter-extension.xml"/> + </chapter> + + <chapter> + <title>Miscellaneous</title> + <xi:include href="xml/e-mail-inline-filter.xml"/> + <xi:include href="xml/e-mail-stripsig-filter.xml"/> + </chapter> + + <chapter id="object-tree"> + <title>Object Hierarchy</title> + <xi:include href="xml/tree_index.sgml"/> + </chapter> + + <index id="api-index-full"> + <title>Index</title> + <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include> + </index> + +</book> diff --git a/doc/reference/evolution-mail-formatter/evolution-mail-formatter-overrides.txt b/doc/reference/evolution-mail-formatter/evolution-mail-formatter-overrides.txt new file mode 100644 index 0000000000..e69de29bb2 --- /dev/null +++ b/doc/reference/evolution-mail-formatter/evolution-mail-formatter-overrides.txt diff --git a/doc/reference/evolution-mail-formatter/evolution-mail-formatter-sections.txt b/doc/reference/evolution-mail-formatter/evolution-mail-formatter-sections.txt new file mode 100644 index 0000000000..19c01f1565 --- /dev/null +++ b/doc/reference/evolution-mail-formatter/evolution-mail-formatter-sections.txt @@ -0,0 +1,399 @@ +<SECTION> +<FILE>e-mail-extension-registry</FILE> +<TITLE>EMailExtensionRegistry</TITLE> +EMailExtensionRegistry +e_mail_extension_registry_get_for_mime_type +e_mail_extension_registry_get_fallback +EMailParserExtensionRegistry +e_mail_parser_extension_registry_load +EMailFormatterExtensionRegistry +e_mail_formatter_extension_registry_load +<SUBSECTION Standard> +E_MAIL_EXTENSION_REGISTRY +E_IS_MAIL_EXTENSION_REGISTRY +E_TYPE_MAIL_EXTENSION_REGISTRY +E_MAIL_EXTENSION_REGISTRY_CLASS +E_IS_MAIL_EXTENSION_REGISTRY_CLASS +E_MAIL_EXTENSION_REGISTRY_GET_CLASS +E_MAIL_PARSER_EXTENSION_REGISTRY +E_IS_MAIL_PARSER_EXTENSION_REGISTRY +E_TYPE_MAIL_PARSER_EXTENSION_REGISTRY +E_MAIL_PARSER_EXTENSION_REGISTRY_CLASS +E_IS_MAIL_PARSER_EXTENSION_REGISTRY_CLASS +E_MAIL_PARSER_EXTENSION_REGISTRY_GET_CLASS +E_MAIL_FORMATTER_EXTENSION_REGISTRY +E_IS_MAIL_FORMATTER_EXTENSION_REGISTRY +E_TYPE_MAIL_FORMATTER_EXTENSION_REGISTRY +E_MAIL_FORMATTER_EXTENSION_REGISTRY_CLASS +E_IS_MAIL_FORMATTER_EXTENSION_REGISTRY_CLASS +E_MAIL_FORMATTER_EXTENSION_REGISTRY_GET_CLASS +EMailExtensionRegistryClass +EMailParserExtensionRegistryClass +EMailFormatterExtensionRegistryClass +e_mail_extension_registry_get_type +e_mail_parser_extension_registry_get_type +e_mail_formatter_extension_registry_get_type +<SUBSECTION Private> +EMailExtensionRegistryPrivate +EMailParserExtensionRegistryPrivate +EMailFormatterExtensionRegistryPrivate +</SECTION> + +<SECTION> +<FILE>e-mail-formatter</FILE> +<TITLE>EMailFormatter</TITLE> +EMailFormatter +EMailFormatterHeaderFlags +EMailFormatterHeader +EMailFormatterMode +EMailFormatterContext +e_mail_formatter_new +e_mail_formatter_format_sync +e_mail_formatter_format +e_mail_formatter_format_finish +e_mail_formatter_format_as +e_mail_formatter_format_text +e_mail_formatter_get_html_header +e_mail_formatter_get_extension_registry +e_mail_formatter_get_text_format_flags +EMailFormatterColorType +e_mail_formatter_get_color +e_mail_formatter_set_color +e_mail_formatter_update_style +e_mail_formatter_get_image_loading_policy +e_mail_formatter_set_image_loading_policy +e_mail_formatter_get_mark_citations +e_mail_formatter_set_mark_citations +e_mail_formatter_get_show_sender_photo +e_mail_formatter_set_show_sender_photo +e_mail_formatter_get_animate_images +e_mail_formatter_set_animate_images +e_mail_formatter_get_show_real_date +e_mail_formatter_set_show_real_date +e_mail_formatter_get_charset +e_mail_formatter_dup_charset +e_mail_formatter_set_charset +e_mail_formatter_get_default_charset +e_mail_formatter_dup_default_charset +e_mail_formatter_set_default_charset +e_mail_formatter_dup_headers +e_mail_formatter_clear_headers +e_mail_formatter_set_default_headers +e_mail_formatter_add_header +e_mail_formatter_add_header_struct +e_mail_formatter_remove_header +e_mail_formatter_remove_header_struct +e_mail_formatter_format_header +e_mail_formatter_format_text_header +e_mail_formatter_format_address +e_mail_formatter_canon_header_name +e_mail_formatter_find_rfc822_end_iter +e_mail_formatter_parse_html_mnemonics +e_mail_formatter_header_new +e_mail_formatter_header_copy +e_mail_formatter_header_free +<SUBSECTION Standard> +E_MAIL_FORMATTER +E_IS_MAIL_FORMATTER +E_TYPE_MAIL_FORMATTER +E_MAIL_FORMATTER_CLASS +E_IS_MAIL_FORMATTER_CLASS +E_MAIL_FORMATTER_GET_CLASS +EMailFormatterClass +e_mail_formatter_get_type +<SUBSECTION Private> +EMailFormatterPrivate +</SECTION> + +<SECTION> +<FILE>e-mail-formatter-extension</FILE> +<TITLE>EMailFormatterExtension</TITLE> +EMailFormatterExtension +e_mail_formatter_extension_format +e_mail_formatter_extension_has_widget +e_mail_formatter_extension_get_widget +<SUBSECTION Standard> +E_MAIL_FORMATTER_EXTENSION +E_IS_MAIL_FORMATTER_EXTENSION +E_TYPE_MAIL_FORMATTER_EXTENSION +E_MAIL_FORMATTER_EXTENSION_CLASS +E_IS_MAIL_FORMATTER_EXTENSION_CLASS +E_MAIL_FORMATTER_EXTENSION_GET_CLASS +EMailFormatterExtensionClass +e_mail_formatter_extension_get_type +<SUBSECTION Private> +EMailFormatterExtensionPrivate +</SECTION> + +<SECTION> +<FILE>e-mail-formatter-print</FILE> +<TITLE>EMailFormatterPrint</TITLE> +EMailFormatterPrint +e_mail_formatter_print_new +EMailFormatterPrintExtension +<SUBSECTION Standard> +E_MAIL_FORMATTER_PRINT +E_IS_MAIL_FORMATTER_PRINT +E_TYPE_MAIL_FORMATTER_PRINT +E_MAIL_FORMATTER_PRINT_CLASS +E_IS_MAIL_FORMATTER_PRINT_CLASS +E_MAIL_FORMATTER_PRINT_GET_CLASS +E_TYPE_MAIL_FORMATTER_PRINT_EXTENSION +EMailFormatterPrintClass +EMailFormatterPrintExtensionClass +e_mail_formatter_print_get_type +e_mail_formatter_print_extension_get_type +</SECTION> + +<SECTION> +<FILE>e-mail-formatter-quote</FILE> +<TITLE>EMailFormatterQuote</TITLE> +EMailFormatterQuote +EMailFormatterQuoteContext +EMailFormatterQuoteFlags +e_mail_formatter_quote_new +EMailFormatterQuoteExtension +<SUBSECTION Standard> +E_MAIL_FORMATTER_QUOTE +E_IS_MAIL_FORMATTER_QUOTE +E_TYPE_MAIL_FORMATTER_QUOTE +E_MAIL_FORMATTER_QUOTE_CLASS +E_IS_MAIL_FORMATTER_QUOTE_CLASS +E_MAIL_FORMATTER_QUOTE_GET_CLASS +E_TYPE_MAIL_FORMATTER_QUOTE_EXTENSION +EMailFormatterQuoteClass +EMailFormatterQuoteExtensionClass +e_mail_formatter_quote_get_type +e_mail_formatter_quote_extension_get_type +<SUBSECTION Private> +EMailFormatterQuotePrivate +</SECTION> + +<SECTION> +<FILE>e-mail-inline-filter</FILE> +<TITLE>EMailInlineFilter</TITLE> +EMailInlineFilter +e_mail_inline_filter_new +e_mail_inline_filter_get_multipart +e_mail_inline_filter_found_any +<SUBSECTION Standard> +E_MAIL_INLINE_FILTER +E_IS_MAIL_INLINE_FILTER +E_TYPE_MAIL_INLINE_FILTER +E_MAIL_INLINE_FILTER_CLASS +E_IS_MAIL_INLINE_FILTER_CLASS +E_MAIL_INLINE_FILTER_GET_CLASS +EMailInlineFilterClass +e_mail_inline_filter_get_type +</SECTION> + +<SECTION> +<FILE>e-mail-parser</FILE> +<TITLE>EMailParser</TITLE> +EMailParser +e_mail_parser_new +e_mail_parser_parse_sync +e_mail_parser_parse +e_mail_parser_parse_finish +e_mail_parser_parse_part +e_mail_parser_parse_part_as +e_mail_parser_error +e_mail_parser_wrap_as_attachment +e_mail_parser_get_session +e_mail_parser_get_extension_registry +<SUBSECTION Standard> +E_MAIL_PARSER +E_IS_MAIL_PARSER +E_TYPE_MAIL_PARSER +E_MAIL_PARSER_CLASS +E_IS_MAIL_PARSER_CLASS +E_MAIL_PARSER_GET_CLASS +EMailParserClass +e_mail_parser_get_type +<SUBSECTION Private> +EMailParserPrivate +</SECTION> + +<SECTION> +<FILE>e-mail-parser-extension</FILE> +<TITLE>EMailParserExtension</TITLE> +EMailParserExtension +EMailParserExtensionFlags +e_mail_parser_extension_parse +<SUBSECTION Standard> +E_MAIL_PARSER_EXTENSION +E_IS_MAIL_PARSER_EXTENSION +E_TYPE_MAIL_PARSER_EXTENSION +E_MAIL_PARSER_EXTENSION_CLASS +E_IS_MAIL_PARSER_EXTENSION_CLASS +E_MAIL_PARSER_EXTENSION_GET_CLASS +EMailParserExtensionClass +e_mail_parser_extension_get_type +<SUBSECTION Private> +EMailParserExtensionPrivate +</SECTION> + +<SECTION> +<FILE>e-mail-part</FILE> +<TITLE>EMailPart</TITLE> +EMailPart +EMailPartValidityFlags +EMailPartValidityPair +e_mail_part_new +e_mail_part_get_id +e_mail_part_get_cid +e_mail_part_set_cid +e_mail_part_id_has_prefix +e_mail_part_id_has_suffix +e_mail_part_id_has_substr +e_mail_part_ref_mime_part +e_mail_part_get_mime_type +e_mail_part_set_mime_type +e_mail_part_get_is_attachment +e_mail_part_set_is_attachment +e_mail_part_bind_dom_element +e_mail_part_update_validity +e_mail_part_get_validity +e_mail_part_has_validity +e_mail_part_get_validity_flags +e_mail_part_is_secured +e_mail_part_snoop_type +e_mail_part_is_attachment +e_mail_part_preserve_charset_in_content_type +e_mail_part_get_related_display_part +e_mail_part_animation_extract_frame +e_mail_part_build_uri +e_mail_part_describe +e_mail_part_is_inline +e_mail_part_utils_body_refers +<SUBSECTION Standard> +E_MAIL_PART +E_IS_MAIL_PART +E_TYPE_MAIL_PART +E_MAIL_PART_CLASS +E_IS_MAIL_PART_CLASS +E_MAIL_PART_GET_CLASS +EMailPartClass +e_mail_part_get_type +<SUBSECTION Private>a +EMailPartPrivate +</SECTION> + +<SECTION> +<FILE>e-mail-part-attachment</FILE> +<TITLE>EMailPartAttachment</TITLE> +E_MAIL_PART_ATTACHMENT_MIME_TYPE +EMailPartAttachment +e_mail_part_attachment_new +e_mail_part_attachment_ref_attachment +<SUBSECTION Standard> +E_MAIL_PART_ATTACHMENT +E_IS_MAIL_PART_ATTACHMENT +E_TYPE_MAIL_PART_ATTACHMENT +E_MAIL_PART_ATTACHMENT_CLASS +E_IS_MAIL_PART_ATTACHMENT_CLASS +E_MAIL_PART_ATTACHMENT_GET_CLASS +EMailPartAttachmentClass +e_mail_part_attachment_get_type +<SUBSECTION Private> +EMailPartAttachmentPrivate +</SECTION> + +<SECTION> +<FILE>e-mail-part-attachment-bar</FILE> +<TITLE>EMailPartAttachmentBar</TITLE> +E_MAIL_PART_ATTACHMENT_BAR_MIME_TYPE +EMailPartAttachmentBar +e_mail_part_attachment_bar_new +e_mail_part_attachment_bar_get_store +<SUBSECTION Standard> +E_MAIL_PART_ATTACHMENT_BAR +E_IS_MAIL_PART_ATTACHMENT_BAR +E_TYPE_MAIL_PART_ATTACHMENT_BAR +E_MAIL_PART_ATTACHMENT_BAR_CLASS +E_IS_MAIL_PART_ATTACHMENT_BAR_CLASS +E_MAIL_PART_ATTACHMENT_BAR_GET_CLASS +EMailPartAttachmentBarClass +e_mail_part_attachment_bar_get_type +<SUBSECTION Private> +EMailPartAttachmentBarPrivate +</SECTION> + +<SECTION> +<FILE>e-mail-part-headers</FILE> +<TITLE>EMailPartHeaders</TITLE> +E_MAIL_PART_HEADERS_MIME_TYPE +EMailPartHeaders +e_mail_part_headers_new +<SUBSECTION Standard> +E_MAIL_PART_HEADERS +E_IS_MAIL_PART_HEADERS +E_TYPE_MAIL_PART_HEADERS +E_MAIL_PART_HEADERS_CLASS +E_IS_MAIL_PART_HEADERS_CLASS +E_MAIL_PART_HEADERS_GET_CLASS +EMailPartHeadersClass +e_mail_part_headers_get_type +<SUBSECTION Private> +EMailPartHeadersPrivate +</SECTION> + +<SECTION> +<FILE>e-mail-part-image</FILE> +<TITLE>EMailPartImage</TITLE> +EMailPartImage +e_mail_part_image_new +<SUBSECTION Standard> +E_MAIL_PART_IMAGE +E_IS_MAIL_PART_IMAGE +E_TYPE_MAIL_PART_IMAGE +E_MAIL_PART_IMAGE_CLASS +E_IS_MAIL_PART_IMAGE_CLASS +E_MAIL_PART_IMAGE_GET_CLASS +EMailPartImageClass +e_mail_part_image_get_type +<SUBSECTION Private> +EMailPartImagePrivate +</SECTION> + +<SECTION> +<FILE>e-mail-part-list</FILE> +<TITLE>EMailPartList</TITLE> +EMailPartList +e_mail_part_list_new +e_mail_part_list_get_folder +e_mail_part_list_get_message +e_mail_part_list_get_message_uid +e_mail_part_list_add_part +e_mail_part_list_ref_part +e_mail_part_list_queue_parts +e_mail_part_list_get_registry +<SUBSECTION Standard> +E_MAIL_PART_LIST +E_IS_MAIL_PART_LIST +E_TYPE_MAIL_PART_LIST +E_MAIL_PART_LIST_CLASS +E_IS_MAIL_PART_LIST_CLASS +E_MAIL_PART_LIST_GET_CLASS +EMailPartListClass +e_mail_part_list_get_type +<SUBSECTION Private> +EMailPartListPrivate +</SECTION> + +<SECTION> +<FILE>e-mail-stripsig-filter</FILE> +<TITLE>EMailStripSigFilter</TITLE> +EMailStripSigFilter +e_mail_stripsig_filter_new +<SUBSECTION Standard> +E_MAIL_STRIPSIG_FILTER +E_IS_MAIL_STRIPSIG_FILTER +E_TYPE_MAIL_STRIPSIG_FILTER +E_MAIL_STRIPSIG_FILTER_CLASS +E_IS_MAIL_STRIPSIG_FILTER_CLASS +E_MAIL_STRIPSIG_FILTER_GET_CLASS +EMailStripSigFilterClass +e_mail_stripsig_filter_get_type +</SECTION> + diff --git a/doc/reference/evolution-mail-formatter/evolution-mail-formatter.types b/doc/reference/evolution-mail-formatter/evolution-mail-formatter.types new file mode 100644 index 0000000000..53a572a849 --- /dev/null +++ b/doc/reference/evolution-mail-formatter/evolution-mail-formatter.types @@ -0,0 +1,33 @@ +#include <em-format/e-mail-extension-registry.h> +#include <em-format/e-mail-formatter-extension.h> +#include <em-format/e-mail-formatter-print.h> +#include <em-format/e-mail-formatter-quote.h> +#include <em-format/e-mail-formatter.h> +#include <em-format/e-mail-inline-filter.h> +#include <em-format/e-mail-parser-extension.h> +#include <em-format/e-mail-parser.h> +#include <em-format/e-mail-part-attachment-bar.h> +#include <em-format/e-mail-part-attachment.h> +#include <em-format/e-mail-part-headers.h> +#include <em-format/e-mail-part-image.h> +#include <em-format/e-mail-part-list.h> +#include <em-format/e-mail-part.h> +#include <em-format/e-mail-stripsig-filter.h> + +e_mail_extension_registry_get_type +e_mail_formatter_extension_get_type +e_mail_formatter_extension_registry_get_type +e_mail_formatter_get_type +e_mail_formatter_print_get_type +e_mail_formatter_quote_get_type +e_mail_inline_filter_get_type +e_mail_parser_extension_get_type +e_mail_parser_extension_registry_get_type +e_mail_parser_get_type +e_mail_part_attachment_bar_get_type +e_mail_part_attachment_get_type +e_mail_part_get_type +e_mail_part_headers_get_type +e_mail_part_image_get_type +e_mail_part_list_get_type +e_mail_stripsig_filter_get_type |