]> granicus.if.org Git - neomutt/commitdiff
doxygen: add file templates
authorRichard Russon <rich@flatcap.org>
Wed, 12 Jul 2017 17:20:00 +0000 (18:20 +0100)
committerRichard Russon <rich@flatcap.org>
Mon, 17 Jul 2017 15:39:28 +0000 (16:39 +0100)
224 files changed:
account.c
account.h
addrbook.c
address.h
alias.c
alias.h
ascii.c
ascii.h
attach.c
attach.h
base64.c
bcache.c
bcache.h
body.h
browser.c
browser.h
buffer.c
buffer.h
buffy.c
buffy.h
charset.c
charset.h
color.c
commands.c
complete.c
compose.c
compress.c
compress.h
content.h
context.h
copy.c
copy.h
curs_lib.c
curs_main.c
date.c
doc/makedoc.c
doc/makedoc_defs.h
edit.c
editmsg.c
enter.c
enter_state.h
envelope.h
extlib.c
filter.c
filter.h
flags.c
format_flags.h
from.c
functions.h
getdomain.c
globals.h
group.c
group.h
handler.c
hash.c
hash.h
hcache/backend.h
hcache/bdb.c
hcache/gdbm.c
hcache/hcache.c
hcache/hcache.h
hcache/kc.c
hcache/lmdb.c
hcache/qdbm.c
hcache/tc.c
hdrline.c
header.h
headers.c
help.c
history.c
history.h
hook.c
imap/auth.c
imap/auth.h
imap/auth_anon.c
imap/auth_cram.c
imap/auth_gss.c
imap/auth_login.c
imap/auth_plain.c
imap/auth_sasl.c
imap/browse.c
imap/command.c
imap/imap.c
imap/imap.h
imap/imap_private.h
imap/message.c
imap/message.h
imap/utf7.c
imap/util.c
init.c
init.h
keymap.c
keymap.h
lib.c
lib.h
list.h
mailbox.h
main.c
mapping.h
mbox.c
mbyte.c
mbyte.h
mbyte_table.h
md5.c
md5.h
menu.c
mh.c
mime.h
mutt.h
mutt_commands.h
mutt_curses.h
mutt_idna.c
mutt_idna.h
mutt_lua.c
mutt_lua.h
mutt_menu.h
mutt_notmuch.c
mutt_notmuch.h
mutt_options.h
mutt_regex.h
mutt_sasl.c
mutt_sasl.h
mutt_sasl_plain.c
mutt_sasl_plain.h
mutt_socket.c
mutt_socket.h
mutt_ssl.c
mutt_ssl.h
mutt_ssl_gnutls.c
mutt_tunnel.c
mutt_tunnel.h
muttlib.c
mx.c
mx.h
myvar.h
ncrypt/crypt.c
ncrypt/crypt.h
ncrypt/crypt_gpgme.c
ncrypt/crypt_gpgme.h
ncrypt/crypt_mod.c
ncrypt/crypt_mod.h
ncrypt/crypt_mod_pgp_classic.c
ncrypt/crypt_mod_pgp_gpgme.c
ncrypt/crypt_mod_smime_classic.c
ncrypt/crypt_mod_smime_gpgme.c
ncrypt/cryptglue.c
ncrypt/cryptglue.h
ncrypt/gnupgparse.c
ncrypt/gnupgparse.h
ncrypt/ncrypt.h
ncrypt/pgp.c
ncrypt/pgp.h
ncrypt/pgpinvoke.c
ncrypt/pgpinvoke.h
ncrypt/pgpkey.c
ncrypt/pgpkey.h
ncrypt/pgplib.c
ncrypt/pgplib.h
ncrypt/pgpmicalg.c
ncrypt/pgpmicalg.h
ncrypt/pgppacket.c
ncrypt/pgppacket.h
ncrypt/smime.c
ncrypt/smime.h
newsrc.c
nntp.c
nntp.h
options.h
pager.c
pager.h
parameter.h
parse.c
pattern.c
pattern.h
pgpewrap.c
pgppubring.c
pop.c
pop.h
pop_auth.c
pop_lib.c
postpone.c
protos.h
query.c
recvattach.c
recvcmd.c
remailer.c
remailer.h
resize.c
rfc1524.c
rfc1524.h
rfc2047.c
rfc2047.h
rfc2231.c
rfc2231.h
rfc3676.c
rfc3676.h
rfc822.c
rfc822.h
safe_asprintf.c
score.c
send.c
sendlib.c
sha1.c
sha1.h
sidebar.c
sidebar.h
signal.c
smtp.c
sort.c
sort.h
state.h
status.c
system.c
thread.c
thread.h
txt2c.c
url.c
url.h
utf8.c
version.c
version.h
wcscasecmp.c
wcwidth.c
where.h

index 01cfc6bc91132e3054de17ec4f30080a4331cabb..6a7418cdddcc7f9b947ad0895f7bcb2d2f2d6905 100644 (file)
--- a/account.c
+++ b/account.c
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Account object used by POP and IMAP
+ *
+ * @authors
  * Copyright (C) 2000-2007 Brendan Cully <brendan@kublai.com>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 7988778300c50839fc4e6586150018f4aa6f8570..be781a52da3d6c77cf60cc88aed27ea59c52370c 100644 (file)
--- a/account.h
+++ b/account.h
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Account object used by POP and IMAP
+ *
+ * @authors
  * Copyright (C) 2000-2007,2012 Brendan Cully <brendan@kublai.com>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -18,7 +23,7 @@
 /* remote host account manipulation (POP/IMAP) */
 
 #ifndef _MUTT_ACCOUNT_H
-#define _MUTT_ACCOUNT_H 1
+#define _MUTT_ACCOUNT_H
 
 struct CissUrl;
 
index 712a1e23d862b70758f6ec6180a33937e80f634b..6310d80750010018fa4a118bd7e5d7e04a0fb6cc 100644 (file)
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Address book handling aliases
+ *
+ * @authors
  * Copyright (C) 1996-2000,2007 Michael R. Elkins <me@mutt.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 78304567e0b87f97a1b635e01abea54fe8c9f395..5a3afb5d4f038c17125043720105f848607f542a 100644 (file)
--- a/address.h
+++ b/address.h
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Representation of an email address
+ *
+ * @authors
  * Copyright (C) 2017 Richard Russon <rich@flatcap.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -16,7 +21,7 @@
  */
 
 #ifndef _MUTT_ADDRESS_H
-#define _MUTT_ADDRESS_H 1
+#define _MUTT_ADDRESS_H
 
 #include <stdbool.h>
 
diff --git a/alias.c b/alias.c
index 243348aee0b863b35f4288c54f6576fcc59727b6..ef8c87306743cf0dfbdb0522d6a62c89547af0d4 100644 (file)
--- a/alias.c
+++ b/alias.c
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Representation of a single alias to an email address
+ *
+ * @authors
  * Copyright (C) 1996-2002 Michael R. Elkins <me@mutt.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
diff --git a/alias.h b/alias.h
index 46480c68847d7a9312385023bac5023127ff2238..51739403cb829f2f10486782373420a36a16c036 100644 (file)
--- a/alias.h
+++ b/alias.h
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Representation of a single alias to an email address
+ *
+ * @authors
  * Copyright (C) 2017 Richard Russon <rich@flatcap.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -16,7 +21,7 @@
  */
 
 #ifndef _MUTT_ALIAS_H
-#define _MUTT_ALIAS_H 1
+#define _MUTT_ALIAS_H
 
 #include <stdbool.h>
 
diff --git a/ascii.c b/ascii.c
index 64b1e96b32c34718c545add9112a73d3d282babf..50dd09cf8d372b14ec678edd4b817130e0c21295 100644 (file)
--- a/ascii.c
+++ b/ascii.c
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * ASCII string comparison routines
+ *
+ * @authors
  * Copyright (C) 2001 Thomas Roessler <roessler@does-not-exist.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
diff --git a/ascii.h b/ascii.h
index 66b015e160d1c309829873578f77061e920e7259..f6e13df09bc09c82fea851cf4b26959d2f91c383 100644 (file)
--- a/ascii.h
+++ b/ascii.h
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * ASCII string comparison routines
+ *
+ * @authors
  * Copyright (C) 2001-2002 Thomas Roessler <roessler@does-not-exist.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -21,7 +26,7 @@
  */
 
 #ifndef _MUTT_ASCII_H
-#define _MUTT_ASCII_H 1
+#define _MUTT_ASCII_H
 
 #include <ctype.h>
 
index 4be58622e25ca930dbd3ac8914e3b263be82fc93..7d4377bc24ed39d6f9ec983ea7e1516dd6e056e0 100644 (file)
--- a/attach.c
+++ b/attach.c
@@ -1,7 +1,12 @@
 /**
+ * @file
+ * Handling of email attachments
+ *
+ * @authors
  * Copyright (C) 1996-2000,2002,2013 Michael R. Elkins <me@mutt.org>
  * Copyright (C) 1999-2004,2006 Thomas Roessler <roessler@does-not-exist.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 3c10e26850c5850cf92142e5b43e6472a11b5a7d..254e52a8af5cc4474e2e86887265d339d3766840 100644 (file)
--- a/attach.h
+++ b/attach.h
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Handling of email attachments
+ *
+ * @authors
  * Copyright (C) 1996-2000 Michael R. Elkins <me@mutt.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -18,7 +23,7 @@
 /* common protos for compose / attach menus */
 
 #ifndef _MUTT_ATTACH_H
-#define _MUTT_ATTACH_H 1
+#define _MUTT_ATTACH_H
 
 #include <stdbool.h>
 #include <stdio.h>
index a82b35fba0840e393c9a3629d68135a361ccfc60..f160743e8f45d080d4430308c83e80fc457545e1 100644 (file)
--- a/base64.c
+++ b/base64.c
@@ -1,4 +1,9 @@
 /**
+ * @file
+ * Conversion to/from base64 encoding
+ *
+ * @authors
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 78a0c995003d140a0ec743289f337fb06afdc7a3..6d08cc5fe233c24287efe4624751aa818e50c943 100644 (file)
--- a/bcache.c
+++ b/bcache.c
@@ -1,7 +1,12 @@
 /**
+ * @file
+ * Body Caching - local copies of email bodies
+ *
+ * @authors
  * Copyright (C) 2006-2007,2009 Brendan Cully <brendan@kublai.com>
  * Copyright (C) 2006,2009 Rocco Rutte <pdmef@gmx.net>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 8b4e3c1d7b256e43026ee8dbed5a72ab8c6cbe17..ef305d4d62c78dedd32c1b275f88a4aa96dc2d86 100644 (file)
--- a/bcache.h
+++ b/bcache.h
@@ -1,7 +1,12 @@
 /**
+ * @file
+ * Body Caching - local copies of email bodies
+ *
+ * @authors
  * Copyright (C) 2006-2007 Brendan Cully <brendan@kublai.com>
  * Copyright (C) 2006 Rocco Rutte <pdmef@gmx.net>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -17,7 +22,7 @@
  */
 
 #ifndef _MUTT_BCACHE_H
-#define _MUTT_BCACHE_H 1
+#define _MUTT_BCACHE_H
 
 #include <stdio.h>
 
diff --git a/body.h b/body.h
index 5e2bc039da6686a6c0df0cf55b11b2342927c70b..affa384e098b84fbe2f517461818deb363b8f4ff 100644 (file)
--- a/body.h
+++ b/body.h
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Representation of the body of an email
+ *
+ * @authors
  * Copyright (C) 2017 Richard Russon <rich@flatcap.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -16,7 +21,7 @@
  */
 
 #ifndef _MUTT_BODY_H
-#define _MUTT_BODY_H 1
+#define _MUTT_BODY_H
 
 #include <stdbool.h>
 #include <time.h>
index bacd60ecfe2c94169649bcc7839dfc2f9efa8488..cda97db454a2076b892ed45ee4da67529f328e19 100644 (file)
--- a/browser.c
+++ b/browser.c
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * GUI component for displaying/selecting items from a list
+ *
+ * @authors
  * Copyright (C) 1996-2000,2007,2010,2013 Michael R. Elkins <me@mutt.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 8a5443daf26f7134650a7b4a749a63afe289bdc9..a51f0af88b860b7eb57f7c19dfa2f7d801793a24 100644 (file)
--- a/browser.h
+++ b/browser.h
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * GUI component for displaying/selecting items from a list
+ *
+ * @authors
  * Copyright (C) 1996-2000 Michael R. Elkins <me@mutt.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -16,7 +21,7 @@
  */
 
 #ifndef _MUTT_BROWSER_H
-#define _MUTT_BROWSER_H 1
+#define _MUTT_BROWSER_H
 
 #include <stdbool.h>
 #include <sys/types.h>
index 7c28abf0b8a60379afed5fec5edc65764d836d2f..de9f0a210cb4fe99520cce2deef4c16cf1f3f9f5 100644 (file)
--- a/buffer.c
+++ b/buffer.c
@@ -1,4 +1,9 @@
 /**
+ * @file
+ * General purpose object for storing and parsing strings
+ *
+ * @authors
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 2d3384e5d7e23859035627e9b3777134d63edd0f..38bd3e762eb0b9c5a982597dcbf6553e0cb4590f 100644 (file)
--- a/buffer.h
+++ b/buffer.h
@@ -1,4 +1,9 @@
 /**
+ * @file
+ * General purpose object for storing and parsing strings
+ *
+ * @authors
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -14,7 +19,7 @@
  */
 
 #ifndef _MUTT_BUFFER_H
-#define _MUTT_BUFFER_H 1
+#define _MUTT_BUFFER_H
 
 #include <stddef.h>
 
diff --git a/buffy.c b/buffy.c
index a0d196ea9ea8a730b943dcb46f7cc2697640fedd..e3e747cf480dfd69d0c155418d7a82db34a61207 100644 (file)
--- a/buffy.c
+++ b/buffy.c
@@ -1,7 +1,12 @@
 /**
+ * @file
+ * Representation of a mailbox
+ *
+ * @authors
  * Copyright (C) 1996-2000,2010,2013 Michael R. Elkins <me@mutt.org>
  * Copyright (C) 2016 Kevin J. McCarthy <kevin@8t8.us>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
diff --git a/buffy.h b/buffy.h
index a4b0ff7ea053ac80ad781aa8e3eea77e1150aa4f..4a36231cabb48fa0d0c9602d262c406ee2462b7a 100644 (file)
--- a/buffy.h
+++ b/buffy.h
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Representation of a mailbox
+ *
+ * @authors
  * Copyright (C) 1996-2000,2010,2013 Michael R. Elkins <me@mutt.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -16,7 +21,7 @@
  */
 
 #ifndef _MUTT_BUFFY_H
-#define _MUTT_BUFFY_H 1
+#define _MUTT_BUFFY_H
 
 #include <limits.h>
 #include <stdbool.h>
index 69683bcb6f36f0403e672e4ddf43f8a6b5c50958..e8b09da29f37fd1a85c9f181ef89a142508b0e08 100644 (file)
--- a/charset.c
+++ b/charset.c
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Conversion between different character encodings
+ *
+ * @authors
  * Copyright (C) 1999-2002,2007 Thomas Roessler <roessler@does-not-exist.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 492986de1d44a7c7d068013cf436ef528681318e..61725ef4244203718c2290113dd85370b27c3ed8 100644 (file)
--- a/charset.h
+++ b/charset.h
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Conversion between different character encodings
+ *
+ * @authors
  * Copyright (C) 1999-2003 Thomas Roessler <roessler@does-not-exist.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -16,7 +21,7 @@
  */
 
 #ifndef _MUTT_CHARSET_H
-#define _MUTT_CHARSET_H 1
+#define _MUTT_CHARSET_H
 
 #include <iconv.h>
 #include <stdbool.h>
diff --git a/color.c b/color.c
index ab9c50e6ce6ea1da2ec5ec9075dee78946a9cc77..5fc852bc02262f26b4706c3628c862f2939d853a 100644 (file)
--- a/color.c
+++ b/color.c
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Color and attribute parsing
+ *
+ * @authors
  * Copyright (C) 1996-2002,2012 Michael R. Elkins <me@mutt.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 5fbc09340ffe8f9173d616f2836a6cc82f4cddd5..def93158666361d0913627bf9e63bffb7c4db463 100644 (file)
@@ -1,7 +1,12 @@
 /**
+ * @file
+ * Manage where the email is piped to external commands
+ *
+ * @authors
  * Copyright (C) 1996-2000 Michael R. Elkins <me@mutt.org>
  * Copyright (C) 2000-2004,2006 Thomas Roessler <roessler@does-not-exist.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 73791e180b442ad78937ac3d19ce9932343d270b..570eb478ac1bfd1bbb2bb5ad147c672ce551c443 100644 (file)
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * String auto-completion routines
+ *
+ * @authors
  * Copyright (C) 1996-2000,2007 Michael R. Elkins <me@mutt.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index ad186e9e8ff38068bcbca499466d5d0873682180..3554542e6e99a723d46d32f5a41db03c23fd7310 100644 (file)
--- a/compose.c
+++ b/compose.c
@@ -1,7 +1,12 @@
 /**
+ * @file
+ * GUI editor for an email's headers
+ *
+ * @authors
  * Copyright (C) 1996-2000,2002,2007,2010,2012 Michael R. Elkins <me@mutt.org>
  * Copyright (C) 2004 g10 Code GmbH
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 48ed1bd346acc9a2cac3146f0e87fed1530199dd..e510add098c59c22dfb2736c081453f05560205e 100644 (file)
@@ -1,7 +1,12 @@
 /**
+ * @file
+ * Compressed mbox local mailbox type
+ *
+ * @authors
  * Copyright (C) 1997 Alain Penders <Alain@Finale-Dev.com>
  * Copyright (C) 2016 Richard Russon <rich@flatcap.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 545714b0f8fd473e899eaab1668ee0bf1a7811b0..0b450bbc6c1624e035d945b49f911469ecb8b915 100644 (file)
@@ -1,7 +1,12 @@
 /**
+ * @file
+ * Compressed mbox local mailbox type
+ *
+ * @authors
  * Copyright (C) 1997 Alain Penders <Alain@Finale-Dev.com>
  * Copyright (C) 2016 Richard Russon <rich@flatcap.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -17,7 +22,7 @@
  */
 
 #ifndef _MUTT_COMPRESS_H
-#define _MUTT_COMPRESS_H 1
+#define _MUTT_COMPRESS_H
 
 #include <stdbool.h>
 #include "mx.h"
index 68fde9937fa618aef42555fb8cdf9797509db36a..82bed56d291a2857c19b841511361c01cacb07e3 100644 (file)
--- a/content.h
+++ b/content.h
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Information about the content of an attachment
+ *
+ * @authors
  * Copyright (C) 2017 Richard Russon <rich@flatcap.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -16,7 +21,7 @@
  */
 
 #ifndef _MUTT_CONTENT_H
-#define _MUTT_CONTENT_H 1
+#define _MUTT_CONTENT_H
 
 #include <stdbool.h>
 
index a13988520e9e0121c98c501e9f45323ab3d1fefa..0d6242485088d055950e247b62679aea6e02ef65 100644 (file)
--- a/context.h
+++ b/context.h
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * The "currently-open" mailbox
+ *
+ * @authors
  * Copyright (C) 2017 Richard Russon <rich@flatcap.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -16,7 +21,7 @@
  */
 
 #ifndef _MUTT_CONTEXT_H
-#define _MUTT_CONTEXT_H 1
+#define _MUTT_CONTEXT_H
 
 #include <stdbool.h>
 #include <stdio.h>
diff --git a/copy.c b/copy.c
index 608f56522b5fd2c3f0ba47206db00aae151a236b..54f681390c6ac47e834b7d216f11d72221bb24ed 100644 (file)
--- a/copy.c
+++ b/copy.c
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Duplicate the structure of an entire email
+ *
+ * @authors
  * Copyright (C) 1996-2000,2002,2014 Michael R. Elkins <me@mutt.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
diff --git a/copy.h b/copy.h
index 2cb794e2af1ff29e1d9d0bdfaaded81212e51028..f81af7994055128293da46b5e78d40e3e8b7205a 100644 (file)
--- a/copy.h
+++ b/copy.h
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Duplicate the structure of an entire email
+ *
+ * @authors
  * Copyright (C) 1996-2000 Michael R. Elkins <me@mutt.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -16,7 +21,7 @@
  */
 
 #ifndef _MUTT_COPY_H
-#define _MUTT_COPY_H 1
+#define _MUTT_COPY_H
 
 #include <stdio.h>
 
index 92d9167df17c1a5ac52d463c9d668f491e25f02d..7da43d499ee2b9210532fe38651ee770b29a79bd 100644 (file)
@@ -1,7 +1,12 @@
 /**
+ * @file
+ * GUI miscellaneous curses (window drawing) routines
+ *
+ * @authors
  * Copyright (C) 1996-2002,2010,2012-2013 Michael R. Elkins <me@mutt.org>
  * Copyright (C) 2004 g10 Code GmbH
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 67c11cecbd29824093199be76984cdfe65d06dc2..e0f707ff85f545e4d85df4b9f1b98e9d5b033267 100644 (file)
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * GUI manage the main index (list of emails)
+ *
+ * @authors
  * Copyright (C) 1996-2000,2002,2010,2012-2013 Michael R. Elkins <me@mutt.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
diff --git a/date.c b/date.c
index b7573a639b628d047a00c7092fe0263bc48bf81f..edc659c40ecc7bf2e196cabc49c9e72d93cfe444 100644 (file)
--- a/date.c
+++ b/date.c
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Time and date handling routines
+ *
+ * @authors
  * Copyright (C) 1996-2000 Michael R. Elkins <me@mutt.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 983a1f87243e5a5031a82a0a933f2c17e2872e16..7b481e8929148be7678f0420df704f264388342e 100644 (file)
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Read nroff-like comments in the code and convert them into documentation
+ *
+ * @authors
  * Copyright (C) 1999-2000 Thomas Roessler <roessler@does-not-exist.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 2d293b4a4ac41250d43e1b2b64c7ae6801e57c6d..66bea830caa58a8e84a10d3996e9f57f9e39979d 100644 (file)
@@ -1,4 +1,9 @@
 /**
+ * @file
+ * Helper for makedoc to enable all code paths
+ *
+ * @authors
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -16,7 +21,7 @@
 /* build complete documentation */
 
 #ifndef _MUTT_MAKEDOC_DEFS_H
-#define _MUTT_MAKEDOC_DEFS_H 1
+#define _MUTT_MAKEDOC_DEFS_H
 
 #ifdef MAKEDOC_FULL
 #ifndef CRYPT_BACKEND_GPGME
diff --git a/edit.c b/edit.c
index 8364d3e54bda45c5605efe6a951d0c5f52c3f2c5..f71f58d24e0ca08d67d20569d4e8ba1d326c9bc6 100644 (file)
--- a/edit.c
+++ b/edit.c
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * GUI basic built-in text editor
+ *
+ * @authors
  * Copyright (C) 1996-2000 Michael R. Elkins <me@mutt.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 6d5cc1f8d4885a6d498108358e1e9cced05831e3..eb6e7ab298e706716dd27d3d9508cb07b2ba1b58 100644 (file)
--- a/editmsg.c
+++ b/editmsg.c
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Prepare an email to be edited
+ *
+ * @authors
  * Copyright (C) 1999-2002 Thomas Roessler <roessler@does-not-exist.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
diff --git a/enter.c b/enter.c
index f930067af83b1c6f2e881f4a25cd23edf60acc72..c71fe669762ec28a1e19ba9c668b6134a21faece 100644 (file)
--- a/enter.c
+++ b/enter.c
@@ -1,7 +1,12 @@
 /**
+ * @file
+ * GUI ask the user to enter a string
+ *
+ * @authors
  * Copyright (C) 1996-2000,2007,2011,2013 Michael R. Elkins <me@mutt.org>
  * Copyright (C) 2000-2001 Edmund Grimley Evans <edmundo@rano.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index a1fc46bb6ed4d322a451f954573da929070e0e1d..1218905bbbfc182d709f70deddd1888a7f8247b1 100644 (file)
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Struct to store the cursor position when entering text
+ *
+ * @authors
  * Copyright (C) 2017 Richard Russon <rich@flatcap.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -16,7 +21,7 @@
  */
 
 #ifndef _MUTT_ENTER_STATE_H
-#define _MUTT_ENTER_STATE_H 1
+#define _MUTT_ENTER_STATE_H
 
 #include <stddef.h>
 #include "lib.h"
index 6f585b99573faf29b6a1f12595bc829c638e2ee1..47c3f7c8d75d65b168ec5077fa50e637758bd333 100644 (file)
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Representation of an email header (envelope)
+ *
+ * @authors
  * Copyright (C) 2017 Richard Russon <rich@flatcap.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -16,7 +21,7 @@
  */
 
 #ifndef _MUTT_ENVELOPE_H
-#define _MUTT_ENVELOPE_H 1
+#define _MUTT_ENVELOPE_H
 
 #include <stdbool.h>
 #include "lib.h"
index 5d3913a46a467e2a309121e200d0cdb6bdacea01..58f7cc9aebaac4b1765a3f817714ff2d1069dc2e 100644 (file)
--- a/extlib.c
+++ b/extlib.c
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Helper function for standalone tools
+ *
+ * @authors
  * Copyright (C) 1999-2000 Thomas Roessler <roessler@does-not-exist.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 0354310a9ffa5dfe54d34ef25b9f254e8b5cf735..d3538141db8329c7c4dd39783c60e8bd05dc328c 100644 (file)
--- a/filter.c
+++ b/filter.c
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Pass files through external commands (filters)
+ *
+ * @authors
  * Copyright (C) 1996-2000 Michael R. Elkins.
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index ee44ed4b56991ddaf7770d9f330c670481603bfa..cae9952069929ca403e665bea0c61c18fc52095d 100644 (file)
--- a/filter.h
+++ b/filter.h
@@ -1,4 +1,9 @@
 /**
+ * @file
+ * Pass files through external commands (filters)
+ *
+ * @authors
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -14,7 +19,7 @@
  */
 
 #ifndef _MUTT_FILTER_H
-#define _MUTT_FILTER_H 1
+#define _MUTT_FILTER_H
 
 #include <stdio.h>
 #include <unistd.h>
diff --git a/flags.c b/flags.c
index 218cabbbceeda2f00668a91945392161a4b48ace..1441583815c4d6dd7f6ea372dd7d25e568a304b2 100644 (file)
--- a/flags.c
+++ b/flags.c
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Manipulate the flags in an email header
+ *
+ * @authors
  * Copyright (C) 1996-2000 Michael R. Elkins <me@mutt.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index bde6212376ad4c64be78542a4afbca8b8cefea3f..f6c3702c4dca49e704d2cc773669413cafeb10e8 100644 (file)
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Flags to control mutt_FormatString()
+ *
+ * @authors
  * Copyright (C) 2017 Richard Russon <rich@flatcap.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -16,7 +21,7 @@
  */
 
 #ifndef _MUTT_FORMAT_FLAGS_H
-#define _MUTT_FORMAT_FLAGS_H 1
+#define _MUTT_FORMAT_FLAGS_H
 
 #include <stddef.h>
 
diff --git a/from.c b/from.c
index d5a97c1d8c8e1d5044297f689564a695a45b1c11..f995bf7b26daed46fe6561b855a98074d43c8c55 100644 (file)
--- a/from.c
+++ b/from.c
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Determine who the email is from
+ *
+ * @authors
  * Copyright (C) 1996-2000,2013 Michael R. Elkins <me@mutt.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 11c915d52f29e81b4c42793cbe1377e5062ba957..80f1f387f802f8174a5d98ad057fa8a5cf7e02a1 100644 (file)
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Definitions of user functions
+ *
+ * @authors
  * Copyright (C) 1996-2000,2002 Michael R. Elkins <me@mutt.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -16,7 +21,7 @@
  */
 
 #ifndef _MUTT_FUNCTIONS_H
-#define _MUTT_FUNCTIONS_H 1
+#define _MUTT_FUNCTIONS_H
 
 /*
  * This file contains the structures needed to parse ``bind'' commands, as
index 79cb81183a86efcb51887cc60f8ff497a4ddd5f2..a868e40a30fbed10b9455dfc622e9c3714e90a70 100644 (file)
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * DNS lookups
+ *
+ * @authors
  * Copyright (C) 2009,2013,2016 Derek Martin <code@pizzashack.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index e362a9c4abee88e94f0e386946a0d8dbdda85dbf..dc8b8d83f9830947c70e00b3143b6f8e74c108af 100644 (file)
--- a/globals.h
+++ b/globals.h
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Hundreds of global variables to back the user variables
+ *
+ * @authors
  * Copyright (C) 1996-2002,2010,2016 Michael R. Elkins <me@mutt.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -16,7 +21,7 @@
  */
 
 #ifndef _MUTT_GLOBALS_H
-#define _MUTT_GLOBALS_H 1
+#define _MUTT_GLOBALS_H
 
 #include <signal.h>
 #include "lib.h"
diff --git a/group.c b/group.c
index e27cd9bc3b72826c9d764f4176a1e451b4338a97..2d5b19ce1aa3519fd81a7310a2b0a7bbebdc6607 100644 (file)
--- a/group.c
+++ b/group.c
@@ -1,7 +1,12 @@
 /**
+ * @file
+ * Handling for email address groups
+ *
+ * @authors
  * Copyright (C) 2006 Thomas Roessler <roessler@does-not-exist.org>
  * Copyright (C) 2009 Rocco Rutte <pdmef@gmx.net>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
diff --git a/group.h b/group.h
index 1d509ea915e0aaca663dbdcdb191b21c3635a053..4ff4a43ef8128a17748b82d5567c2a983ea48db4 100644 (file)
--- a/group.h
+++ b/group.h
@@ -1,7 +1,12 @@
 /**
+ * @file
+ * Handling for email address groups
+ *
+ * @authors
  * Copyright (C) 2006 Thomas Roessler <roessler@does-not-exist.org>
  * Copyright (C) 2009 Rocco Rutte <pdmef@gmx.net>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -17,7 +22,7 @@
  */
 
 #ifndef _MUTT_GROUP_H
-#define _MUTT_GROUP_H 1
+#define _MUTT_GROUP_H
 
 #include <stdbool.h>
 
index 6848e2b2f8ac92827bf97d00d5cdc66efbb8fe63..e215f925068b4bf74bae9c033777b198044698d3 100644 (file)
--- a/handler.c
+++ b/handler.c
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Decide how to display email content
+ *
+ * @authors
  * Copyright (C) 1996-2000,2002,2010,2013 Michael R. Elkins <me@mutt.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
diff --git a/hash.c b/hash.c
index c920450bc1d70ca37334ae000c1db723dc91205d..76a5cc85642e6263849a83a43c119ad01d9b46c5 100644 (file)
--- a/hash.c
+++ b/hash.c
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Hash table data structure
+ *
+ * @authors
  * Copyright (C) 1996-2009 Michael R. Elkins <me@mutt.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
diff --git a/hash.h b/hash.h
index 6cef52ec86ab247e65e54069c17973f090e77b25..775741e8f5567e79e26b877f84a112d740ed9f8c 100644 (file)
--- a/hash.h
+++ b/hash.h
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Hash table data structure
+ *
+ * @authors
  * Copyright (C) 1996-2009 Michael R. Elkins <me@mutt.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -16,7 +21,7 @@
  */
 
 #ifndef _MUTT_HASH_H
-#define _MUTT_HASH_H 1
+#define _MUTT_HASH_H
 
 #include <stdbool.h>
 
index a84c29d11a501e38b61ec48bc677a9cff982ef8b..362cec54386e7a138ed6465357760318fe695894 100644 (file)
@@ -1,9 +1,14 @@
 /**
+ * @file
+ * API for the header cache
+ *
+ * @authors
  * Copyright (C) 2004 Thomas Glanzmann <sithglan@stud.uni-erlangen.de>
  * Copyright (C) 2004 Tobias Werth <sitowert@stud.uni-erlangen.de>
  * Copyright (C) 2004 Brian Fundakowski Feldman <green@FreeBSD.org>
  * Copyright (C) 2016 Pietro Cerutti <gahr@gahr.ch>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -19,7 +24,7 @@
  */
 
 #ifndef _MUTT_HCACHE_BACKEND_H
-#define _MUTT_HCACHE_BACKEND_H 1
+#define _MUTT_HCACHE_BACKEND_H
 
 #include <stdlib.h>
 
index f6e74853ea06b8f6ba0943171b371038848f7dd7..b8c88fb5e987a3ede36ed8ecdb2db0a0f4d75728 100644 (file)
@@ -1,9 +1,14 @@
 /**
+ * @file
+ * Berkeley DB backend for the header cache
+ *
+ * @authors
  * Copyright (C) 2004 Thomas Glanzmann <sithglan@stud.uni-erlangen.de>
  * Copyright (C) 2004 Tobias Werth <sitowert@stud.uni-erlangen.de>
  * Copyright (C) 2004 Brian Fundakowski Feldman <green@FreeBSD.org>
  * Copyright (C) 2016 Pietro Cerutti <gahr@gahr.ch>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index db527d8050e12cd40cf0fa16a4be16e403b6ceb4..ae3444f6f7e6d691ebc05f5560a0e249e1fc4c6a 100644 (file)
@@ -1,9 +1,14 @@
 /**
+ * @file
+ * GDMB backend for the header cache
+ *
+ * @authors
  * Copyright (C) 2004 Thomas Glanzmann <sithglan@stud.uni-erlangen.de>
  * Copyright (C) 2004 Tobias Werth <sitowert@stud.uni-erlangen.de>
  * Copyright (C) 2004 Brian Fundakowski Feldman <green@FreeBSD.org>
  * Copyright (C) 2016 Pietro Cerutti <gahr@gahr.ch>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 08d8e891e29dd27e60f81e64c36a11d00ecde6ad..745f57cce6440ca2009aeb4efc7ddd7d7771b18c 100644 (file)
@@ -1,9 +1,14 @@
 /**
+ * @file
+ * Header cache multiplexor
+ *
+ * @authors
  * Copyright (C) 2004 Thomas Glanzmann <sithglan@stud.uni-erlangen.de>
  * Copyright (C) 2004 Tobias Werth <sitowert@stud.uni-erlangen.de>
  * Copyright (C) 2004 Brian Fundakowski Feldman <green@FreeBSD.org>
  * Copyright (C) 2016 Pietro Cerutti <gahr@gahr.ch>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index df82464ad0c86184376188abf543d2fef945d968..315c7fbb08c68be5b1ec0337c25c1d27c2f1cf84 100644 (file)
@@ -1,9 +1,14 @@
 /**
+ * @file
+ * Header cache multiplexor
+ *
+ * @authors
  * Copyright (C) 2004 Thomas Glanzmann <sithglan@stud.uni-erlangen.de>
  * Copyright (C) 2004 Tobias Werth <sitowert@stud.uni-erlangen.de>
  * Copyright (C) 2004 Brian Fundakowski Feldman <green@FreeBSD.org>
  * Copyright (C) 2016 Pietro Cerutti <gahr@gahr.ch>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -19,7 +24,7 @@
  */
 
 #ifndef _MUTT_HCACHE_H
-#define _MUTT_HCACHE_H 1
+#define _MUTT_HCACHE_H
 
 #include <stddef.h>
 
index 08be9be88907fd40dd59c9970d7c78c06d7025dc..888c953043905decfaf329ba9bc065c3511ad73b 100644 (file)
@@ -1,9 +1,14 @@
 /**
+ * @file
+ * Kyotocabinet DB backend for the header cache
+ *
+ * @authors
  * Copyright (C) 2004 Thomas Glanzmann <sithglan@stud.uni-erlangen.de>
  * Copyright (C) 2004 Tobias Werth <sitowert@stud.uni-erlangen.de>
  * Copyright (C) 2004 Brian Fundakowski Feldman <green@FreeBSD.org>
  * Copyright (C) 2016 Pietro Cerutti <gahr@gahr.ch>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 69e56d92dd95c0b941dcfe983962bd448c011a99..8aadb179b620ace54225938fc572c67c9b0c893c 100644 (file)
@@ -1,9 +1,14 @@
 /**
+ * @file
+ * LMDB backend for the header cache
+ *
+ * @authors
  * Copyright (C) 2004 Thomas Glanzmann <sithglan@stud.uni-erlangen.de>
  * Copyright (C) 2004 Tobias Werth <sitowert@stud.uni-erlangen.de>
  * Copyright (C) 2004 Brian Fundakowski Feldman <green@FreeBSD.org>
  * Copyright (C) 2016 Pietro Cerutti <gahr@gahr.ch>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 609fdd670160fb31073b61fc4c539902025418ea..5cd1427a57a75ad12006a38118b7156ffa230f4b 100644 (file)
@@ -1,9 +1,14 @@
 /**
+ * @file
+ * QDBM backend for the header cache
+ *
+ * @authors
  * Copyright (C) 2004 Thomas Glanzmann <sithglan@stud.uni-erlangen.de>
  * Copyright (C) 2004 Tobias Werth <sitowert@stud.uni-erlangen.de>
  * Copyright (C) 2004 Brian Fundakowski Feldman <green@FreeBSD.org>
  * Copyright (C) 2016 Pietro Cerutti <gahr@gahr.ch>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index c7040648da25ee971a98801d11658f33e207c39d..5354211e50b8f02bfe0f86d5ea896c42f2073dd0 100644 (file)
@@ -1,9 +1,14 @@
 /**
+ * @file
+ * Tokyocabinet DB backend for the header cache
+ *
+ * @authors
  * Copyright (C) 2004 Thomas Glanzmann <sithglan@stud.uni-erlangen.de>
  * Copyright (C) 2004 Tobias Werth <sitowert@stud.uni-erlangen.de>
  * Copyright (C) 2004 Brian Fundakowski Feldman <green@FreeBSD.org>
  * Copyright (C) 2016 Pietro Cerutti <gahr@gahr.ch>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 4bf0d41bcf68562a1b1cbffce0cca77429fde140..bcb9c66de05705c5837b20f36ec8776de8bd588f 100644 (file)
--- a/hdrline.c
+++ b/hdrline.c
@@ -1,8 +1,13 @@
 /**
+ * @file
+ * String processing routines to generate the mail index
+ *
+ * @authors
  * Copyright (C) 1996-2000,2002,2007 Michael R. Elkins <me@mutt.org>
  * Copyright (C) 2016 Richard Russon <rich@flatcap.org>
  * Copyright (C) 2016 Ian Zimmerman <itz@primate.net>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 8ec185959e614f64ca89407a6f7c26b619bb539e..e683402392ccb4f588afed73f98243c5ba9491f5 100644 (file)
--- a/header.h
+++ b/header.h
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Representation of the email's header
+ *
+ * @authors
  * Copyright (C) 2017 Richard Russon <rich@flatcap.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -16,7 +21,7 @@
  */
 
 #ifndef _MUTT_HEADER_H
-#define _MUTT_HEADER_H 1
+#define _MUTT_HEADER_H
 
 #include <stddef.h>
 #include <stdbool.h>
index 15a5b04f06c3c369afe0454e99080abb416e7b0c..4b275a74d2e62fee09437cc850a87215fe2e93c4 100644 (file)
--- a/headers.c
+++ b/headers.c
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Manipulate an email's header
+ *
+ * @authors
  * Copyright (C) 1996-2009,2012 Michael R. Elkins <me@mutt.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
diff --git a/help.c b/help.c
index 3710adc693e46744be0a8bfdb05db52e944ec475..d834fd597815753f170457e7cae6b17967204c4a 100644 (file)
--- a/help.c
+++ b/help.c
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Generate the help-line and help-page and GUI display them
+ *
+ * @authors
  * Copyright (C) 1996-2000,2009 Michael R. Elkins <me@mutt.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index f4d67530d37e74116fa721ae99af9d0559d2fddb..147e4824ab6e1b60e4ac8aba85950ad9f2faf09f 100644 (file)
--- a/history.c
+++ b/history.c
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Read/write command history from/to a file
+ *
+ * @authors
  * Copyright (C) 1996-2000 Michael R. Elkins <me@mutt.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index e3d5eb0385ae225f463604d1cb0befa9eca4c40e..746bcd30b8c172f03e233bac7f835b32091a7544 100644 (file)
--- a/history.h
+++ b/history.h
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Read/write command history from/to a file
+ *
+ * @authors
  * Copyright (C) 1996-2000 Michael R. Elkins <me@mutt.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -16,7 +21,7 @@
  */
 
 #ifndef _MUTT_HISTORY_H
-#define _MUTT_HISTORY_H 1
+#define _MUTT_HISTORY_H
 
 enum HistoryClass
 {
diff --git a/hook.c b/hook.c
index a8f205e9abcab44bbf0e0c30ea9ff76d03de9085..57bb7064a79e151c4310624e6bb5700860ff1963 100644 (file)
--- a/hook.c
+++ b/hook.c
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Parse and execute user-defined hooks
+ *
+ * @authors
  * Copyright (C) 1996-2002,2004,2007 Michael R. Elkins <me@mutt.org>, and others
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 6bd2cf8d6c32b629e9a1a254480a83af51d0703f..fe981d897aff6c872a65e6cc7744ed49815f2d67 100644 (file)
@@ -1,8 +1,13 @@
 /**
+ * @file
+ * IMAP authenticator multiplexor
+ *
+ * @authors
  * Copyright (C) 1996-1998 Michael R. Elkins <me@mutt.org>
  * Copyright (C) 1996-1999 Brandon Long <blong@fiction.net>
  * Copyright (C) 1999-2001 Brendan Cully <brendan@kublai.com>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index baf2d85f5e50399aad361dbe28005b03857d9bc7..e7c8604cf2bf9fc59d8407c860f35e537c9c61bf 100644 (file)
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * IMAP authenticator multiplexor
+ *
+ * @authors
  * Copyright (C) 2000-2001 Brendan Cully <brendan@kublai.com>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -19,7 +24,7 @@
  * system */
 
 #ifndef _MUTT_IMAP_AUTH_H
-#define _MUTT_IMAP_AUTH_H 1
+#define _MUTT_IMAP_AUTH_H
 
 struct ImapData;
 
index d7ec0503aae4f2d8410fc94f013db0c05565563a..375c8fe5684af118eedb894cfcd516f11bd3f929 100644 (file)
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * IMAP anonymous authentication method
+ *
+ * @authors
  * Copyright (C) 1999-2001,2005 Brendan Cully <brendan@kublai.com>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index f9af0c5fccd549ec8179a1278e8058c7e3da5ee0..59620f22c93cbb7e884d8c43a4a88b77843e8835 100644 (file)
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * IMAP CRAM-MD5 authentication method
+ *
+ * @authors
  * Copyright (C) 1999-2001,2005 Brendan Cully <brendan@kublai.com>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index c927860be7de5d9d333f302f651ce965793467be..bde009b29650cffa63bc5eea4ae710809bb583f0 100644 (file)
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * IMAP GSS authentication method
+ *
+ * @authors
  * Copyright (C) 1999-2001,2005,2009 Brendan Cully <brendan@kublai.com>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index e271aa1fdc76a3abfc19035ef6c5fa1938f986ca..e906cc300678b70e96551c0c8428853d9dcfa3c7 100644 (file)
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * IMAP login authentication method
+ *
+ * @authors
  * Copyright (C) 1999-2001,2005,2009 Brendan Cully <brendan@kublai.com>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 43147af1978245a1e9e6de9af06fd4e9da35eba6..a294dc60510038268524fe3ced940cd6c8a6cc7f 100644 (file)
@@ -1,7 +1,12 @@
 /**
+ * @file
+ * IMAP plain authentication method
+ *
+ * @authors
  * Copyright (C) 1999-2001,2005,2009 Brendan Cully <brendan@kublai.com>
  * Copyright (C) 2016 Pietro Cerutti <gahr@gahr.ch>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index fcfb16499fcf2bd55648e149e6018b323144b3ba..abd80ce9b3b2369e895c81b55453204ca5617e7a 100644 (file)
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * IMAP SASL authentication method
+ *
+ * @authors
  * Copyright (C) 2000-2006,2012 Brendan Cully <brendan@kublai.com>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 950bb16d2448cff4267de869bdc344070e22f457..1abf75f9296b4314a282a2850cc824e8fed18f43 100644 (file)
@@ -1,7 +1,12 @@
 /**
+ * @file
+ * GUI select an IMAP mailbox from a list
+ *
+ * @authors
  * Copyright (C) 1996-1999 Brandon Long <blong@fiction.net>
  * Copyright (C) 1999-2008 Brendan Cully <brendan@kublai.com>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 91924a9220b080d12b39ef7973fd21b266ad1f10..7a7b9e05ff08cca35e82e3d3998c89c7e74227dc 100644 (file)
@@ -1,8 +1,13 @@
 /**
+ * @file
+ * Send/receive commands to/from an IMAP server
+ *
+ * @authors
  * Copyright (C) 1996-1998,2010,2012 Michael R. Elkins <me@mutt.org>
  * Copyright (C) 1996-1999 Brandon Long <blong@fiction.net>
  * Copyright (C) 1999-2009,2011 Brendan Cully <brendan@kublai.com>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 9862a2273a0749835236c87da46866e893be2e49..b232404500396dc008c72be25877a965c7a59af3 100644 (file)
@@ -1,8 +1,13 @@
 /**
+ * @file
+ * IMAP network mailbox
+ *
+ * @authors
  * Copyright (C) 1996-1998,2012 Michael R. Elkins <me@mutt.org>
  * Copyright (C) 1996-1999 Brandon Long <blong@fiction.net>
  * Copyright (C) 1999-2009,2012 Brendan Cully <brendan@kublai.com>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index f264fa18f451ce14d15122bc38d432a5350a742d..9ead5cd954687c0fef9bdf396de766fcbd0e5bd3 100644 (file)
@@ -1,7 +1,12 @@
 /**
+ * @file
+ * IMAP network mailbox
+ *
+ * @authors
  * Copyright (C) 1996-1998 Michael R. Elkins <me@mutt.org>
  * Copyright (C) 2000-2007 Brendan Cully <brendan@kublai.com>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -17,7 +22,7 @@
  */
 
 #ifndef _MUTT_IMAP_H
-#define _MUTT_IMAP_H 1
+#define _MUTT_IMAP_H
 
 #include <stddef.h>
 #include <sys/types.h>
index 4d8e2a8cedc821867be9d235a34fee458844806d..9fbf3ce072e801213a482ab1a8edaa7a3d6b317f 100644 (file)
@@ -1,7 +1,12 @@
 /**
+ * @file
+ * Shared constants/structs that are private to IMAP
+ *
+ * @authors
  * Copyright (C) 1996-1999 Brandon Long <blong@fiction.net>
  * Copyright (C) 1999-2009 Brendan Cully <brendan@kublai.com>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -17,7 +22,7 @@
  */
 
 #ifndef _MUTT_IMAP_PRIVATE_H
-#define _MUTT_IMAP_PRIVATE_H 1
+#define _MUTT_IMAP_PRIVATE_H
 
 #include <stdbool.h>
 #include <stdio.h>
index 918db30d7c6bb260a714de682c9aa1f45b98dc6a..67f6bdb89c0bbf65a5f441820b6e2d1dff400678 100644 (file)
@@ -1,7 +1,12 @@
 /**
+ * @file
+ * Manage IMAP messages
+ *
+ * @authors
  * Copyright (C) 1996-1999 Brandon Long <blong@fiction.net>
  * Copyright (C) 1999-2009 Brendan Cully <brendan@kublai.com>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 8a83371c92fc327783134f5a5d7524040b2681dc..e480de9a9de4625042399dcc2b8b02defadca722 100644 (file)
@@ -1,7 +1,12 @@
 /**
+ * @file
+ * Manage IMAP messages
+ *
+ * @authors
  * Copyright (C) 1996-1999 Brandon Long <blong@fiction.net>
  * Copyright (C) 1999-2000,2005 Brendan Cully <brendan@kublai.com>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -19,7 +24,7 @@
 /* message.c data structures */
 
 #ifndef _MUTT_IMAP_MESSAGE_H
-#define _MUTT_IMAP_MESSAGE_H 1
+#define _MUTT_IMAP_MESSAGE_H
 
 #include <stdbool.h>
 #include <time.h>
index 8f4649e58100a7fb2eb40d6e515a5106dfb60d04..4190d61ded4849ccdece9f39fed6bcfbaa8feb95 100644 (file)
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Convert strings to/from utf7/utf8
+ *
+ * @authors
  * Copyright (C) 2000,2003 Edmund Grimley Evans <edmundo@rano.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 9d38b5a758c445028986d9de915b41178627b8f4..86ba5abc28fe05968a51fa6c09ebbf6c606f193c 100644 (file)
@@ -1,8 +1,13 @@
 /**
+ * @file
+ * IMAP helper functions
+ *
+ * @authors
  * Copyright (C) 1996-1998,2010,2012-2013 Michael R. Elkins <me@mutt.org>
  * Copyright (C) 1996-1999 Brandon Long <blong@fiction.net>
  * Copyright (C) 1999-2009,2012 Brendan Cully <brendan@kublai.com>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
diff --git a/init.c b/init.c
index b851e26eefb7826e84a306e0b84f7d59575393bb..ac48e6ee3a68c52afaae0f61b48891f75f509db5 100644 (file)
--- a/init.c
+++ b/init.c
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Config/command parsing
+ *
+ * @authors
  * Copyright (C) 1996-2002,2010,2013,2016 Michael R. Elkins <me@mutt.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
diff --git a/init.h b/init.h
index cbed325b17ce73e9fa82539ddabd60e9a181a823..5d0b7afef8d5d727f3cb2dfc64c610adb57828be 100644 (file)
--- a/init.h
+++ b/init.h
@@ -1,7 +1,12 @@
 /**
+ * @file
+ * Definitions of user variables, sort methods and commands
+ *
+ * @authors
  * Copyright (C) 1996-2002,2007,2010,2012-2013,2016 Michael R. Elkins <me@mutt.org>
  * Copyright (C) 2004 g10 Code GmbH
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -17,7 +22,7 @@
  */
 
 #ifndef _MUTT_INIT_H
-#define _MUTT_INIT_H 1
+#define _MUTT_INIT_H
 
 #ifdef _MAKEDOC
 #include "config.h"
index 8024d0bf1ba2d45dd1ddbed968bdae70290b5de1..8b12d7e4cbc0e656676b903397d716b14534014e 100644 (file)
--- a/keymap.c
+++ b/keymap.c
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Manage keymappings
+ *
+ * @authors
  * Copyright (C) 1996-2000,2002,2010-2011 Michael R. Elkins <me@mutt.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 02e59838397b9ed7e391433b5e5704b7cf1f2383..78498735f924557fc107a89ba0f7e8edf8de14a7 100644 (file)
--- a/keymap.h
+++ b/keymap.h
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Manage keymappings
+ *
+ * @authors
  * Copyright (C) 1996-2000,2002,2010 Michael R. Elkins <me@mutt.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -16,7 +21,7 @@
  */
 
 #ifndef _MUTT_KEYMAP_H
-#define _MUTT_KEYMAP_H 1
+#define _MUTT_KEYMAP_H
 
 #include <stddef.h>
 #include "mapping.h"
diff --git a/lib.c b/lib.c
index 95f72da003b5c514da1bf72a3cfa0dec6f04dfa5..d723170c679e985a75472b3413e085c3d983886e 100644 (file)
--- a/lib.c
+++ b/lib.c
@@ -1,7 +1,12 @@
 /**
+ * @file
+ * Some very miscellaneous functions
+ *
+ * @authors
  * Copyright (C) 1996-2000,2007,2010 Michael R. Elkins <me@mutt.org>
  * Copyright (C) 1999-2004,2006-2007 Thomas Roessler <roessler@does-not-exist.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
diff --git a/lib.h b/lib.h
index 8e424bdfdde25bc4ea96315deedfbdaa6e52836a..1501afb00da683ad8c041487da33e4be17b04417 100644 (file)
--- a/lib.h
+++ b/lib.h
@@ -1,7 +1,12 @@
 /**
+ * @file
+ * Some very miscellaneous functions
+ *
+ * @authors
  * Copyright (C) 1996-2000,2007,2010,2012 Michael R. Elkins <me@mutt.org>
  * Copyright (C) 1999-2005,2007 Thomas Roessler <roessler@does-not-exist.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -19,7 +24,7 @@
 /* mutt functions which are generally useful. */
 
 #ifndef _MUTT_LIB_H
-#define _MUTT_LIB_H 1
+#define _MUTT_LIB_H
 
 #include <ctype.h>
 #include <limits.h>
diff --git a/list.h b/list.h
index d83bf73e66ff4b5953439ab3983b5403af97d9d5..5c6679290dc2ddbb90641d6945e295e01d75ace0 100644 (file)
--- a/list.h
+++ b/list.h
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Singly-linked list type
+ *
+ * @authors
  * Copyright (C) 2017 Richard Russon <rich@flatcap.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -16,7 +21,7 @@
  */
 
 #ifndef _MUTT_LIST_H
-#define _MUTT_LIST_H 1
+#define _MUTT_LIST_H
 
 #include "lib.h"
 
index 828d4e2bce80f2033e5673258babfb9d4926f286..6b01b394accea122a02bf1ef92ed42cd43a1e2d3 100644 (file)
--- a/mailbox.h
+++ b/mailbox.h
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Constants/structs for handling mailboxes
+ *
+ * @authors
  * Copyright (C) 1996-2002 Michael R. Elkins <me@mutt.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -16,7 +21,7 @@
  */
 
 #ifndef _MUTT_MAILBOX_H
-#define _MUTT_MAILBOX_H 1
+#define _MUTT_MAILBOX_H
 
 #include <stdbool.h>
 #include <stdio.h>
diff --git a/main.c b/main.c
index a0d6a99de01fe0ea72f0e6d90a9245997e6832a8..a0e752d896aeaec1f6bd9e818e1b6f08e7ba4e77 100644 (file)
--- a/main.c
+++ b/main.c
@@ -1,8 +1,13 @@
 /**
+ * @file
+ * Command line processing
+ *
+ * @authors
  * Copyright (C) 1996-2007,2010,2013 Michael R. Elkins <me@mutt.org>
  * Copyright (C) 1999-2007 Thomas Roessler <roessler@does-not-exist.org>
  * Copyright (C) 2004 g10 Code GmbH
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 589aacca459dd2467627f2250c6a2a7a823867bc..d9183784b17a595fbb60e869bc7e2c19f77172c5 100644 (file)
--- a/mapping.h
+++ b/mapping.h
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Store links between user-readable string and a constant
+ *
+ * @authors
  * Copyright (C) 1996-2000 Michael R. Elkins <me@mutt.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -16,7 +21,7 @@
  */
 
 #ifndef _MUTT_MAPPING_H
-#define _MUTT_MAPPING_H 1
+#define _MUTT_MAPPING_H
 
 #include <stddef.h>
 
diff --git a/mbox.c b/mbox.c
index 6215517003cf95101bf3f8c5e59cb61a511861ab..5ee78cc54e2b15b4330d40acd47e59ac5bb47ff5 100644 (file)
--- a/mbox.c
+++ b/mbox.c
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Mbox local mailbox type
+ *
+ * @authors
  * Copyright (C) 1996-2002,2010,2013 Michael R. Elkins <me@mutt.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
diff --git a/mbyte.c b/mbyte.c
index 9dba90170cb1083d85283a4d1695a62a376fa5c2..1f0cbbb757d02aa6b85939ddb3976762a67f0fa6 100644 (file)
--- a/mbyte.c
+++ b/mbyte.c
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Convert strings between multibyte and utf8 encodings
+ *
+ * @authors
  * Copyright (C) 2000 Edmund Grimley Evans <edmundo@rano.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
diff --git a/mbyte.h b/mbyte.h
index 171d54dc52dd3539cdd3546d71c6105227f3b775..a72748b9d444d913aedce2e0e9a1466869ef1a46 100644 (file)
--- a/mbyte.h
+++ b/mbyte.h
@@ -1,4 +1,9 @@
 /**
+ * @file
+ * Convert strings between multibyte and utf8 encodings
+ *
+ * @authors
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -14,7 +19,7 @@
  */
 
 #ifndef _MUTT_MBYTE_H
-#define _MUTT_MBYTE_H 1
+#define _MUTT_MBYTE_H
 
 #include <stdbool.h>
 #include <stddef.h>
index 5de5d343a486461cbb3cea06f5b081796c4bd163..96b7268cb2b74bc2eaa10d57d1b78f944d53e15b 100644 (file)
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Structure for managing a table of multibyte characters
+ *
+ * @authors
  * Copyright (C) 2017 Richard Russon <rich@flatcap.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -16,7 +21,7 @@
  */
 
 #ifndef _MUTT_MBYTE_TABLE_H
-#define _MUTT_MBYTE_TABLE_H 1
+#define _MUTT_MBYTE_TABLE_H
 
 /* multibyte character table.
  * Allows for direct access to the individual multibyte characters in a
diff --git a/md5.c b/md5.c
index 45b77ecb243f19f99694aca22f737818b5e3468a..a83219be432f35416e872df89b0245da502bc09c 100644 (file)
--- a/md5.c
+++ b/md5.c
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Calculate the MD5 checksum of a buffer
+ *
+ * @authors
  * Copyright (C) 1995,1996,1997,1999,2000,2001,2005,2006,2008 Free Software Foundation, Inc.
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
diff --git a/md5.h b/md5.h
index 330f49dec54f56406543d37d7a83833d07b9d300..7a78cf01915eea8b9134d87a90850b6ff846168f 100644 (file)
--- a/md5.h
+++ b/md5.h
@@ -1,7 +1,12 @@
 /**
+ * @file
+ * Calculate the MD5 checksum of a buffer
+ *
+ * @authors
  * Copyright (C) 1995-1997,1999,2000,2001,2004,2005,2006,2008
  *    Free Software Foundation, Inc.
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -23,7 +28,7 @@
  */
 
 #ifndef _MUTT_MD5_H
-#define _MUTT_MD5_H 1
+#define _MUTT_MD5_H
 
 #include <stdint.h>
 #include <stdio.h>
diff --git a/menu.c b/menu.c
index 6ae2b21f1f4146bb6f6ef7be6df809ccf9a1bb02..1058973549562ab6824ef187d30d2b05a50dcbf6 100644 (file)
--- a/menu.c
+++ b/menu.c
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * GUI present the user with a selectable list
+ *
+ * @authors
  * Copyright (C) 1996-2000,2002,2012 Michael R. Elkins <me@mutt.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
diff --git a/mh.c b/mh.c
index b110df2c86d416042e0fa5f2c61b70d638054135..1e87f85bd7c419d09ae4db555e1286ba081458bd 100644 (file)
--- a/mh.c
+++ b/mh.c
@@ -1,8 +1,13 @@
 /**
+ * @file
+ * Maildir/MH local mailbox type
+ *
+ * @authors
  * Copyright (C) 1996-2002,2007,2009 Michael R. Elkins <me@mutt.org>
  * Copyright (C) 1999-2005 Thomas Roessler <roessler@does-not-exist.org>
  * Copyright (C) 2010,2013 Michael R. Elkins <me@mutt.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
diff --git a/mime.h b/mime.h
index 1f3c732780b035ca9cad14d98f7aaf7b4358fae9..3c503be3ddae44dd4d1cfc0dcfac696783760460 100644 (file)
--- a/mime.h
+++ b/mime.h
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Constants and macros for managing MIME encoding
+ *
+ * @authors
  * Copyright (C) 1996-2000,2010 Michael R. Elkins <me@mutt.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -16,7 +21,7 @@
  */
 
 #ifndef _MUTT_MIME_H
-#define _MUTT_MIME_H 1
+#define _MUTT_MIME_H
 
 /* Content-Type */
 enum ContentType
diff --git a/mutt.h b/mutt.h
index 68c31b99699a04f00d5106d40ebbfafd35ca3d9a..3c3f89a80b96198757e08ac07321268eac952ef9 100644 (file)
--- a/mutt.h
+++ b/mutt.h
@@ -1,7 +1,12 @@
 /**
+ * @file
+ * Many unsorted constants and some structs
+ *
+ * @authors
  * Copyright (C) 1996-2002,2010,2013 Michael R. Elkins <me@mutt.org>
  * Copyright (C) 2004 g10 Code GmbH
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -17,7 +22,7 @@
  */
 
 #ifndef _MUTT_H
-#define _MUTT_H 1
+#define _MUTT_H
 
 #include <limits.h>
 #include <regex.h>
index f5334b790210dc8a7f616b2499b7310fdc526e24..1e9a0f145b5cc6caec0806ff68f8d07473f28621 100644 (file)
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Mapping from user command name to function
+ *
+ * @authors
  * Copyright (C) 2016 Bernard Pratz <z+mutt+pub@m0g.net>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -16,7 +21,7 @@
  */
 
 #ifndef _MUTT_COMMANDS_H
-#define _MUTT_COMMANDS_H 1
+#define _MUTT_COMMANDS_H
 
 struct Buffer;
 
index 85b13dc514578a99bb2b4254dd157ecf10aff868..73f68928f9bf994560df60b4c49e360126aee892 100644 (file)
@@ -1,7 +1,12 @@
 /**
+ * @file
+ * Define wrapper functions around Curses/Slang
+ *
+ * @authors
  * Copyright (C) 1996-2000,2012 Michael R. Elkins <me@mutt.org>
  * Copyright (C) 2004 g10 Code GmbH
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -17,7 +22,7 @@
  */
 
 #ifndef _MUTT_CURSES_H
-#define _MUTT_CURSES_H 1
+#define _MUTT_CURSES_H
 
 #include <regex.h>
 #include "lib.h"
index 551c16b0fdeac4ef90bb745db086c6731e72ee0b..27a9840f9029e83040a49e1cb379c09535e71d43 100644 (file)
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Handling of international domain names
+ *
+ * @authors
  * Copyright (C) 2003,2005,2008-2009 Thomas Roessler <roessler@does-not-exist.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index a66d8c5816ba6cd4a39e463a217d6da03a7fe8d0..493a4e2fc23ba0adb590e06f6ad138cb9c163ca1 100644 (file)
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Handling of international domain names
+ *
+ * @authors
  * Copyright (C) 2003,2005 Thomas Roessler <roessler@does-not-exist.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -16,7 +21,7 @@
  */
 
 #ifndef _MUTT_IDNA_H
-#define _MUTT_IDNA_H 1
+#define _MUTT_IDNA_H
 
 #ifdef HAVE_IDNA_H
 #include <idna.h>
index 866368f66c250269fa6862d3520d837988adb1e4..46b74dac675d158618c69072e7e7f12f89a9123b 100644 (file)
@@ -1,7 +1,12 @@
 /**
+ * @file
+ * Integrated Lua scripting
+ *
+ * @authors
  * Copyright (C) 2016 Richard Russon <rich@flatcap.org>
  * Copyright (C) 2016 Bernard Pratz <z+mutt+pub@m0g.net>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index f63e89088443352f379fcab437ee67b9a65824cb..3ef737699cad1a4b741d0da5409b58d3328b52de 100644 (file)
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Integrated Lua scripting
+ *
+ * @authors
  * Copyright (C) 2016 Richard Russon <rich@flatcap.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -16,7 +21,7 @@
  */
 
 #ifndef _MUTT_LUA_H
-#define _MUTT_LUA_H 1
+#define _MUTT_LUA_H
 
 struct Buffer;
 
index 0082af35de172899c0a1805f9ccbacf3e8d47840..39cdf87faa67f828ab22137d593e21e29a0dc0c0 100644 (file)
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * GUI handling of selectable lists
+ *
+ * @authors
  * Copyright (C) 1996-2000 Michael R. Elkins <me@mutt.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -20,7 +25,7 @@
  */
 
 #ifndef _MUTT_MENU_H
-#define _MUTT_MENU_H 1
+#define _MUTT_MENU_H
 
 #include <regex.h>
 #include <stdbool.h>
index a987265bf33751071a91d72cb4b88cfc5587b89d..d8a4143e0721ba3d40d273d783ca6a4c4e3fa6c9 100644 (file)
@@ -1,14 +1,14 @@
-/** @file
- * # NotMuch Support for Mutt
- *
- * ## Authors
- * * Copyright (C) 2011-2016 Karel Zak <kzak@redhat.com>
- * * Copyright (C) 2016-2017 Richard Russon <rich@flatcap.org>
- * * Copyright (C) 2016 Kevin Velghe <kevin@paretje.be>
- * * Copyright (C) 2017 Bernard 'Guyzmo' Pratz <guyzmo+github+pub@m0g.net>
+/**
+ * @file
+ * NotMuch virtual mailbox type
  *
- * ## License
+ * @authors
+ * Copyright (C) 2011-2016 Karel Zak <kzak@redhat.com>
+ * Copyright (C) 2016-2017 Richard Russon <rich@flatcap.org>
+ * Copyright (C) 2016 Kevin Velghe <kevin@paretje.be>
+ * Copyright (C) 2017 Bernard 'Guyzmo' Pratz <guyzmo+github+pub@m0g.net>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 1e749e424f546e49ff893faef6f31fc56cb3d513..02e3fc56d274b64372469ae48cb77137883c776f 100644 (file)
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * NotMuch virtual mailbox type
+ *
+ * @authors
  * Copyright (C) 2011 Karel Zak <kzak@redhat.com>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -16,7 +21,7 @@
  */
 
 #ifndef _MUTT_NOTMUCH_H
-#define _MUTT_NOTMUCH_H 1
+#define _MUTT_NOTMUCH_H
 
 #include <stddef.h>
 #include <stdbool.h>
index d49c2f969c5589d629e720a19d5c425c4cee0960..26056a2338e0b07de23bb6521b1f1cc88414dc12 100644 (file)
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * NotMuch virtual mailbox type
+ *
+ * @authors
  * Copyright (C) 2016 Bernard Pratz <z+mutt+pub@m0g.net>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -16,7 +21,7 @@
  */
 
 #ifndef _MUTT_OPTIONS_H
-#define _MUTT_OPTIONS_H 1
+#define _MUTT_OPTIONS_H
 
 #include <stddef.h>
 
index d20599264197498c5cd6e1872dab84f4016564ef..ff1c0be69fbd95275c6e34a0f9ff91e7d6c67145 100644 (file)
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Constants/structs for handling (lists of) regular expressions
+ *
+ * @authors
  * Copyright (C) 1996-2000 Michael R. Elkins <me@mutt.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -20,7 +25,7 @@
  */
 
 #ifndef _MUTT_REGEX_H
-#define _MUTT_REGEX_H 1
+#define _MUTT_REGEX_H
 
 #include <regex.h>
 #include "where.h"
index 75dd5974a6811c868e68fb935b3532e8175645bb..e0310b79952ea053f8501545b2620a801294a73f 100644 (file)
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * SASL authentication support
+ *
+ * @authors
  * Copyright (C) 2000-2008,2012,2014 Brendan Cully <brendan@kublai.com>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 95deea25eb263cbf507cb9cd58de82a6bf0e5143..349be5f504a684e97b1041bf5a3a141384eac08b 100644 (file)
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * SASL authentication support
+ *
+ * @authors
  * Copyright (C) 2000-2005,2008 Brendan Cully <brendan@kublai.com>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -18,7 +23,7 @@
 /* common SASL helper routines */
 
 #ifndef _MUTT_SASL_H
-#define _MUTT_SASL_H 1
+#define _MUTT_SASL_H
 
 #include <stddef.h>
 #include <sasl/sasl.h>
index ec12a4b24bf70641a549266c8d6c632ef6c043cb..5f8b009bab803faa7f52664822a2c084e9af9785 100644 (file)
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * SASL plain authentication support
+ *
+ * @authors
  * Copyright (C) 2016 Pietro Cerutti <gahr@gahr.ch>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 93750633ec006634182b6c6fcba1589f753f4c2d..5eee888b6862845fcec3a3aec8ba918eb81b9b7d 100644 (file)
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * SASL plain authentication support
+ *
+ * @authors
  * Copyright (C) 2016 Pietro Cerutti <gahr@gahr.ch>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -16,7 +21,7 @@
  */
 
 #ifndef _MUTT_SASL_PLAIN_H
-#define _MUTT_SASL_PLAIN_H 1
+#define _MUTT_SASL_PLAIN_H
 
 #include <stdlib.h>
 
index 6ad4d8c2cc784a9c4f2da26193289b348d087bb9..2e10a8b2a1a39469ef24e880fe6e68b3921144a5 100644 (file)
@@ -1,8 +1,13 @@
 /**
+ * @file
+ * Low-level socket handling
+ *
+ * @authors
  * Copyright (C) 1998,2000 Michael R. Elkins <me@mutt.org>
  * Copyright (C) 1999-2006,2008 Brendan Cully <brendan@kublai.com>
  * Copyright (C) 1999-2000 Tommi Komulainen <Tommi.Komulainen@iki.fi>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 6d18e4e6a8791672e91064a43fccc8cd68c3b7b0..aa58f0c8c7a5866b3d038727c1450bb781b3a7d8 100644 (file)
@@ -1,7 +1,12 @@
 /**
+ * @file
+ * Low-level socket handling
+ *
+ * @authors
  * Copyright (C) 1998 Brandon Long <blong@fiction.net>
  * Copyright (C) 1999-2005 Brendan Cully <brendan@kublai.com>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -17,7 +22,7 @@
  */
 
 #ifndef _MUTT_SOCKET_H
-#define _MUTT_SOCKET_H 1
+#define _MUTT_SOCKET_H
 
 #include <stddef.h>
 #include "account.h"
index cb19b13b991d5b88c515d66587a1109475b72287..d05cfc0869922f2dfe838a8ff2fdbf6441c692c4 100644 (file)
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Handling of OpenSSL encryption
+ *
+ * @authors
  * Copyright (C) 1999-2001 Tommi Komulainen <Tommi.Komulainen@iki.fi>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 3a9eecf6d0c4ae7e3289cb71753468f84082ffdc..9aa27bb948bfcf9a51b706f982ee29f69ae44a70 100644 (file)
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Handling of OpenSSL encryption
+ *
+ * @authors
  * Copyright (C) 1999-2000 Tommi Komulainen <Tommi.Komulainen@iki.fi>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -16,7 +21,7 @@
  */
 
 #ifndef _MUTT_SSL_H
-#define _MUTT_SSL_H 1
+#define _MUTT_SSL_H
 
 #ifdef USE_SSL
 struct Connection;
index 62ed421086677ca96cc65b4a8c277c8837d02d0d..c3f8ecaac6f90942934cbdac39291b66616268c0 100644 (file)
@@ -1,7 +1,12 @@
 /**
+ * @file
+ * Handling of GnuTLS encryption
+ *
+ * @authors
  * Copyright (C) 2001 Marco d'Itri <md@linux.it>
  * Copyright (C) 2001-2004 Andrew McDonald <andrew@mcdonald.org.uk>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 77716283b038ca4db82cb9c8323ce4122a64e886..4f1afb5a5dcc6754b736a564e08c69d7da936cf8 100644 (file)
@@ -1,7 +1,12 @@
 /**
+ * @file
+ * Support for network tunnelling
+ *
+ * @authors
  * Copyright (C) 2000 Manoj Kasichainula <manoj@io.com>
  * Copyright (C) 2001,2005 Brendan Cully <brendan@kublai.com>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index bc1980dfef84e118b5b9e5bcc44f12df58d5c471..8a60da7d316d2eb4ac0bed787ba4b18e7cd1d0e8 100644 (file)
@@ -1,4 +1,9 @@
 /**
+ * @file
+ * Support for network tunnelling
+ *
+ * @authors
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -14,7 +19,7 @@
  */
 
 #ifndef _MUTT_TUNNEL_H
-#define _MUTT_TUNNEL_H 1
+#define _MUTT_TUNNEL_H
 
 struct Connection;
 
index 6700525d75c7fd9557539908eab12de1e5ce19c3..eea0cf121ba6b6e0fbef93ee891aa3dcec5c4f5f 100644 (file)
--- a/muttlib.c
+++ b/muttlib.c
@@ -1,7 +1,12 @@
 /**
+ * @file
+ * Some miscellaneous functions
+ *
+ * @authors
  * Copyright (C) 1996-2000,2007,2010,2013 Michael R. Elkins <me@mutt.org>
  * Copyright (C) 1999-2008 Thomas Roessler <roessler@does-not-exist.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
diff --git a/mx.c b/mx.c
index 20e0bfee2f2f7315fa29f56b67dfee5eaaf60ce0..5950c2f1300d229f26be2e004c5244e6e4770821 100644 (file)
--- a/mx.c
+++ b/mx.c
@@ -1,7 +1,12 @@
 /**
+ * @file
+ * Mailbox multiplexor
+ *
+ * @authors
  * Copyright (C) 1996-2002,2010,2013 Michael R. Elkins <me@mutt.org>
  * Copyright (C) 1999-2003 Thomas Roessler <roessler@does-not-exist.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
diff --git a/mx.h b/mx.h
index 8990f1b767f99f00c2217ddd7f0554215b87c340..8c95a73f3b9451b56e0efaf8fc38cca9d4586d27 100644 (file)
--- a/mx.h
+++ b/mx.h
@@ -1,7 +1,12 @@
 /**
+ * @file
+ * API for mailboxes
+ *
+ * @authors
  * Copyright (C) 1996-2002,2013 Michael R. Elkins <me@mutt.org>
  * Copyright (C) 1999-2002 Thomas Roessler <roessler@does-not-exist.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -22,7 +27,7 @@
  */
 
 #ifndef _MUTT_MX_H
-#define _MUTT_MX_H 1
+#define _MUTT_MX_H
 
 #include <stdbool.h>
 #include <stdio.h>
diff --git a/myvar.h b/myvar.h
index 6d602341bf01ceecf1fdfdcd39e3cc3ba2f801fb..cb842958c1458b04c87352e3bb09b2d506c797de 100644 (file)
--- a/myvar.h
+++ b/myvar.h
@@ -1,4 +1,9 @@
 /**
+ * @file
+ * Handling of personal config ('my' variables)
+ *
+ * @authors
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -14,7 +19,7 @@
  */
 
 #ifndef _MUTT_MYVAR_H
-#define _MUTT_MYVAR_H 1
+#define _MUTT_MYVAR_H
 
 #include <stddef.h>
 
index 43167236431c1f453fa056607aeb74a10914cd10..e32915e213f7e2a512fb5f401d16c7914dbb5a17 100644 (file)
@@ -1,4 +1,8 @@
 /**
+ * @file
+ * Signing/encryption multiplexor
+ *
+ * @authors
  * Copyright (C) 1996-1997 Michael R. Elkins <me@mutt.org>
  * Copyright (C) 1999-2000,2002-2004,2006 Thomas Roessler <roessler@does-not-exist.org>
  * Copyright (C) 2001 Thomas Roessler <roessler@does-not-exist.org>
@@ -6,6 +10,7 @@
  * Copyright (C) 2003 Werner Koch <wk@gnupg.org>
  * Copyright (C) 2004 g10code GmbH
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 0e07ba7a2fa5d45069abac659932459d0db0ff9a..d36efccdf64e6b28631ca2811a521e8c6a9c505f 100644 (file)
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Signing/encryption multiplexor
+ *
+ * @authors
  * Copyright (C) 2017 Richard Russon <rich@flatcap.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 60c5c7f4ca4e3df3d12002d58898f76be9f89942..99dd58bafd25ff7337193bcaae573026bae87d27 100644 (file)
@@ -1,4 +1,8 @@
 /**
+ * @file
+ * Wrapper for PGP/SMIME calls to GPGME
+ *
+ * @authors
  * Copyright (C) 1996-1997,2007 Michael R. Elkins <me@cs.hmc.edu>
  * Copyright (C) 1998-2000 Thomas Roessler <roessler@does-not-exist.org>
  * Copyright (C) 2001 Thomas Roessler <roessler@does-not-exist.org>
@@ -6,6 +10,7 @@
  * Copyright (C) 2002-2004 g10 Code GmbH
  * Copyright (C) 2010,2012-2013 Michael R. Elkins <me@sigpipe.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 8d194fc02d5aad60990ecd9ed6e816a4b2eca28c..9faabf105244a54a949b6699b0d22862da2bf756 100644 (file)
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Wrapper for PGP/SMIME calls to GPGME
+ *
+ * @authors
  * Copyright (C) 2004 g10 Code GmbH
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 022ee79765809d918f3579cab918a4db89cb44ee..af6514e667c6e3b6188162cac3766957a469ebc5 100644 (file)
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Register crypto modules
+ *
+ * @authors
  * Copyright (C) 2004 g10 Code GmbH
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 46e55f75fbbac45403f3edd5ef781cfa77ae4fe5..3157d08a5eac6e1abaf4f7fd0838c5452a1fdc60 100644 (file)
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Register crypto modules
+ *
+ * @authors
  * Copyright (C) 2017 Richard Russon <rich@flatcap.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index afe7a5a51dc997c414517952968d63cadef64c26..d9e0cbcef9857989d1cf65c687342b42f8f04b98 100644 (file)
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Wrappers for calls to CLI PGP
+ *
+ * @authors
  * Copyright (C) 2004 g10 Code GmbH
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index e23f479c0a08f274fee051d2fcb45168866df39d..bd805539e57a9ae5514bc41a73dc3eb06d312f9d 100644 (file)
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Wrappers for calls to GPGME PGP
+ *
+ * @authors
  * Copyright (C) 2004 g10 Code GmbH
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 4e332fe08755c42e08e1d0f929b044ff524ba235..bf2389c4ad34b6deb3c09a7d8d183f420643dd1e 100644 (file)
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Wrappers for calls to CLI SMIME
+ *
+ * @authors
  * Copyright (C) 2004 g10 Code GmbH
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index a08f8ef078698f51c5eca392bbb09d453e5682ff..0d7cbc7b977f79b597b3c502c258a11b75896084 100644 (file)
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Wrappers for calls to GPGME SMIME
+ *
+ * @authors
  * Copyright (C) 2004 g10 Code GmbH
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 0ee7ae6ee9c9a7c4e160c24942af7207c9b481de..e335ed422b0571cf41a46b901318e33fd3b34aae 100644 (file)
@@ -1,7 +1,12 @@
 /**
+ * @file
+ * Wrapper around crypto functions
+ *
+ * @authors
  * Copyright (C) 2003 Werner Koch <wk@gnupg.org>
  * Copyright (C) 2004 g10 Code GmbH
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index bebd508f5b5009521cadfdeff144d2502815064e..62da2df2089af0de8cc3457936eeb633e8c14f33 100644 (file)
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Wrapper around crypto functions
+ *
+ * @authors
  * Copyright (C) 2017 Richard Russon <rich@flatcap.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index b830075ea96ab30ff7c2e0e0ffcfca0bbb7297ef..1a651568a36ee737ec7285ccd4d8b00ef7b2df02 100644 (file)
@@ -1,7 +1,12 @@
 /**
+ * @file
+ * Parse the output of CLI PGP program
+ *
+ * @authors
  * Copyright (C) 1998-2000,2003 Werner Koch <werner.koch@guug.de>
  * Copyright (C) 1999-2003 Thomas Roessler <roessler@does-not-exist.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 044afabcdefa6d51a077726e88eb741aa8a620d7..30c0158e399560681190d62746dba191085acb40 100644 (file)
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Parse the output of CLI PGP programinclude "pgpkey.h"
+ *
+ * @authors
  * Copyright (C) 2017 Richard Russon <rich@flatcap.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index e79684b5a859d931c5ecb7606f377d30c74b1a2c..6da253ef12b915270c58e4217e4775639d339fa5 100644 (file)
@@ -1,7 +1,12 @@
 /**
+ * @file
+ * API for encryption/signing of emails
+ *
+ * @authors
  * Copyright (C) 2003 Werner Koch <wk@gnupg.org>
  * Copyright (C) 2004 g10code GmbH
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 257cd4c6544a5be2ac781c37b5c5ba7aa53f513d..b647d03ea7bb5401a78c3e4620f6948d20a7416c 100644 (file)
@@ -1,8 +1,13 @@
 /**
+ * @file
+ * PGP sign, encrypt, check routines
+ *
+ * @authors
  * Copyright (C) 1996-1997,2000,2010 Michael R. Elkins <me@mutt.org>
  * Copyright (C) 1998-2005 Thomas Roessler <roessler@does-not-exist.org>
  * Copyright (C) 2004 g10 Code GmbH
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index ce0dfc1797c4631815d5b9b80385866ca54dfb9e..5a87805e2d6044558da080c0b3d484e7d2158ce8 100644 (file)
@@ -1,8 +1,13 @@
 /**
+ * @file
+ * PGP sign, encrypt, check routines
+ *
+ * @authors
  * Copyright (C) 1996-1997 Michael R. Elkins <me@mutt.org>
  * Copyright (C) 1999-2003 Thomas Roessler <roessler@does-not-exist.org>
  * Copyright (C) 2004 g10 Code GmbH
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index fa86b93835d45adf57351b6486a0b1e866946a2f..b95a738c912c8a2ac631551b3617b27814709b48 100644 (file)
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Wrapper around calls to external PGP program
+ *
+ * @authors
  * Copyright (C) 1997-2003 Thomas Roessler <roessler@does-not-exist.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index cc6597e8e0aea60daa5d78ed91a2b19259873c62..297c9926dbd0020c3418f735e1b976744b8b599b 100644 (file)
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Wrapper around calls to external PGP program
+ *
+ * @authors
  * Copyright (C) 2017 Richard Russon <rich@flatcap.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index a44f3c8816724d8f37e8f2a6fcc9bbc2118074fc..710f85848c551c4a8141f32cd7b0a9dcefc8779e 100644 (file)
@@ -1,7 +1,12 @@
 /**
+ * @file
+ * PGP key management routines
+ *
+ * @authors
  * Copyright (C) 1996-1997,2007 Michael R. Elkins <me@mutt.org>
  * Copyright (c) 1998-2003 Thomas Roessler <roessler@does-not-exist.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 0ed481388a71a22595185928d38353a30bce0586..fc85657adfabcbcfe54a9ca8b88a802919a655f5 100644 (file)
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * PGP key management routines
+ *
+ * @authors
  * Copyright (C) 2017 Richard Russon <rich@flatcap.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 1edc759f3d378a51b4c70296a5307b14f9e64964..9779e0a64299287f1cf3c4ebca42550f2ad918ff 100644 (file)
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Misc PGP helper routines
+ *
+ * @authors
  * Copyright (C) 1997-2002 Thomas Roessler <roessler@does-not-exist.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index b8296e875a8f68e074c7351fd1584ddfe40c011b..57caf5746b21a5db41b265118b0b53d6a361e16e 100644 (file)
@@ -1,7 +1,12 @@
 /**
+ * @file
+ * Misc PGP helper routines
+ *
+ * @authors
  * Copyright (C) 1996-1997 Michael R. Elkins <me@mutt.org>
  * Copyright (C) 1999-2002 Thomas Roessler <roessler@does-not-exist.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 61268f539f03e82c59cd76832f15d6aeb808ecfe..de07c1da2390c71062dc51f7f093c9f769d0bb86 100644 (file)
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Identify the hash algorithm from a PGP signature
+ *
+ * @authors
  * Copyright (C) 2001 Thomas Roessler <roessler@does-not-exist.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 1174ad71b20e1a6231c5caa291bd7436cc68baa2..3797daac07515996cb926eee64bed7785eaf6ab6 100644 (file)
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Identify the hash algorithm from a PGP signature
+ *
+ * @authors
  * Copyright (C) 2017 Richard Russon <rich@flatcap.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 81cc937076e115b7652139c8acf38d20825de969..6433c1aa258689bf4d3ae38a52d336d1cc831a57 100644 (file)
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Parse PGP data packets
+ *
+ * @authors
  * Copyright (C) 2001-2002,2007 Thomas Roessler <roessler@does-not-exist.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 557e7c1e326001640d32de60211691659fd9c3e3..e7807709de74dacc1b165a2216f0efb8fb21c6a6 100644 (file)
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Parse PGP data packets
+ *
+ * @authors
  * Copyright (C) 2001 Thomas Roessler <roessler@does-not-exist.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index cfb22c35cf411644c8e205a5144fb9b9a29ef172..25ba222c149e889dfb7ea5b595d996db1077da40 100644 (file)
@@ -1,8 +1,13 @@
 /**
+ * @file
+ * SMIME helper routines
+ *
+ * @authors
  * Copyright (C) 2001-2002 Oliver Ehli <elmy@acm.org>
  * Copyright (C) 2002 Mike Schiraldi <raldi@research.netsol.com>
  * Copyright (C) 2004 g10 Code GmbH
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 50986f93deafafb0409e294f09e9ad22b7933eb7..bc51c189b1009c8bc80ae3257fe1892f5cdb6a09 100644 (file)
@@ -1,7 +1,12 @@
 /**
+ * @file
+ * SMIME helper routines
+ *
+ * @authors
  * Copyright (C) 2001-2002 Oliver Ehli <elmy@acm.org>
  * Copyright (C) 2004 g10 Code GmbH
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 85143a7d66b5017b2ab6ec78fcf07ec6d85b8799..331043de90c82c195332a23eefaf85407a43363e 100644 (file)
--- a/newsrc.c
+++ b/newsrc.c
@@ -1,8 +1,13 @@
 /**
+ * @file
+ * Read/parse/write an NNTP config file of subscribed newsgroups
+ *
+ * @authors
  * Copyright (C) 1998 Brandon Long <blong@fiction.net>
  * Copyright (C) 1999 Andrej Gritsenko <andrej@lucky.net>
  * Copyright (C) 2000-2017 Vsevolod Volkov <vvv@mutt.org.ua>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
diff --git a/nntp.c b/nntp.c
index 5540c3a4115c97e6ff3ac75ee3ce2efef8b2dacc..9895f7197aaadf89520d94a1fdb997af41c19f04 100644 (file)
--- a/nntp.c
+++ b/nntp.c
@@ -1,8 +1,13 @@
 /**
+ * @file
+ * Usenet network mailbox type; talk to an NNTP server
+ *
+ * @authors
  * Copyright (C) 1998 Brandon Long <blong@fiction.net>
  * Copyright (C) 1999 Andrej Gritsenko <andrej@lucky.net>
  * Copyright (C) 2000-2017 Vsevolod Volkov <vvv@mutt.org.ua>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
diff --git a/nntp.h b/nntp.h
index 2da59c32be6cc5d5ad0b02ac2ac31b845a4fd413..a29fa5feb44d4a92af5bace0c58719792482fa58 100644 (file)
--- a/nntp.h
+++ b/nntp.h
@@ -1,8 +1,13 @@
 /**
+ * @file
+ * Usenet network mailbox type; talk to an NNTP server
+ *
+ * @authors
  * Copyright (C) 1998 Brandon Long <blong@fiction.net>
  * Copyright (C) 1999 Andrej Gritsenko <andrej@lucky.net>
  * Copyright (C) 2000-2012 Vsevolod Volkov <vvv@mutt.org.ua>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -18,7 +23,7 @@
  */
 
 #ifndef _MUTT_NNTP_H
-#define _MUTT_NNTP_H 1
+#define _MUTT_NNTP_H
 
 #include <stdbool.h>
 #include <stdint.h>
index 4dc8e0f053528d5be2fcfa71c326fb5687a9e49b..5cdd16e4c4f4ac61b9cadc115f271118435388ae 100644 (file)
--- a/options.h
+++ b/options.h
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Handling of global boolean variables
+ *
+ * @authors
  * Copyright (C) 2017 Richard Russon <rich@flatcap.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -16,7 +21,7 @@
  */
 
 #ifndef _MUTT_OPTIONS_H_
-#define _MUTT_OPTIONS_H_ 1
+#define _MUTT_OPTIONS_H_
 
 /* boolean vars */
 enum GlobalBool
diff --git a/pager.c b/pager.c
index c78eebc16fb92569a581982311d1c4dd2f78ed15..f1445468bb112c278d8695ee360361ae7fd3f051 100644 (file)
--- a/pager.c
+++ b/pager.c
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * GUI display a file/email/help in a viewport with paging
+ *
+ * @authors
  * Copyright (C) 1996-2002,2007,2010,2012-2013 Michael R. Elkins <me@mutt.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
diff --git a/pager.h b/pager.h
index 3d6326fe3aaa53b5f1f382bfa208776e72845acc..9631a2c4032996eb30c49f1e0cd86e0ccdefad00 100644 (file)
--- a/pager.h
+++ b/pager.h
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * GUI display a file/email/help in a viewport with paging
+ *
+ * @authors
  * Copyright (C) 1996-2000 Michael R. Elkins <me@mutt.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -16,7 +21,7 @@
  */
 
 #ifndef _MUTT_PAGER_H
-#define _MUTT_PAGER_H 1
+#define _MUTT_PAGER_H
 
 #include <stdio.h>
 
index 21b78566bda5695d5e690fc75ecf90c5e3af03b5..7d88c0a6a5837f3235458f384959d6ca7ccc0cea 100644 (file)
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Store attributes associated with a MIME part
+ *
+ * @authors
  * Copyright (C) 2017 Richard Russon <rich@flatcap.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -16,7 +21,7 @@
  */
 
 #ifndef _MUTT_PARAMETER_H
-#define _MUTT_PARAMETER_H 1
+#define _MUTT_PARAMETER_H
 
 #include "lib.h"
 
diff --git a/parse.c b/parse.c
index d20251565dd140754807bc50a990894dfed15b91..0e3d4b205ddb7288c8d2efd44629b5ab4754fa51 100644 (file)
--- a/parse.c
+++ b/parse.c
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Miscellaneous email parsing routines
+ *
+ * @authors
  * Copyright (C) 1996-2000,2012-2013 Michael R. Elkins <me@mutt.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index ccd1cfa488ceeafb2fdff526fc079c8a4505e226..e0603593d1e8d78d6b501b5d5695ff6a9d5d2664 100644 (file)
--- a/pattern.c
+++ b/pattern.c
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Match patterns to emails
+ *
+ * @authors
  * Copyright (C) 1996-2000,2006-2007,2010 Michael R. Elkins <me@mutt.org>, and others
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index a7c1461a8bad7c8d6d9fe89c8cbd8e23fab8fe7c..0a5041ddae580ace1b742c5a303721d522ae9101 100644 (file)
--- a/pattern.h
+++ b/pattern.h
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Match patterns to emails
+ *
+ * @authors
  * Copyright (C) 2017 Richard Russon <rich@flatcap.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -16,7 +21,7 @@
  */
 
 #ifndef _MUTT_PATTERN_H
-#define _MUTT_PATTERN_H 1
+#define _MUTT_PATTERN_H
 
 #include <regex.h>
 #include <stdbool.h>
index ec3e998def717f6a07fd57df222d9f20ea840db6..aa8962c1175cbffa27f2ac6d6ba1501ea7b32368 100644 (file)
@@ -1,4 +1,7 @@
 /**
+ * @file
+ * Standalone tool to manipulate a program's command line
+ *
  * C version by Wessel Dankers <wsl@fruit.eu.org>
  *
  * This code is in the public domain.
index 4a1c4cb968d3818d6e14f839d65b09cb0a422771..afc797fe2f05a034e89da5f47272006022f16ba6 100644 (file)
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Standalone tool to dump the contents of a PGP key ring
+ *
+ * @authors
  * Copyright (C) 1997-2003 Thomas Roessler <roessler@does-not-exist.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
diff --git a/pop.c b/pop.c
index b7d4f7fa270936a28e692fc240949befab0d6e01..a5c6f58c952cda45755db6c641f346e4260289ae 100644 (file)
--- a/pop.c
+++ b/pop.c
@@ -1,7 +1,12 @@
 /**
+ * @file
+ * POP network mailbox
+ *
+ * @authors
  * Copyright (C) 2000-2002 Vsevolod Volkov <vvv@mutt.org.ua>
  * Copyright (C) 2006-2007,2009 Rocco Rutte <pdmef@gmx.net>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
diff --git a/pop.h b/pop.h
index a73cff6f50b46ed11192e6d0cd3cca4d3f76d3ef..1c838ed65a8db6ff4fc0e2a50c7b39a3b35aec0d 100644 (file)
--- a/pop.h
+++ b/pop.h
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * POP network mailbox
+ *
+ * @authors
  * Copyright (C) 2000-2003 Vsevolod Volkov <vvv@mutt.org.ua>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -16,7 +21,7 @@
  */
 
 #ifndef _MUTT_POP_H
-#define _MUTT_POP_H 1
+#define _MUTT_POP_H
 
 #include <stdbool.h>
 #include <time.h>
index 68edc5f2b20cb4288d56853320dd50325ff73d34..dadc0c0fe5bc25400f8fa58b8c7a7a76811eb567 100644 (file)
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * POP authentication
+ *
+ * @authors
  * Copyright (C) 2000-2001 Vsevolod Volkov <vvv@mutt.org.ua>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index fa470b3083c8c65e7f81b011881678c376860303..57790d452ae2c68d526cf9e2729557739b911071 100644 (file)
--- a/pop_lib.c
+++ b/pop_lib.c
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * POP helper routines
+ *
+ * @authors
  * Copyright (C) 2000-2003 Vsevolod Volkov <vvv@mutt.org.ua>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index c37fe62c034508ec00adbeb3cbd00c5c75511b37..cdf631a7a649056122181ae411fc518e01071328 100644 (file)
@@ -1,7 +1,12 @@
 /**
+ * @file
+ * Save/restore and GUI list postponed emails
+ *
+ * @authors
  * Copyright (C) 1996-2002,2012-2013 Michael R. Elkins <me@mutt.org>
  * Copyright (C) 1999-2002,2004 Thomas Roessler <roessler@does-not-exist.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index fa12350d88f5b89076ea3b6e1fbc1ffe99350fdc..7128dd8ae0e46d1447115da05509e5cc3ce52223 100644 (file)
--- a/protos.h
+++ b/protos.h
@@ -1,7 +1,12 @@
 /**
+ * @file
+ * Prototypes for many functions
+ *
+ * @authors
  * Copyright (C) 1996-2000,2007,2010,2013 Michael R. Elkins <me@mutt.org>
  * Copyright (C) 2013 Karel Zak <kzak@redhat.com>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -17,7 +22,7 @@
  */
 
 #ifndef _MUTT_PROTOS_H
-#define _MUTT_PROTOS_H 1
+#define _MUTT_PROTOS_H
 
 #include <stddef.h>
 #include <ctype.h>
diff --git a/query.c b/query.c
index f01da3e518e76876d2e70e82e97b275f8682f1fd..4e9075f80de6e49a27b1ce96c7d2b7e3120afb75 100644 (file)
--- a/query.c
+++ b/query.c
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Routines for querying and external address book
+ *
+ * @authors
  * Copyright (C) 1996-2000,2003,2013 Michael R. Elkins <me@mutt.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 66ce2654224ea5c636be2a907f4ff5b8b8bdb13a..0a57424e8af5fccd12e9cffd4a78968e73affddf 100644 (file)
@@ -1,7 +1,12 @@
 /**
+ * @file
+ * Routines for managing attachments
+ *
+ * @authors
  * Copyright (C) 1996-2000,2002,2007,2010 Michael R. Elkins <me@mutt.org>
  * Copyright (C) 1999-2006 Thomas Roessler <roessler@does-not-exist.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 62a1af73eb8facfb09b1932fe526338456393db0..094f09d9087988e70e6eee28d125f09ad72ea7c7 100644 (file)
--- a/recvcmd.c
+++ b/recvcmd.c
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Send/reply with an attachment
+ *
+ * @authors
  * Copyright (C) 1999-2004 Thomas Roessler <roessler@does-not-exist.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 5fc8c6f06003219aa9102d228fc5fdae13ce91f4..5f80ccac321d6826c1c45cf7815014c80ad145e8 100644 (file)
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Support of Mixmaster anonymous remailer
+ *
+ * @authors
  * Copyright (C) 1999-2001 Thomas Roessler <roessler@does-not-exist.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 34fb263de856d247d9299e9ea662a4813e0c71b5..bfcd231136561952f0c559432ecac1b06d5e0c29 100644 (file)
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Support of Mixmaster anonymous remailer
+ *
+ * @authors
  * Copyright (C) 1999-2000 Thomas Roessler <roessler@does-not-exist.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -20,7 +25,7 @@
  */
 
 #ifndef _MUTT_REMAILER_H
-#define _MUTT_REMAILER_H 1
+#define _MUTT_REMAILER_H
 
 #include <stddef.h>
 
index 220a4bedec502a6e487224a6b6718198e60d69c3..bda46980245886909ff49a9b186dcff1a52390a5 100644 (file)
--- a/resize.c
+++ b/resize.c
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * GUI handle the resizing of the screen
+ *
+ * @authors
  * Copyright (C) 1996-2000 Michael R. Elkins <me@mutt.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index be45157b86e8b30f3c4b04fc35faa730e3550db3..117218d776e58ec691ec25ba9b3a7fce60ebaf58 100644 (file)
--- a/rfc1524.c
+++ b/rfc1524.c
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * RFC 1524 Mailcap routines
+ *
+ * @authors
  * Copyright (C) 1996-2000,2003,2012 Michael R. Elkins <me@mutt.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 41e80f6e5a7248f115b740b563aef43b12d131a0..85e8d672033beb39bb4c94338b3dc558be90e000 100644 (file)
--- a/rfc1524.h
+++ b/rfc1524.h
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * RFC 1524 Mailcap routines
+ *
+ * @authors
  * Copyright (C) 1996-2000 Michael R. Elkins <me@mutt.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -16,7 +21,7 @@
  */
 
 #ifndef _MUTT_RFC1524_H
-#define _MUTT_RFC1524_H 1
+#define _MUTT_RFC1524_H
 
 #include <stdbool.h>
 #include <stddef.h>
index 17f8a14aec76c4230519bca9c48438296abb150c..b244537431d1ca737bd36d21bf79be80e259f7ef 100644 (file)
--- a/rfc2047.c
+++ b/rfc2047.c
@@ -1,7 +1,12 @@
 /**
+ * @file
+ * RFC 2047 MIME extensions routines
+ *
+ * @authors
  * Copyright (C) 1996-2000,2010 Michael R. Elkins <me@mutt.org>
  * Copyright (C) 2000-2002 Edmund Grimley Evans <edmundo@rano.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 4b122b2af532911747ec2bd461862ad677cea80e..604ab1341586cd11c98376cfe07f85123ed59191 100644 (file)
--- a/rfc2047.h
+++ b/rfc2047.h
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * RFC 2047 MIME extensions routines
+ *
+ * @authors
  * Copyright (C) 1996-2000 Michael R. Elkins <me@mutt.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -16,7 +21,7 @@
  */
 
 #ifndef _MUTT_RFC2047_H
-#define _MUTT_RFC2047_H 1
+#define _MUTT_RFC2047_H
 
 #include <stddef.h>
 
index 224dd1191fa304265478363264df4acbed443c07..40c62158e2ce2a0bdcef5fb771a963edf53d4446 100644 (file)
--- a/rfc2231.c
+++ b/rfc2231.c
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * RFC 2231 MIME Charset routines
+ *
+ * @authors
  * Copyright (C) 1999-2001 Thomas Roessler <roessler@does-not-exist.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 353f84fb1d00bc71b9b86451459ec8769d1f9896..1602a1c01183e692e356ba40b57068a26fd505d7 100644 (file)
--- a/rfc2231.h
+++ b/rfc2231.h
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * RFC 2231 MIME Charset routines
+ *
+ * @authors
  * Copyright (C) 1999-2000 Thomas Roessler <roessler@does-not-exist.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -16,7 +21,7 @@
  */
 
 #ifndef _MUTT_RFC2231_H
-#define _MUTT_RFC2231_H 1
+#define _MUTT_RFC2231_H
 
 struct Parameter;
 
index 23fd1a4b23cc76eb1a47e67599f0359acd919de8..728e2a4abbde4544b4f7391b1e18086418923338 100644 (file)
--- a/rfc3676.c
+++ b/rfc3676.c
@@ -1,9 +1,14 @@
 /**
+ * @file
+ * RFC 3676 Format Flowed routines
+ *
+ * @authors
  * Copyright (C) 2005 Andreas Krennmair <ak@synflood.at>
  * Copyright (C) 2005 Peter J. Holzer <hjp@hjp.net>
  * Copyright (C) 2005-2009 Rocco Rutte <pdmef@gmx.net>
  * Copyright (C) 2010 Michael R. Elkins <me@mutt.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 0d473e6a3ee76b1ae73be2ea1923c532decc679d..dba8ace183e175d4d1a7c2455a8bd20470c1df59 100644 (file)
--- a/rfc3676.h
+++ b/rfc3676.h
@@ -1,8 +1,13 @@
 /**
+ * @file
+ * RFC 3676 Format Flowed routines
+ *
+ * @authors
  * Copyright (C) 2005 Andreas Krennmair <ak@synflood.at>
  * Copyright (C) 2005 Peter J. Holzer <hjp@hjp.net>
  * Copyright (C) 2005,2007 Rocco Rutte <pdmef@gmx.net>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -20,7 +25,7 @@
 /* This file was originally part of mutt-ng */
 
 #ifndef _MUTT_RFC3676_H
-#define _MUTT_RFC3676_H 1
+#define _MUTT_RFC3676_H
 
 struct Body;
 struct Header;
index 3c4380406db6a38b00902de6d2f4a3c11f5931cf..3c3071e36e808bf7618f1fff320bdea0b899c1ae 100644 (file)
--- a/rfc822.c
+++ b/rfc822.c
@@ -1,7 +1,12 @@
 /**
+ * @file
+ * RFC 822 Email format routines
+ *
+ * @authors
  * Copyright (C) 1996-2000 Michael R. Elkins <me@mutt.org>
  * Copyright (C) 2011-2013 Michael R. Elkins <me@mutt.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 60074b1a5208f6c3283ed40f996f96da3a55c7c2..579ceec1e043197b6751976c8a04668e9e961000 100644 (file)
--- a/rfc822.h
+++ b/rfc822.h
@@ -1,7 +1,12 @@
 /**
+ * @file
+ * RFC 822 Email format routines
+ *
+ * @authors
  * Copyright (C) 1996-2000 Michael R. Elkins <me@mutt.org>
  * Copyright (C) 2012 Michael R. Elkins <me@mutt.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -17,7 +22,7 @@
  */
 
 #ifndef _MUTT_RFC822_H
-#define _MUTT_RFC822_H 1
+#define _MUTT_RFC822_H
 
 #include <stddef.h>
 #include <stdbool.h>
index 36c7cf8465abd0c8a5db302ee56845e580757aa1..86ef8de2cb71effcda91a5001842e13e4c90e2a4 100644 (file)
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Wrapper for vasprintf()/vsnprintf()
+ *
+ * @authors
  * Copyright (C) 2010 Michael R. Elkins <me@mutt.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
diff --git a/score.c b/score.c
index e2b410739e5d047ace0050d08f12c2a112010f26..c7d25b8d4e64bf87f6f569874238c3023a11a2a6 100644 (file)
--- a/score.c
+++ b/score.c
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Routines for adding user scores to emails
+ *
+ * @authors
  * Copyright (C) 1996-2000 Michael R. Elkins <me@mutt.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
diff --git a/send.c b/send.c
index 68696ed6a3418e4d487722cc827641060074367b..b1e29577afb74ddebd860601f49425333c2b6b69 100644 (file)
--- a/send.c
+++ b/send.c
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Prepare and send an email
+ *
+ * @authors
  * Copyright (C) 1996-2002,2004,2010,2012-2013 Michael R. Elkins <me@mutt.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index fadbe39f20516898d503a6789194d6cb7fc5ec6d..b4821900ea2451cdb1fec51268b1f31b98760b28 100644 (file)
--- a/sendlib.c
+++ b/sendlib.c
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Miscellaneous functions for sending an email
+ *
+ * @authors
  * Copyright (C) 1996-2002,2009-2012 Michael R. Elkins <me@mutt.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
diff --git a/sha1.c b/sha1.c
index 0591cc01f16dea46e0d74fc6f21282355fd6aa6e..e9e402a8e5f50a5e5d5093cdf6a56f8014d0caec 100644 (file)
--- a/sha1.c
+++ b/sha1.c
@@ -1,4 +1,7 @@
 /**
+ * @file
+ * Calculate the SHA1 checksum of a buffer
+ *
  * SHA-1 in C
  *
  * By Steve Reid <steve@edmweb.com>, with small changes to make it
diff --git a/sha1.h b/sha1.h
index dcaeb12abc0a589deab44bc2408c6674cf922f66..ea988ea232aa7ffc8731d74f8a622c61ae396a64 100644 (file)
--- a/sha1.h
+++ b/sha1.h
@@ -1,4 +1,7 @@
 /**
+ * @file
+ * Calculate the SHA1 checksum of a buffer
+ *
  * SHA-1 in C
  *
  * By Steve Reid <steve@edmweb.com>, with small changes to make it
@@ -6,7 +9,7 @@
  */
 
 #ifndef _MUTT_SHA1_H
-#define _MUTT_SHA1_H 1
+#define _MUTT_SHA1_H
 
 #include <stdint.h>
 
index 1aeac4a3884c999042491dbf6c4931b4faf5e210..78d2e06093f150f1c6a1a4fdc5b71abbe93e1554 100644 (file)
--- a/sidebar.c
+++ b/sidebar.c
@@ -1,9 +1,14 @@
 /**
+ * @file
+ * GUI display the mailboxes in a side panel
+ *
+ * @authors
  * Copyright (C) 2004 Justin Hibbits <jrh29@po.cwru.edu>
  * Copyright (C) 2004 Thomer M. Gil <mutt@thomer.com>
  * Copyright (C) 2015-2016 Richard Russon <rich@flatcap.org>
  * Copyright (C) 2016 Kevin J. McCarthy <kevin@8t8.us>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index fc3360dca99cbeb4327551d1357553476180decc..9538543d2bf884a91e6aa0ee7a92633869a4fa08 100644 (file)
--- a/sidebar.h
+++ b/sidebar.h
@@ -1,8 +1,13 @@
 /**
+ * @file
+ * GUI display the mailboxes in a side panel
+ *
+ * @authors
  * Copyright (C) 2004 Justin Hibbits <jrh29@po.cwru.edu>
  * Copyright (C) 2004 Thomer M. Gil <mutt@thomer.com>
  * Copyright (C) 2015-2016 Richard Russon <rich@flatcap.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -18,7 +23,7 @@
  */
 
 #ifndef _MUTT_SIDEBAR_H
-#define _MUTT_SIDEBAR_H 1
+#define _MUTT_SIDEBAR_H
 
 struct Context;
 struct Buffy;
index c7ff83ec5e86de2df0c027b5d87a7bbf85b3a92e..4468276abb81fd5294d2028607946978dfe7a328 100644 (file)
--- a/signal.c
+++ b/signal.c
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Signal handling
+ *
+ * @authors
  * Copyright (C) 1996-2000,2012 Michael R. Elkins <me@mutt.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
diff --git a/smtp.c b/smtp.c
index 850bca30a7a2a9ab9bf3459e1d8f61dac6378c06..3d8876c46e9a6cfdae778c0cd1daad49e8191912 100644 (file)
--- a/smtp.c
+++ b/smtp.c
@@ -1,7 +1,12 @@
 /**
+ * @file
+ * Send email to an SMTP server
+ *
+ * @authors
  * Copyright (C) 2002 Michael R. Elkins <me@mutt.org>
  * Copyright (C) 2005-2009 Brendan Cully <brendan@kublai.com>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
diff --git a/sort.c b/sort.c
index 730397e596bde7290a99796f2e223f503c6f6db2..98cf7e993eb7d11075d0c1fb543ee84fc8306078 100644 (file)
--- a/sort.c
+++ b/sort.c
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Assorted sorting methods
+ *
+ * @authors
  * Copyright (C) 1996-2000 Michael R. Elkins <me@mutt.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
diff --git a/sort.h b/sort.h
index 3319db8eb25fdcd7182dd55d9d23b3c88bd9f42f..7a539e77d7d7a1ae2ab29d4f37063465675fa72f 100644 (file)
--- a/sort.h
+++ b/sort.h
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Assorted sorting methods
+ *
+ * @authors
  * Copyright (C) 1996-2000 Michael R. Elkins <me@mutt.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -16,7 +21,7 @@
  */
 
 #ifndef _MUTT_SORT_H
-#define _MUTT_SORT_H 1
+#define _MUTT_SORT_H
 
 #include "mapping.h"
 #include "where.h"
diff --git a/state.h b/state.h
index 2885b0d29be26e91d94d6ffb13462360351318b2..4be1231743303298490d040dfb9a56552f22cdb9 100644 (file)
--- a/state.h
+++ b/state.h
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Keep track when processing files
+ *
+ * @authors
  * Copyright (C) 2017 Richard Russon <rich@flatcap.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -16,7 +21,7 @@
  */
 
 #ifndef _MUTT_STATE_H
-#define _MUTT_STATE_H 1
+#define _MUTT_STATE_H
 
 #include <stdio.h>
 
index d346680ae70401a6b0001874e171bc151a892af2..8374640f19d5292932113cd694ae9d68090c2a74 100644 (file)
--- a/status.c
+++ b/status.c
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * GUI display a user-configurable status line
+ *
+ * @authors
  * Copyright (C) 1996-2000,2007 Michael R. Elkins <me@mutt.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 23b20f06e52efc34322b81e2f92645a0307e1fd7..14c01ea31ef4c2a471417e4d6c5db3b5595770d2 100644 (file)
--- a/system.c
+++ b/system.c
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Execute external programs
+ *
+ * @authors
  * Copyright (C) 1996-2000,2013 Michael R. Elkins <me@mutt.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 6da0fcddc7290867c4d6ea028c8490a7bcbe8fc2..7b7e770a4a2ff84214f6421c3639d868c2a25fa2 100644 (file)
--- a/thread.c
+++ b/thread.c
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Create/manipulate threading in emails
+ *
+ * @authors
  * Copyright (C) 1996-2002 Michael R. Elkins <me@mutt.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index cb8461f9fba90e82b246af934270557f50df3918..262ee7baef3821df24ea6edf1c9678a3921e5b31 100644 (file)
--- a/thread.h
+++ b/thread.h
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Create/manipulate threading in emails
+ *
+ * @authors
  * Copyright (C) 2017 Richard Russon <rich@flatcap.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -16,7 +21,7 @@
  */
 
 #ifndef _MUTT_THREAD_H
-#define _MUTT_THREAD_H 1
+#define _MUTT_THREAD_H
 
 #include <stdbool.h>
 
diff --git a/txt2c.c b/txt2c.c
index 19497cfa3c4249bf57f28a32d853349763972905..1a0d21d67c905b5274c0f977847ca96178d7afd0 100644 (file)
--- a/txt2c.c
+++ b/txt2c.c
@@ -1,4 +1,9 @@
 /**
+ * @file
+ * Encode the compilation options as a C-string
+ *
+ * @authors
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
diff --git a/url.c b/url.c
index 184b177d6a5570edbfa5760d5f09c1d8cf4376f5..dc2caf779cb260fd71840f4141e760bc3f810052 100644 (file)
--- a/url.c
+++ b/url.c
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Parse and identify different URL schemes
+ *
+ * @authors
  * Copyright (C) 2000-2002,2004 Thomas Roessler <roessler@does-not-exist.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
diff --git a/url.h b/url.h
index ad4ec142d411668c2938fe3bdab9136243a7a656..0cd49fea63cde146cd84a5684e3618970f1fee04 100644 (file)
--- a/url.h
+++ b/url.h
@@ -1,4 +1,9 @@
 /**
+ * @file
+ * Parse and identify different URL schemes
+ *
+ * @authors
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -14,7 +19,7 @@
  */
 
 #ifndef _MUTT_URL_H
-#define _MUTT_URL_H 1
+#define _MUTT_URL_H
 
 #include <stddef.h>
 
diff --git a/utf8.c b/utf8.c
index 73b9fcd48fb7d4a7201508f02b11e5c8da5c86a4..cb00fadee0063c5818ae99a0bad5a29ef3a5cb0c 100644 (file)
--- a/utf8.c
+++ b/utf8.c
@@ -1,4 +1,9 @@
 /**
+ * @file
+ * For systems lacking wide character functions
+ *
+ * @authors
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 74295e13fc15732c3bf1d265ede21281803fa672..8f2ec7c9533b35fd74eb681725cec9dc5e00d46b 100644 (file)
--- a/version.c
+++ b/version.c
@@ -1,8 +1,13 @@
 /**
+ * @file
+ * Display version and copyright about NeoMutt
+ *
+ * @authors
  * Copyright (C) 1996-2007 Michael R. Elkins <me@mutt.org>
  * Copyright (C) 1999-2007 Thomas Roessler <roessler@does-not-exist.org>
  * Copyright (C) 2016-2017 Richard Russon <rich@flatcap.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index 674c5d354e12477741c220d3962c4f9f0b336e31..a7d05315c6509721f760cb95b12ae9af744721c9 100644 (file)
--- a/version.h
+++ b/version.h
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Display version and copyright about NeoMutt
+ *
+ * @authors
  * Copyright (C) 2016 Richard Russon <rich@flatcap.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -16,7 +21,7 @@
  */
 
 #ifndef _MUTT_VERSION_H
-#define _MUTT_VERSION_H 1
+#define _MUTT_VERSION_H
 
 #include <stdbool.h>
 
index 85d86a47f429d9f453da5fc064ae6787693eea82..939f556a348c82c94adbe793840c712a58624831 100644 (file)
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * For systems lacking wcscasecmp()
+ *
+ * @authors
  * Copyright (C) 2009 Rocco Rutte <pdmef@gmx.net>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
index f5c6080cdfb4775d383b2b2a4f58de585c6f6781..693ed06abbe4f81ce0185e68e24e55393fab27d6 100644 (file)
--- a/wcwidth.c
+++ b/wcwidth.c
@@ -1,4 +1,7 @@
 /**
+ * @file
+ * For systems lacking wide character functions
+ *
  * This is an implementation of wcwidth() and wcswidth() (defined in
  * IEEE Std 1002.1-2001) for Unicode.
  *
diff --git a/where.h b/where.h
index 7e59f0104827c0601b8c2507caadbd56daa33490..42ec8af46785843727ec5553cda5d338159963d7 100644 (file)
--- a/where.h
+++ b/where.h
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * An evil macro
+ *
+ * @authors
  * Copyright (C) 2017 Richard Russon <rich@flatcap.org>
  *
+ * @copyright
  * This program is free software: you can redistribute it and/or modify it under
  * the terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 2 of the License, or (at your option) any later
@@ -16,7 +21,7 @@
  */
 
 #ifndef _MUTT_WHERE_H
-#define _MUTT_WHERE_H 1
+#define _MUTT_WHERE_H
 
 #ifdef MAIN_C
 #define WHERE