core: Clarify documentation of tofu_stats address
authorAndre Heinecke <aheinecke@intevation.de>
Fri, 1 Jul 2016 14:47:04 +0000 (16:47 +0200)
committerAndre Heinecke <aheinecke@intevation.de>
Fri, 1 Jul 2016 14:47:04 +0000 (16:47 +0200)
* src/gpgme.h.in: Mention that Address is not always in addr-spec.

--
The old comment made it look like you could always expect the
address to be parsable as a mailbox address.

src/gpgme.h.in

index 790485d..cdb7037 100644 (file)
@@ -1559,7 +1559,12 @@ struct _gpgme_tofu_info
 {
   struct _gpgme_tofu_info *next;
 
-  /* The mail address (addr-spec from RFC5322) of the tofu binding.  */
+  /* The mail address (addr-spec from RFC5322) of the tofu binding.
+   *
+   * If no mail address is set for a User ID this is the name used
+   * for the user ID. Can be ambiguous when the same mail address or
+   * name is used in multiple user ids.
+   */
   char *address;
 
   /* The fingerprint of the primary key.  */