Skip to content

Commit

Permalink
doxygen: drop tables
Browse files Browse the repository at this point in the history
These are now auto-generated from the function comments.
  • Loading branch information
flatcap committed Mar 13, 2018
1 parent 6579c3f commit abc39ce
Show file tree
Hide file tree
Showing 23 changed files with 3 additions and 326 deletions.
34 changes: 0 additions & 34 deletions mutt/address.c
Original file line number Diff line number Diff line change
Expand Up @@ -25,40 +25,6 @@
* @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"
Expand Down
9 changes: 0 additions & 9 deletions mutt/base64.c
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,6 @@
*
* @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"
Expand Down
14 changes: 0 additions & 14 deletions mutt/buffer.c
Original file line number Diff line number Diff line change
Expand Up @@ -25,20 +25,6 @@
* @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"
Expand Down
34 changes: 2 additions & 32 deletions mutt/charset.c
Original file line number Diff line number Diff line change
Expand Up @@ -24,36 +24,6 @@
* @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"
Expand All @@ -78,8 +48,8 @@
#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
Expand Down
13 changes: 0 additions & 13 deletions mutt/date.c
Original file line number Diff line number Diff line change
Expand Up @@ -24,19 +24,6 @@
* @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"
Expand Down
4 changes: 0 additions & 4 deletions mutt/debug.c
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,6 @@
* @page debug Debug messages
*
* Output debugging messages, suitable for a developer.
*
* | Function | Description
* | :---------------- | :--------------------------------
* | mutt_debug_real() | Output some debugging information
*/

#include "config.h"
Expand Down
4 changes: 0 additions & 4 deletions mutt/exit.c
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,6 @@
* @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"
Expand Down
37 changes: 0 additions & 37 deletions mutt/file.c
Original file line number Diff line number Diff line change
Expand Up @@ -24,43 +24,6 @@
* @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"
Expand Down
17 changes: 0 additions & 17 deletions mutt/hash.c
Original file line number Diff line number Diff line change
Expand Up @@ -25,23 +25,6 @@
* @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"
Expand Down
6 changes: 0 additions & 6 deletions mutt/idna.c
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,6 @@
* @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"
Expand Down
11 changes: 0 additions & 11 deletions mutt/list.c
Original file line number Diff line number Diff line change
Expand Up @@ -25,17 +25,6 @@
* @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"
Expand Down
5 changes: 0 additions & 5 deletions mutt/mapping.c
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,6 @@
* @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>
Expand Down
15 changes: 0 additions & 15 deletions mutt/mbyte.c
Original file line number Diff line number Diff line change
Expand Up @@ -24,21 +24,6 @@
* @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"
Expand Down
12 changes: 0 additions & 12 deletions mutt/md5.c
Original file line number Diff line number Diff line change
Expand Up @@ -25,18 +25,6 @@
* @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"
Expand Down
7 changes: 0 additions & 7 deletions mutt/memory.c
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,6 @@
*
* @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"
Expand Down
6 changes: 0 additions & 6 deletions mutt/message.c
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,6 @@
* 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"
Expand Down
7 changes: 0 additions & 7 deletions mutt/mime.c
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,6 @@
* @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"
Expand Down
10 changes: 0 additions & 10 deletions mutt/parameter.c
Original file line number Diff line number Diff line change
Expand Up @@ -24,16 +24,6 @@
* @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"
Expand Down
Loading

0 comments on commit abc39ce

Please sign in to comment.