doxy: add autocrypt pages

diff --git a/autocrypt/autocrypt.c b/autocrypt/autocrypt.c
index 079e86fc86ffc072df5343e1225c0dada3e55732..d449780f00e424630748e2d3574d350550fe2df2 100644 (file)
--- 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 3ae6be8266f0bb2f3de8fd3da3c2ffd8f343520d..e4293c94fb7c1da3569f25fc4d366d888f74f2d9 100644 (file)
--- 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 7d259377eb5dc262110e116a0c52cf4db6123e94..289a911a0daae21cbf5c19930d89b9b8f83ab23e 100644 (file)
--- 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 6d15e87ba9c901fac937d9bd93f68def57b1cb9c..cab10091e50edd53325001a11e61850a891cd357 100644 (file)
--- 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 18cec8810732fdfa735cded5d53bc55310a4f826..4878e6ddabbbfb08be265cd308a9b7c10c7b9329 100644 (file)
--- 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 b8b982ad19f76ba4ce7897afd3732677b35db26c..9021a5517828bc1ea0e904cace801015566e74b1 100644 (file)
--- 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>