Document CamelMimeFilterToHTMLFlags.
authorMatthew Barnes <mbarnes@redhat.com>
Thu, 7 Feb 2013 13:36:06 +0000 (08:36 -0500)
committerMatthew Barnes <mbarnes@redhat.com>
Thu, 7 Feb 2013 13:37:12 +0000 (08:37 -0500)
camel/camel-enums.h

index 76ebc77..d8c4d8b 100644 (file)
@@ -135,6 +135,31 @@ typedef enum { /*< flags >*/
 
 #define CAMEL_FOLDER_TYPE_MASK (63 << CAMEL_FOLDER_TYPE_BIT)
 
+/**
+ * CamelMimeFilterToHTMLFlags:
+ * @CAMEL_MIME_FILTER_TOHTML_PRE:
+ *     Enclose the content in <pre> ... </pre> tags.
+ * @CAMEL_MIME_FILTER_TOHTML_CONVERT_NL:
+ *     Convert newline characters to <br> tags.
+ * @CAMEL_MIME_FILTER_TOHTML_CONVERT_SPACES:
+ *     Convert space and tab characters to a non-breaking space (&nbsp;).
+ * @CAMEL_MIME_FILTER_TOHTML_CONVERT_URLS:
+ *     Convert recognized URLs to <a href="foo">foo</a>.
+ * @CAMEL_MIME_FILTER_TOHTML_MARK_CITATION:
+ *     Color quoted lines (lines beginning with '>').
+ * @CAMEL_MIME_FILTER_TOHTML_CONVERT_ADDRESSES:
+ *     Convert mailto: URLs to <a href="mailto:foo">mailto:foo</a>.
+ * @CAMEL_MIME_FILTER_TOHTML_ESCAPE_8BIT:
+ *     Convert 8-bit characters to escaped hexdecimal (&#nnn;).
+ * @CAMEL_MIME_FILTER_TOHTML_CITE:
+ *     Prefix each line with "> ".
+ * @CAMEL_MIME_FILTER_TOHTML_PRESERVE_8BIT:
+ *     This flag is not used by #CamelMimeFilterToHTML.
+ * @CAMEL_MIME_FILTER_TOHTML_FORMAT_FLOWED:
+ *     This flag is not used by #CamelMimeFilterToHTML.
+ *
+ * Flags for converting text/plain content into text/html.
+ **/
 typedef enum { /*< flags >*/
        CAMEL_MIME_FILTER_TOHTML_PRE               = 1 << 0,
        CAMEL_MIME_FILTER_TOHTML_CONVERT_NL        = 1 << 1,