From: Richard Russon <rich@flatcap.org>
Date: Tue, 20 Aug 2019 10:42:51 +0000 (+0100)
Subject: doxy: add autocrypt pages
X-Git-Tag: 2019-10-25~95
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=08415cd851ff922574f158347fbce3c3625fc6c4;p=neomutt

doxy: add autocrypt pages
---

diff --git a/autocrypt/autocrypt.c b/autocrypt/autocrypt.c
index 079e86fc8..d449780f0 100644
--- a/autocrypt/autocrypt.c
+++ b/autocrypt/autocrypt.c
@@ -1,6 +1,6 @@
 /**
  * @file
- * Autocrypt feature
+ * Autocrypt end-to-end encryption
  *
  * @authors
  * Copyright (C) 2019 Kevin J. McCarthy <kevin@8t8.us>
@@ -20,6 +20,12 @@
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page autocrypt_autocrypt Autocrypt end-to-end encryption
+ *
+ * Autocrypt end-to-end encryption
+ */
+
 #include "config.h"
 #include <errno.h>
 #include <string.h>
diff --git a/autocrypt/autocrypt.h b/autocrypt/autocrypt.h
index 3ae6be826..e4293c94f 100644
--- a/autocrypt/autocrypt.h
+++ b/autocrypt/autocrypt.h
@@ -1,6 +1,6 @@
 /**
  * @file
- * Autocrypt feature
+ * Autocrypt end-to-end encryption
  *
  * @authors
  * Copyright (C) 2019 Kevin J. McCarthy <kevin@8t8.us>
@@ -20,6 +20,20 @@
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page autocrypt AUTOCRYPT: End-to-end encryption
+ *
+ * Autocrypt end-to-end encryption
+ *
+ * | File                            | Description                  |
+ * | :------------------------------ | :--------------------------- |
+ * | autocrypt/autocrypt.c           | @subpage autocrypt_autocrypt |
+ * | autocrypt/autocrypt_acct_menu.c | @subpage autocrypt_account   |
+ * | autocrypt/autocrypt_db.c        | @subpage autocrypt_db        |
+ * | autocrypt/autocrypt_gpgme.c     | @subpage autocrypt_gpgme     |
+ * | autocrypt/autocrypt_schema.c    | @subpage autocrypt_schema    |
+ */
+
 #ifndef MUTT_AUTOCRYPT_AUTOCRYPT_H
 #define MUTT_AUTOCRYPT_AUTOCRYPT_H
 
diff --git a/autocrypt/autocrypt_acct_menu.c b/autocrypt/autocrypt_acct_menu.c
index 7d259377e..289a911a0 100644
--- a/autocrypt/autocrypt_acct_menu.c
+++ b/autocrypt/autocrypt_acct_menu.c
@@ -20,6 +20,12 @@
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page autocrypt_account Autocrypt account menu
+ *
+ * Autocrypt account menu
+ */
+
 #include "config.h"
 #include <stdbool.h>
 #include <stdio.h>
@@ -82,11 +88,11 @@ static const struct Mapping AutocryptAcctHelp[] = {
  *
  * | Expando | Description
  * |:--------|:-----------------------------------------------------------------
- * | \%a     | Email address                 
- * | \%k     | Gpg keyid                     
- * | \%n     | Current entry number          
- * | \%p     | Prefer-encrypt flag           
- * | \%s     | Status flag (active/inactive) 
+ * | \%a     | Email address
+ * | \%k     | Gpg keyid
+ * | \%n     | Current entry number
+ * | \%p     | Prefer-encrypt flag
+ * | \%s     | Status flag (active/inactive)
  */
 static const char *account_format_str(char *dest, size_t destlen, size_t col, int cols,
                                       char op, const char *src, const char *fmt,
diff --git a/autocrypt/autocrypt_db.c b/autocrypt/autocrypt_db.c
index 6d15e87ba..cab10091e 100644
--- a/autocrypt/autocrypt_db.c
+++ b/autocrypt/autocrypt_db.c
@@ -20,6 +20,12 @@
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page autocrypt_db Autocrypt database handling
+ *
+ * Autocrypt database handling
+ */
+
 #include "config.h"
 #include <stddef.h>
 #include <sqlite3.h>
diff --git a/autocrypt/autocrypt_gpgme.c b/autocrypt/autocrypt_gpgme.c
index 18cec8810..4878e6dda 100644
--- a/autocrypt/autocrypt_gpgme.c
+++ b/autocrypt/autocrypt_gpgme.c
@@ -20,6 +20,12 @@
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page autocrypt_gpgme Autocrypt GPGME handler
+ *
+ * Autocrypt GPGME handler
+ */
+
 #include "config.h"
 #include <stddef.h>
 #include <gpgme.h>
diff --git a/autocrypt/autocrypt_schema.c b/autocrypt/autocrypt_schema.c
index b8b982ad1..9021a5517 100644
--- a/autocrypt/autocrypt_schema.c
+++ b/autocrypt/autocrypt_schema.c
@@ -20,6 +20,12 @@
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @page autocrypt_schema Autocrypt database schema
+ *
+ * Autocrypt database schema
+ */
+
 #include "config.h"
 #include <stddef.h>
 #include <sqlite3.h>