These are now auto-generated from the function comments.
* @page address Representation of an email address
*
* Representation of an email address
- *
- * | Data | Description
- * | :--------------- | :--------------------------------------------------
- * | #AddressError | An out-of-band error code
- * | #AddressErrors | Messages for the error codes in #AddressError
- * | #AddressSpecials | Characters with special meaning for email addresses
- *
- * | Function | Description
- * | :--------------------------- | :---------------------------------------------------------
- * | mutt_addr_append() | Append one list of addresses onto another
- * | mutt_addr_cat() | Copy a string and escape the specified characters
- * | mutt_addr_cmp() | Compare two e-mail addresses
- * | mutt_addr_cmp_strict() | Strictly compare two Address lists
- * | mutt_addr_copy() | Copy the real address
- * | mutt_addr_copy_list() | Copy a list of addresses
- * | mutt_addr_for_display() | Convert an Address for display purposes
- * | mutt_addr_free() | Free a list of Addresses
- * | mutt_addr_has_recips() | Count the number of Addresses with valid recipients
- * | mutt_addr_is_intl() | Does the Address have IDN components
- * | mutt_addr_is_local() | Does the Address have NO IDN components
- * | mutt_addr_mbox_to_udomain() | Split a mailbox name into user and domain
- * | mutt_addr_new() | Create a new Address
- * | mutt_addr_parse_list() | Parse a list of email addresses
- * | mutt_addr_parse_list2() | Parse a list of email addresses
- * | mutt_addr_qualify() | Expand local names in an Address list using a hostname
- * | mutt_addr_remove_from_list() | Remove an Address from a list
- * | mutt_addr_search() | Search for an e-mail address in a list
- * | mutt_addr_set_intl() | Mark an Address as having IDN components
- * | mutt_addr_set_local() | Mark an Address as having NO IDN components
- * | mutt_addr_valid_msgid() | Is this a valid Message ID?
- * | mutt_addr_write() | Write an Address to a buffer
- * | mutt_addr_write_single() | Write a single Address to a buffer
- * | mutt_addrlist_to_intl() | Convert an Address list to Punycode
- * | mutt_addrlist_to_local() | Convert an Address list from Punycode
*/
#include "config.h"
*
* @note RFC3548 obsoletes RFC2045.
* @note RFC4648 obsoletes RFC3548.
- *
- * | Data | Description
- * | :---------------- | :--------------------------------------------------
- * | #Index64 | Lookup table for Base64 encoding characters
- *
- * | Function | Description
- * | :---------------- | :-------------------------------------------------
- * | mutt_b64_decode() | Convert null-terminated base64 string to raw bytes
- * | mutt_b64_encode() | Convert raw bytes to null-terminated base64 string
*/
#include "config.h"
* @page buffer General purpose object for storing and parsing strings
*
* The Buffer object make parsing and manipulating strings easier.
- *
- * | Function | Description
- * | :--------------------- | :--------------------------------------------------
- * | mutt_buffer_add() | Add a string to a Buffer, expanding it if necessary
- * | mutt_buffer_addch() | Add a single character to a Buffer
- * | mutt_buffer_addstr() | Add a string to a Buffer
- * | mutt_buffer_alloc() | Create a new Buffer
- * | mutt_buffer_free() | Release a Buffer and its contents
- * | mutt_buffer_from() | Create Buffer from an existing string
- * | mutt_buffer_init() | Initialise a new Buffer
- * | mutt_buffer_is_empty() | Is the Buffer empty?
- * | mutt_buffer_new() | Create and initialise a Buffer
- * | mutt_buffer_printf() | Format a string into a Buffer
- * | mutt_buffer_reset() | Reset an existing Buffer
*/
#include "config.h"
* @page charset Conversion between different character encodings
*
* Conversion between different character encodings
- *
- * | Data | Description
- * | :------------------ | :--------------------------------------------------
- * | #AssumedCharset | Encoding schemes for messages without indication
- * | #Charset | User's choice of character set
- * | #Charset_is_utf8 | Is the user's current character set utf-8?
- * | #PreferredMIMENames | Lookup table of preferred charsets
- * | #ReplacementChar | When a Unicode character can't be displayed, use this instead
- *
- * | Function | Description
- * | :----------------------------- | :---------------------------------------------------------
- * | mutt_ch_canonical_charset() | Canonicalise the charset of a string
- * | mutt_ch_charset_lookup() | Look for a replacement character set
- * | mutt_ch_check_charset() | Does iconv understand a character set?
- * | mutt_ch_choose() | Figure the best charset to encode a string
- * | mutt_ch_chscmp() | Are the names of two character sets equivalent?
- * | mutt_ch_convert_nonmime_string() | Try to convert a string using a list of character sets
- * | mutt_ch_convert_string() | Convert a string between encodings
- * | mutt_ch_fgetconv() | Convert a file's character set
- * | mutt_ch_fgetconv_close() | Close an fgetconv handle
- * | mutt_ch_fgetconv_open() | Prepare a file for charset conversion
- * | mutt_ch_fgetconvs() | Convert a file's charset into a string buffer
- * | mutt_ch_get_default_charset() | Get the default character set
- * | mutt_ch_iconv() | Change the encoding of a string
- * | mutt_ch_iconv_lookup() | Look for a replacement character set
- * | mutt_ch_iconv_open() | Set up iconv for conversions
- * | mutt_ch_lookup_add() | Add a new character set lookup
- * | mutt_ch_lookup_remove() | Remove all the character set lookups
- * | mutt_ch_set_charset() | Update the records for a new character set
- * | mutt_ch_set_langinfo_charset() | Set the user's choice of character set
*/
#include "config.h"
#define EILSEQ EINVAL
#endif
-char *AssumedCharset; /**< Encoding schemes for messages without indication */
-char *Charset; /**< User's choice of character set */
+char *AssumedCharset; /**< Config: Encoding schemes for messages without indication */
+char *Charset; /**< Config: User's choice of character set */
/**
* ReplacementChar - When a Unicode character can't be displayed, use this instead
* @page date Time and date handling routines
*
* Some commonly used time and date functions.
- *
- * | Function | Description
- * | :------------------------- | :--------------------------------------------------
- * | mutt_date_check_month() | Is the string a valid month name
- * | mutt_date_is_day_name() | Is the string a valid day name
- * | mutt_date_local_tz() | Calculate the local timezone in seconds east of UTC
- * | mutt_date_make_date() | Write a date in RFC822 format to a buffer
- * | mutt_date_make_imap() | Format date in IMAP style: DD-MMM-YYYY HH:MM:SS +ZZzz
- * | mutt_date_make_time() | Convert `struct tm` to `time_t`
- * | mutt_date_make_tls() | Format date in TLS certificate verification style
- * | mutt_date_normalize_time() | Fix the contents of a struct tm
- * | mutt_date_parse_date() | Parse a date string in RFC822 format
- * | mutt_date_parse_imap() | Parse date of the form: DD-MMM-YYYY HH:MM:SS +ZZzz
*/
#include "config.h"
* @page debug Debug messages
*
* Output debugging messages, suitable for a developer.
- *
- * | Function | Description
- * | :---------------- | :--------------------------------
- * | mutt_debug_real() | Output some debugging information
*/
#include "config.h"
* @page exit Leave the program NOW
*
* The default behaviour on a critical error is to notify the user, then stop.
- *
- * | Function | Description
- * | :---------- | :----------------
- * | mutt_exit() | Leave NeoMutt NOW
*/
#include "config.h"
* @page file File management functions
*
* Commonly used file/dir management routines.
- *
- * | Function | Description
- * | :---------------------------- | :-----------------------------------------------------------
- * | mutt_file_basename() | Find the last component for a pathname
- * | mutt_file_check_empty() | Is the mailbox empty
- * | mutt_file_chmod() | Set permissions of a file
- * | mutt_file_chmod_add() | Add permissions to a file
- * | mutt_file_chmod_add_stat() | Add permissions to a file
- * | mutt_file_chmod_rm() | Remove permissions from a file
- * | mutt_file_chmod_rm_stat() | Remove permissions from a file
- * | mutt_file_concat_path() | Join a directory name and a filename
- * | mutt_file_concatn_path() | Concatenate directory and filename
- * | mutt_file_copy_bytes() | Copy some content from one file to another
- * | mutt_file_copy_stream() | Copy the contents of one file into another
- * | mutt_file_decrease_mtime() | Decrease a file's modification time by 1 second
- * | mutt_file_dirname() | Return a path up to, but not including, the final '/'
- * | mutt_file_fclose() | Close a FILE handle (and NULL the pointer)
- * | mutt_file_fopen() | Call fopen() safely
- * | mutt_file_fsync_close() | Flush the data, before closing a file (and NULL the pointer)
- * | mutt_file_lock() | (try to) lock a file
- * | mutt_file_mkdir() | Recursively create directories
- * | mutt_file_open() | Open a file
- * | mutt_file_quote_filename() | Quote a filename to survive the shell's quoting rules
- * | mutt_file_read_keyword() | Read a keyword from a file
- * | mutt_file_read_line() | Read a line from a file
- * | mutt_file_rename() | Rename a file
- * | mutt_file_rmtree() | Recursively remove a directory
- * | mutt_file_safe_rename() | NFS-safe renaming of files
- * | mutt_file_sanitize_filename() | Replace unsafe characters in a filename
- * | mutt_file_sanitize_regex() | Escape any regex-magic characters in a string
- * | mutt_file_set_mtime() | Set the modification time of one file from another
- * | mutt_file_symlink() | Create a symlink
- * | mutt_file_to_absolute_path() | Convert relative filepath to an absolute path
- * | mutt_file_touch_atime() | Set the access time to current time
- * | mutt_file_unlink() | Delete a file, carefully
- * | mutt_file_unlink_empty() | Delete a file if it's empty
- * | mutt_file_unlock() | Unlock a file previously locked by mutt_file_lock()
*/
#include "config.h"
* @page hash Hash table data structure
*
* Hash table data structure.
- *
- * | Function | Description
- * | :------------------------- | :---------------------------------------------------------
- * | mutt_hash_create() | Create a new Hash table (with string keys)
- * | mutt_hash_delete() | Remove an element from a Hash table
- * | mutt_hash_destroy() | Destroy a hash table
- * | mutt_hash_find() | Find the HashElem data in a Hash table element using a key
- * | mutt_hash_find_bucket() | Find the HashElem in a Hash table element using a key
- * | mutt_hash_find_elem() | Find the HashElem in a Hash table element using a key
- * | mutt_hash_insert() | Add a new element to the Hash table (with string keys)
- * | mutt_hash_int_create() | Create a new Hash table (with integer keys)
- * | mutt_hash_int_delete() | Remove an element from a Hash table
- * | mutt_hash_int_find() | Find the HashElem data in a Hash table element using a key
- * | mutt_hash_int_insert() | Add a new element to the Hash table (with integer keys)
- * | mutt_hash_set_destructor() | Set the destructor for a Hash Table
- * | mutt_hash_typed_insert() | XXX
- * | mutt_hash_walk() | Iterate through all the HashElem's in a Hash table
*/
#include "config.h"
* @page idna Handling of international domain names
*
* Handling of international domain names
- *
- * | Function | Description
- * | :------------------------ | :---------------------------------------------------------
- * | mutt_idna_intl_to_local() | Convert an email's domain from Punycode
- * | mutt_idna_local_to_intl() | Convert an email's domain to Punycode
- * | mutt_idna_to_ascii_lz() | Convert a domain to Punycode
*/
#include "config.h"
* @page list Singly-linked list type
*
* Singly-linked list of strings.
- *
- * | Function | Description
- * | :----------------------- | :-----------------------------------------
- * | mutt_list_clear() | Free a list, but NOT its strings
- * | mutt_list_compare() | Compare two string lists
- * | mutt_list_find() | Find a string in a List
- * | mutt_list_free() | Free a List AND its strings
- * | mutt_list_insert_after() | Insert a string after a given ListNode
- * | mutt_list_insert_head() | Insert a string at the beginning of a List
- * | mutt_list_insert_tail() | Append a string to the end of a List
- * | mutt_list_match() | Is the string in the list (see notes)
*/
#include "config.h"
* @page mapping Map between a string and a constant
*
* Map a string to a constant and vice versa.
- *
- * | Function | Description
- * | :------------------- | :-------------------------------
- * | mutt_map_get_name() | Lookup a string for a constant
- * | mutt_map_get_value() | Lookup the constant for a string
*/
#include <stddef.h>
* @page mbyte Multi-byte String manipulation functions
*
* Some commonly-used multi-byte string manipulation routines.
- *
- * | Function | Description
- * | :----------------------------------- | :---------------------------------------------------------
- * | mutt_mb_charlen() | Count the bytes in a (multibyte) character
- * | mutt_mb_filter_unprintable() | Replace unprintable characters
- * | mutt_mb_get_initials() | Turn a name into initials
- * | mutt_mb_is_display_corrupting_utf8() | Will this character corrupt the display?
- * | mutt_mb_is_lower() | Does a multi-byte string contain only lowercase characters?
- * | mutt_mb_is_shell_char() | Is character not typically part of a pathname
- * | mutt_mb_mbstowcs() | Convert a string from multibyte to wide characters
- * | mutt_mb_wcstombs() | Convert a string from wide to multibyte characters
- * | mutt_mb_wcswidth() | Measure the screen width of a string
- * | mutt_mb_wcwidth() | Measure the screen width of a character
- * | mutt_mb_width() | Measure a string's display width (in screen columns)
- * | mutt_mb_width_ceiling() | Keep the end of the string on-screen
*/
#include "config.h"
* @page md5 Calculate the MD5 checksum of a buffer
*
* Calculate the MD5 cryptographic hash of a string, according to RFC1321.
- *
- * | Function | Description
- * | :----------------------- | :----------------------------------------------------
- * | mutt_md5() | Calculate the MD5 hash of a NULL-terminated string
- * | mutt_md5_buf() | Calculate the MD5 hash of a buffer
- * | mutt_md5_finish_ctx() | Process the remaining bytes in the buffer
- * | mutt_md5_init_ctx() | Initialise the MD5 computation
- * | mutt_md5_process() | Process a NULL-terminated string
- * | mutt_md5_process_block() | Process a block with MD5
- * | mutt_md5_process_bytes() | Process a block of data
- * | mutt_md5_read_ctx() | Read from the context into a buffer
- * | mutt_md5_toascii() | Convert a binary MD5 digest into ASCII Hexadecimal
*/
#include "config.h"
*
* @note If any of the allocators fail, the user is notified and the program is
* stopped immediately.
- *
- * | Function | Description
- * | :----------------- | :-----------------------------------
- * | mutt_mem_calloc() | Allocate zeroed memory on the heap
- * | mutt_mem_free() | Release memory allocated on the heap
- * | mutt_mem_malloc() | Allocate memory on the heap
- * | mutt_mem_realloc() | Resize a block of memory on the heap
*/
#include "config.h"
* Display informational messages for the user.
*
* These library stubs print the messages to stdout/stderr.
- *
- * | Function | Description
- * | :---------------- | :--------------------------------------------
- * | default_error() | Display an error message
- * | default_message() | Display an informative message
- * | default_perror() | Lookup a standard error message (using errno)
*/
#include "config.h"
* @page mime Constants and macros for managing MIME encoding
*
* Constants and macros for managing MIME encoding.
- *
- * | Data | Description
- * | :------------- | :--------------------------------------------------
- * | #BodyEncodings | Common MIME body encodings
- * | #BodyTypes | Common MIME body types
- * | #IndexHex | Lookup table for ASCII hex digits
- * | #MimeSpecials | Characters that need special treatment in MIME
*/
#include "config.h"
* @page parameter Store attributes associated with a MIME part
*
* Store attributes associated with a MIME part
- *
- * | Function | Description
- * | :---------------------- | :------------------------------
- * | mutt_param_cmp_strict() | Strictly compare two ParameterLists
- * | mutt_param_delete() | Delete a matching Parameter
- * | mutt_param_free() | Free a ParameterList
- * | mutt_param_free_one() | Free a Parameter
- * | mutt_param_get() | Find a matching Parameter
- * | mutt_param_new() | Create a new Parameter
- * | mutt_param_set() | Set a Parameter
*/
#include "config.h"
* @page regex Manage regular expressions
*
* Manage regular expressions.
- *
- * | Function | Description
- * | :------------------------ | :------------------------------------------
- * | mutt_regex_compile() | Create an Regex from a string
- * | mutt_regex_create() | Create an Regex from a string
- * | mutt_regex_free() | Free a Regex object
- * | mutt_regexlist_add() | Compile a regex string and add it to a list
- * | mutt_regexlist_free() | Free a RegexList object
- * | mutt_regexlist_match() | Does a string match any Regex in the list?
- * | mutt_regexlist_new() | Create a new RegexList
- * | mutt_regexlist_remove() | Remove a Regex from a list
- * | mutt_replacelist_add() | Add a pattern and a template to a list
- * | mutt_replacelist_apply() | Apply replacements to a buffer
- * | mutt_replacelist_free() | Free a ReplaceList object
- * | mutt_replacelist_match() | Does a string match a pattern?
- * | mutt_replacelist_new() | Create a new ReplaceList
- * | mutt_replacelist_remove() | Remove a pattern from a list
*/
#include "config.h"
* @page rfc2047 RFC2047 encoding / decoding functions
*
* RFC2047 MIME extensions encoding / decoding routines.
- *
- * | Function | Description
- * | :-------------------- | :-----------------------------------------
- * | mutt_rfc2047_decode() | Decode any RFC2047-encoded header fields
- * | mutt_rfc2047_encode() | RFC-2047-encode a string
*/
#include "config.h"
*
* Calculate the SHA1 cryptographic hash of a string, according to RFC3174.
*
- * | Function | Description
- * | :-------------------- | :----------------------------------------
- * | mutt_sha1_final() | Add padding and return the message digest
- * | mutt_sha1_init() | Initialize new context
- * | mutt_sha1_transform() | Hash a single 512-bit block
- * | mutt_sha1_update() | Run your data through this
- *
* Test Vectors (from FIPS PUB 180-1):
* - "abc" yields `A9993E36 4706816A BA3E2571 7850C26C 9CD0D89D`
* - "abcdbcdecdefdefgefghfghighijhijkijkljklmklmnlmnomnopnopq" yields `84983E44 1C3BD26E BAAE4AA1 F95129E5 E54670F1`
* @page signal Signal handling
*
* Signal handling
- *
- * | Function | Description
- * | :------------------------- | :---------------------------------------------------------
- * | mutt_sig_allow_interrupt() | Allow/disallow Ctrl-C (SIGINT)
- * | mutt_sig_block() | Block signals during critical operations
- * | mutt_sig_block_system() | Block signals before calling exec()
- * | mutt_sig_empty_handler() | Dummy signal handler
- * | mutt_sig_exit_handler() | Notify the user and shutdown gracefully
- * | mutt_sig_init() | Initialise the signal handling
- * | mutt_sig_unblock() | Restore previously blocked signals
- * | mutt_sig_unblock_system() | Restore previously blocked signals
*/
#include "config.h"
* @page string String manipulation functions
*
* Lots of commonly-used string manipulation routines.
- *
- * | Function | Description
- * | :---------------------------- | :---------------------------------------------------------
- * | mutt_str_adjust() | Shrink-to-fit a string
- * | mutt_str_append_item() | Add string to another separated by sep
- * | mutt_str_atoi() | Convert ASCII string to an integer
- * | mutt_str_atol() | Convert ASCII string to a long
- * | mutt_str_atos() | Convert ASCII string to a short
- * | mutt_str_atoui() | Convert ASCII string to an unsigned integer
- * | mutt_str_atoul() | Convert ASCII string to an unsigned long
- * | mutt_str_dequote_comment() | Un-escape characters in an email address comment
- * | mutt_str_find_word() | Find the next word (non-space)
- * | mutt_str_getenv() | Get an environment variable
- * | mutt_str_is_ascii() | Is a string ASCII (7-bit)?
- * | mutt_str_is_email_wsp() | Is this a whitespace character (for an email header)
- * | mutt_str_lws_len() | Measure the linear-white-space at the beginning of a string
- * | mutt_str_lws_rlen() | Measure the linear-white-space at the end of a string
- * | mutt_str_next_word() | Find the next word in a string
- * | mutt_str_pretty_size() | Display an abbreviated size, e.g. 3.4K
- * | mutt_str_remove_trailing_ws() | Trim trailing whitespace from a string
- * | mutt_str_replace() | Replace one string with another
- * | mutt_str_rstrnstr() | Find last instance of a substring
- * | mutt_str_skip_email_wsp() | Skip over whitespace as defined by RFC5322
- * | mutt_str_skip_whitespace() | Find the first non-whitespace character in a string
- * | mutt_str_strcasecmp() | Compare two strings ignoring case, safely
- * | mutt_str_strcat() | Concatenate two strings
- * | mutt_str_strchrnul() | Find first occurrence of character in string
- * | mutt_str_strcmp() | Compare two strings, safely
- * | mutt_str_strcoll() | Collate two strings (compare using locale), safely
- * | mutt_str_strdup() | Copy a string, safely
- * | mutt_str_strfcpy() | Copy a string into a buffer (guaranteeing NUL-termination)
- * | mutt_str_stristr() | Find first occurrence of string (ignoring case)
- * | mutt_str_strlen() | Calculate the length of a string, safely
- * | mutt_str_strlower() | convert all characters in the string to lowercase
- * | mutt_str_strncasecmp() | Compare two strings ignoring case (to a maximum), safely
- * | mutt_str_strncat() | Concatenate two strings
- * | mutt_str_strncmp() | Compare two strings (to a maximum), safely
- * | mutt_str_strnfcpy() | Copy a limited string into a buffer (guaranteeing NUL-termination)
- * | mutt_str_substr_cpy() | Copy a sub-string into a buffer
- * | mutt_str_substr_dup() | Duplicate a sub-string
- * | mutt_str_sysexit() | Return a string matching an error code
- * | mutt_str_word_casecmp() | Find word a in word list b
*/
#include "config.h"
}
/**
- * mutt_str_pretty_size - Display an abbreviated size, e.g. 3.4K
+ * mutt_str_pretty_size - Display an abbreviated size, like 3.4K
* @param buf Buffer for the result
* @param buflen Length of the buffer
* @param num Number to abbreviate
projects / neomutt / commitdiff