From: Werner Koch Date: Wed, 2 May 2012 08:35:47 +0000 (+0200) Subject: Fix minor documentation problem. X-Git-Tag: gpgme-1.3.2~2 X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=475640a52742b333d7c3c8235ee945ba42197883;p=gpgme.git Fix minor documentation problem. -- Fixes bug#1404. (There is mentioned data field “recipient”, but actual data field name is “recipients”.) --- diff --git a/doc/gpgme.texi b/doc/gpgme.texi index 72b9e22..61cdb37 100644 --- a/doc/gpgme.texi +++ b/doc/gpgme.texi @@ -41,7 +41,7 @@ General Public License for more details. @end macro -@c +@c @c T I T L E P A G E @c @ifinfo @@ -153,7 +153,7 @@ Error Handling * Error Sources:: A list of important error sources. * Error Strings:: How to get a descriptive string from a value. -Exchanging Data +Exchanging Data * Creating Data Buffers:: Creating new data buffers. * Destroying Data Buffers:: Releasing data buffers. @@ -1543,7 +1543,7 @@ Memory based data objects store all data in allocated memory. This is convenient, but only practical for an amount of data that is a fraction of the available physical memory. The data has to be copied from its source and to its destination, which can often be avoided by -using one of the other data object +using one of the other data object @deftypefun gpgme_error_t gpgme_data_new (@w{gpgme_data_t *@var{dh}}) The function @code{gpgme_data_new} creates a new @code{gpgme_data_t} @@ -1987,7 +1987,7 @@ the data object with the handle @var{dh} to @var{enc}. @c @c Chapter Contexts -@c +@c @node Contexts @chapter Contexts @cindex context @@ -2726,7 +2726,7 @@ issuer name. @item char *chain_id If @code{protocol} is @code{GPGME_PROTOCOL_CMS}, then this is the chain ID, which can be used to built the certificate chain. - + @item gpgme_validity_t owner_trust If @code{protocol} is @code{GPGME_PROTOCOL_OpenPGP}, then this is the owner trust. @@ -3513,7 +3513,7 @@ are reported by the crypto engine support routines. @cindex key ring, import to Importing keys means the same as running @command{gpg} with the command -@option{--import}. +@option{--import}. @deftypefun gpgme_error_t gpgme_op_import (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_data_t @var{keydata}}) @@ -4101,7 +4101,7 @@ algorithm that is not supported. @item unsigned int wrong_key_usage : 1 This is true if the key was not used according to its policy. -@item gpgme_recipient_t recipient +@item gpgme_recipient_t recipients This is a linked list of recipients to which this message was encrypted. @item char *file_name @@ -4265,16 +4265,16 @@ The defined bits are: Can't verify due to a missing key or certificate. @item GPGME_SIGSUM_CRL_MISSING - The CRL (or an equivalent mechanism) is not available. + The CRL (or an equivalent mechanism) is not available. @item GPGME_SIGSUM_CRL_TOO_OLD Available CRL is too old. @item GPGME_SIGSUM_BAD_POLICY - A policy requirement was not met. + A policy requirement was not met. @item GPGME_SIGSUM_SYS_ERROR - A system error occured. + A system error occured. @end table @item char *fpr @@ -4339,7 +4339,7 @@ Values are: @item 0 No PKA information available or verification not possible. @item 1 - PKA verification failed. + PKA verification failed. @item 2 PKA verification succeeded. @item 3 @@ -4459,7 +4459,7 @@ have a different status. You can get each key's status with @deftypefun {const char *} gpgme_get_sig_status (@w{gpgme_ctx_t @var{ctx}}, @w{int @var{idx}}, @w{gpgme_sig_stat_t *@var{r_stat}}, @w{time_t *@var{r_created}}) The function @code{gpgme_get_sig_status} is equivalent to: - + @example gpgme_verify_result_t result; gpgme_signature_t sig; @@ -4482,27 +4482,27 @@ The function @code{gpgme_get_sig_status} is equivalent to: case GPG_ERR_NO_ERROR: *r_stat = GPGME_SIG_STAT_GOOD; break; - + case GPG_ERR_BAD_SIGNATURE: *r_stat = GPGME_SIG_STAT_BAD; break; - + case GPG_ERR_NO_PUBKEY: *r_stat = GPGME_SIG_STAT_NOKEY; break; - + case GPG_ERR_NO_DATA: *r_stat = GPGME_SIG_STAT_NOSIG; break; - + case GPG_ERR_SIG_EXPIRED: *r_stat = GPGME_SIG_STAT_GOOD_EXP; break; - + case GPG_ERR_KEY_EXPIRED: *r_stat = GPGME_SIG_STAT_GOOD_EXPKEY; break; - + default: *r_stat = GPGME_SIG_STAT_ERROR; break; @@ -4516,7 +4516,7 @@ The function @code{gpgme_get_sig_status} is equivalent to: @deftypefun {const char *} gpgme_get_sig_string_attr (@w{gpgme_ctx_t @var{ctx}}, @w{int @var{idx}}, @w{gpgme_attr_t @var{what}}, @w{int @var{whatidx}}) The function @code{gpgme_get_sig_string_attr} is equivalent to: - + @example gpgme_verify_result_t result; gpgme_signature_t sig; @@ -4552,7 +4552,7 @@ The function @code{gpgme_get_sig_string_attr} is equivalent to: @deftypefun {const char *} gpgme_get_sig_ulong_attr (@w{gpgme_ctx_t @var{ctx}}, @w{int @var{idx}}, @w{gpgme_attr_t @var{waht}}, @w{int @var{whatidx}}) The function @code{gpgme_get_sig_ulong_attr} is equivalent to: - + @example gpgme_verify_result_t result; gpgme_signature_t sig; @@ -4584,22 +4584,22 @@ The function @code{gpgme_get_sig_ulong_attr} is equivalent to: @{ case GPG_ERR_NO_ERROR: return GPGME_SIG_STAT_GOOD; - + case GPG_ERR_BAD_SIGNATURE: return GPGME_SIG_STAT_BAD; - + case GPG_ERR_NO_PUBKEY: return GPGME_SIG_STAT_NOKEY; - + case GPG_ERR_NO_DATA: return GPGME_SIG_STAT_NOSIG; - + case GPG_ERR_SIG_EXPIRED: return GPGME_SIG_STAT_GOOD_EXP; - + case GPG_ERR_KEY_EXPIRED: return GPGME_SIG_STAT_GOOD_EXPKEY; - + default: return GPGME_SIG_STAT_ERROR; @} @@ -5671,7 +5671,7 @@ struct IOCB @{ class MyApp : public QApplication @{ // ... - + static void registerGpgmeIOCallback( void * data, int fd, int dir, GpgmeIOCb func, void * func_data, void ** tag ) @{