* @param a The message body containing the attachment
* @param flag Option flag for how the attachment should be viewed
* @param hdr Message header for the current message. Can be NULL
- * @param idx Attachment
- * @param idxlen Number of attachments
+ * @param actx Attachment context
* @retval 0 If the viewer is run and exited succesfully
* @retval -1 Error
* @retval n Return value of mutt_do_pager() when it is used
unsigned int decrypted : 1; /**< not part of message as stored in the hdr->content. */
};
+/**
+ * struct AttachCtx - A set of attachments
+ */
struct AttachCtx
{
struct Header *hdr; /**< used by recvattach for updating */
# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf.
-FILE_PATTERNS = *.c *.h *.wibble
+FILE_PATTERNS = *.c *.h
# The RECURSIVE tag can be used to specify whether or not subdirectories should
# be searched for input files as well.
# Note that relative paths are relative to the directory from which doxygen is
# run.
-EXCLUDE = doc pgpewrap.c pgppubring.c
+EXCLUDE = autosetup doc pgpewrap.c pgppubring.c
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
# directories that are symbolic links (a Unix file system feature) are excluded
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
-CALL_GRAPH = NO
+CALL_GRAPH = YES
# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
# dependency graph for every global function or class method.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
-CALLER_GRAPH = NO
+CALLER_GRAPH = YES
# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
# hierarchy of all classes instead of a textual one.
# The default value is: png.
# This tag requires that the tag HAVE_DOT is set to YES.
-DOT_IMAGE_FORMAT = png
+DOT_IMAGE_FORMAT = svg
# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
# enable generation of interactive SVG images that allow zooming and panning.
# Minimum value: 0, maximum value: 1000, default value: 0.
# This tag requires that the tag HAVE_DOT is set to YES.
-MAX_DOT_GRAPH_DEPTH = 0
+MAX_DOT_GRAPH_DEPTH = 1
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
# background. This is disabled by default, because dot on Windows does not seem
/**
* imap_commit_message_tags - Add/Change/Remove flags from headers
- * @param idata: pointer to a struct ImapData
- * @param h: pointer to a header struct
- *
+ * @param ctx Context
+ * @param h Header
+ * @param tags List of tags
* @retval 0 Success
* @retval -1 Error
*
/**
* km_dokey - Determine what a keypress should do
- * @retval >0 Function to execute
- * @retval #OP_NULL No function bound to key sequence
- * @retval -1 Error occurred while reading input
- * @retval -2 A timeout or sigwinch occurred
+ * @param menu Menu ID, e.g. #MENU_EDITOR
+ * @retval >0 Function to execute
+ * @retval OP_NULL No function bound to key sequence
+ * @retval -1 Error occurred while reading input
+ * @retval -2 A timeout or sigwinch occurred
*/
int km_dokey(int menu)
{
/**
* imap_parse_date - Parse date of the form: DD-MMM-YYYY HH:MM:SS +ZZzz
- * @param str Date in string form
+ * @param s Date in string form
* @retval 0 Error
* @retval time_t Unix time
*/
/**
* mutt_rename_file - Rename a file
- *
- * This function returns 0 on successful move, 1 on old file doesn't exist,
- * 2 on new file already exists, and 3 on other failure.
+ * @param oldfile Old filename
+ * @param newfile New filename
+ * @retval 0 Success
+ * @retval 1 Old file doesn't exist
+ * @retval 2 New file already exists
+ * @retval 3 Some other error
*
* note on access(2) use: No dangling symlink problems here due to
* safe_fopen().
#include "queue.h"
-STAILQ_HEAD(ListHead, ListNode);
+/**
+ * struct ListNode - A generic List node
+ */
struct ListNode
{
char *data;
STAILQ_ENTRY(ListNode) entries;
};
+STAILQ_HEAD(ListHead, ListNode);
static inline struct ListNode* mutt_list_insert_head(struct ListHead *h,
char *s)
/**
* struct ColorLine - A regular expression and a color to highlight a line
*/
-STAILQ_HEAD(ColorLineHead, ColorLine);
struct ColorLine
{
regex_t regex;
int pair;
STAILQ_ENTRY(ColorLine) entries;
};
+STAILQ_HEAD(ColorLineHead, ColorLine);
#define MUTT_PROGRESS_SIZE (1 << 0) /**< traffic-based progress */
#define MUTT_PROGRESS_MSG (1 << 1) /**< message-based progress */
struct UriTag *next;
};
-/*
+/**
* struct NmHdrData - Notmuch data attached to an email
*
* This stores all the Notmuch data associated with an email.
/**
* driver_tags_free - Free tags from a header
- * @param[in] head: pointer to the tags head
+ * @param[in] head List of tags
*
* Free the whole tags structure
*/
/**
* driver_tags_get_transformed - Get transformed tags
- * @param[in] head: pointer to the tags head
+ * @param head List of tags
+ * @param show_hidden Show hidden tags
+ * @param show_transformed Show transformed tags
+ * @param filter Match tags to this string
+ * @retval ptr String list of tags
*
* Return a new allocated string containing tags separated by space
*/
static char *driver_tags_getter(struct TagHead *head, bool show_hidden,
- bool show_tranformed, char *filter)
+ bool show_transformed, char *filter)
{
if (!head)
return NULL;
continue;
if (show_hidden || !np->hidden)
{
- if (show_tranformed && np->transformed)
+ if (show_transformed && np->transformed)
mutt_str_append_item(&tags, np->transformed, ' ');
else
mutt_str_append_item(&tags, np->name, ' ');
/**
* driver_tags_get_transformed - Get transformed tags
- * @param[in] head: pointer to the tags head
+ * @param[in] head List of tags
*
* Return a new allocated string containing all tags separated by space with
* transformation
/**
* driver_tags_get - Get tags
- * @param[in] head: pointer to the tags head
+ * @param[in] head List of tags
*
* Return a new allocated string containing all tags separated by space
*/
/**
* driver_tags_get_with_hidden - Get tags with hiddens
- * @param[in] head: pointer to the tags head
+ * @param[in] head List of tags
*
* Return a new allocated string containing all tags separated by space even
* the hiddens.
/**
* driver_tags_get_transformed_for - Get tranformed tag for a tag name from a header
- * @param[in] tag: char* to the tag to get the transformed version
- * @param[in] head: pointer to the tags head
+ * @param[in] name Tag to transform
+ * @param[in] head List of tags
*
* @return string tag
*
/**
* driver_tags_add - Add a tag to header
- * @param[in] head: pointer to the tags head
- * @param[in] new_tag: string representing the new tag
+ * @param[in] head List of tags
+ * @param[in] new_tag string representing the new tag
*
* Add a tag to the header tags
*/
/**
* driver_tags_replace - Replace all tags
- * @param[in] head: pointer to the tags head
- * @param[in] tags: string of all tags separated by space
+ * @param[in] head List of tags
+ * @param[in] tags string of all tags separated by space
*
* @retval 0 If no change are made
* @retval 1 If tags are updated
*
* @sa TagNode
*/
-
-STAILQ_HEAD(TagHead, TagNode);
struct TagNode
{
char *name;
bool hidden;
STAILQ_ENTRY(TagNode) entries;
};
+STAILQ_HEAD(TagHead, TagNode);
void driver_tags_free(struct TagHead *head);
char *driver_tags_get(struct TagHead *head);
*
* A type of a variable to keep track of registered crypto modules.
*/
-
-STAILQ_HEAD(CryptModules, CryptModule)
-modules = STAILQ_HEAD_INITIALIZER(modules);
struct CryptModule
{
struct CryptModuleSpecs *specs;
STAILQ_ENTRY(CryptModule) entries;
};
+STAILQ_HEAD(CryptModules, CryptModule)
+modules = STAILQ_HEAD_INITIALIZER(modules);
/**
* crypto_module_register - Register a new crypto module