summaryrefslogtreecommitdiff
path: root/lib/openpgp
diff options
context:
space:
mode:
authorSimon Josefsson <simon@josefsson.org>2010-02-17 12:35:31 +0100
committerSimon Josefsson <simon@josefsson.org>2010-02-17 12:35:31 +0100
commitc1953c310b347bcb6401ef825265c10518d7c977 (patch)
treeeba10ccfb618847e1f388a573a4782f07c72ba06 /lib/openpgp
parent5cf6a95171b1a88b13dd7043fb8e0e4f21b90a1d (diff)
downloadgnutls-c1953c310b347bcb6401ef825265c10518d7c977.tar.gz
Fix GTK-DOC syntax. Unfortunately this looses some information.
Diffstat (limited to 'lib/openpgp')
-rw-r--r--lib/openpgp/compat.c8
-rw-r--r--lib/openpgp/extras.c12
-rw-r--r--lib/openpgp/gnutls_openpgp.c20
-rw-r--r--lib/openpgp/output.c2
-rw-r--r--lib/openpgp/pgp.c60
-rw-r--r--lib/openpgp/pgpverify.c4
-rw-r--r--lib/openpgp/privkey.c44
7 files changed, 75 insertions, 75 deletions
diff --git a/lib/openpgp/compat.c b/lib/openpgp/compat.c
index 0f4a602ab3..3c5d881783 100644
--- a/lib/openpgp/compat.c
+++ b/lib/openpgp/compat.c
@@ -32,7 +32,7 @@
#include <openpgp_int.h>
/*-
- * gnutls_openpgp_verify_key - Verify all signatures on the key
+ * gnutls_openpgp_verify_key:
* @cert_list: the structure that holds the certificates.
* @cert_list_lenght: the items in the cert_list.
* @status: the output of the verification function
@@ -108,7 +108,7 @@ leave:
}
/*-
- * gnutls_openpgp_fingerprint - Gets the fingerprint
+ * gnutls_openpgp_fingerprint:
* @cert: the raw data that contains the OpenPGP public key.
* @fpr: the buffer to save the fingerprint.
* @fprlen: the integer to save the length of the fingerprint.
@@ -149,7 +149,7 @@ _gnutls_openpgp_fingerprint (const gnutls_datum_t * cert,
}
/*-
- * gnutls_openpgp_get_raw_key_creation_time - Extract the timestamp
+ * gnutls_openpgp_get_raw_key_creation_time:
* @cert: the raw data that contains the OpenPGP public key.
*
* Returns the timestamp when the OpenPGP key was created.
@@ -184,7 +184,7 @@ _gnutls_openpgp_get_raw_key_creation_time (const gnutls_datum_t * cert)
/*-
- * gnutls_openpgp_get_raw_key_expiration_time - Extract the expire date
+ * gnutls_openpgp_get_raw_key_expiration_time:
* @cert: the raw data that contains the OpenPGP public key.
*
* Returns the time when the OpenPGP key expires. A value of '0' means
diff --git a/lib/openpgp/extras.c b/lib/openpgp/extras.c
index 60261c9ee3..82a29c5020 100644
--- a/lib/openpgp/extras.c
+++ b/lib/openpgp/extras.c
@@ -38,7 +38,7 @@
*/
/**
- * gnutls_openpgp_keyring_init - initializes a #gnutls_openpgp_keyring_t structure
+ * gnutls_openpgp_keyring_init:
* @keyring: The structure to be initialized
*
* This function will initialize an keyring structure.
@@ -57,7 +57,7 @@ gnutls_openpgp_keyring_init (gnutls_openpgp_keyring_t * keyring)
/**
- * gnutls_openpgp_keyring_deinit - deinitializes memory used by a #gnutls_openpgp_keyring_t structure
+ * gnutls_openpgp_keyring_deinit:
* @keyring: The structure to be initialized
*
* This function will deinitialize a keyring structure.
@@ -78,7 +78,7 @@ gnutls_openpgp_keyring_deinit (gnutls_openpgp_keyring_t keyring)
}
/**
- * gnutls_openpgp_keyring_check_id - Check if a key id exists in the keyring
+ * gnutls_openpgp_keyring_check_id:
* @ring: holds the keyring to check against
* @keyid: will hold the keyid to check for.
* @flags: unused (should be 0)
@@ -110,7 +110,7 @@ gnutls_openpgp_keyring_check_id (gnutls_openpgp_keyring_t ring,
}
/**
- * gnutls_openpgp_keyring_import - Import a raw- or Base64-encoded keyring
+ * gnutls_openpgp_keyring_import:
* @keyring: The structure to store the parsed key.
* @data: The RAW or BASE64 encoded keyring.
* @format: One of #gnutls_openpgp_keyring_fmt elements.
@@ -210,7 +210,7 @@ error:
cdk_kbnode_find_packet (node, CDK_PKT_PUBLIC_KEY)!=NULL
/**
- * gnutls_openpgp_keyring_get_crt_count - return the number of certificates
+ * gnutls_openpgp_keyring_get_crt_count:
* @ring: is an OpenPGP key ring
*
* This function will return the number of OpenPGP certificates
@@ -256,7 +256,7 @@ gnutls_openpgp_keyring_get_crt_count (gnutls_openpgp_keyring_t ring)
}
/**
- * gnutls_openpgp_keyring_get_crt - export an openpgp certificate from a keyring
+ * gnutls_openpgp_keyring_get_crt:
* @ring: Holds the keyring.
* @idx: the index of the certificate to export
* @cert: An uninitialized #gnutls_openpgp_crt_t structure
diff --git a/lib/openpgp/gnutls_openpgp.c b/lib/openpgp/gnutls_openpgp.c
index 1c6818e4d9..511c4d7374 100644
--- a/lib/openpgp/gnutls_openpgp.c
+++ b/lib/openpgp/gnutls_openpgp.c
@@ -116,7 +116,7 @@ _gnutls_openpgp_raw_crt_to_gcert (gnutls_cert * gcert,
}
/**
- * gnutls_certificate_set_openpgp_key - Used to set keys in a gnutls_certificate_credentials_t structure
+ * gnutls_certificate_set_openpgp_key:
* @res: is a #gnutls_certificate_credentials_t structure.
* @key: contains an openpgp public key
* @pkey: is an openpgp private key
@@ -199,7 +199,7 @@ gnutls_certificate_set_openpgp_key (gnutls_certificate_credentials_t res,
}
/*-
- * gnutls_openpgp_get_key - Retrieve a key from the keyring.
+ * gnutls_openpgp_get_key:
* @key: the destination context to save the key.
* @keyring: the datum struct that contains all keyring information.
* @attr: The attribute (keyid, fingerprint, ...).
@@ -273,7 +273,7 @@ leave:
}
/**
- * gnutls_certificate_set_openpgp_key_mem - Used to set OpenPGP keys
+ * gnutls_certificate_set_openpgp_key_mem:
* @res: the destination context to save the data.
* @cert: the datum that contains the public key.
* @key: the datum that contains the secret key.
@@ -297,7 +297,7 @@ gnutls_certificate_set_openpgp_key_mem (gnutls_certificate_credentials_t res,
/**
- * gnutls_certificate_set_openpgp_key_file - Used to set OpenPGP keys
+ * gnutls_certificate_set_openpgp_key_file:
* @res: the destination context to save the data.
* @certfile: the file that contains the public key.
* @keyfile: the file that contains the secret key.
@@ -342,7 +342,7 @@ get_keyid (gnutls_openpgp_keyid_t keyid, const char *str)
}
/**
- * gnutls_certificate_set_openpgp_key_mem2 - Used to set OpenPGP keys
+ * gnutls_certificate_set_openpgp_key_mem2:
* @res: the destination context to save the data.
* @cert: the datum that contains the public key.
* @key: the datum that contains the secret key.
@@ -440,7 +440,7 @@ gnutls_certificate_set_openpgp_key_mem2 (gnutls_certificate_credentials_t res,
/**
- * gnutls_certificate_set_openpgp_key_file2 - Used to set OpenPGP keys
+ * gnutls_certificate_set_openpgp_key_file2:
* @res: the destination context to save the data.
* @certfile: the file that contains the public key.
* @keyfile: the file that contains the secret key.
@@ -553,7 +553,7 @@ gnutls_openpgp_count_key_names (const gnutls_datum_t * cert)
/**
- * gnutls_certificate_set_openpgp_keyring_file - Sets a keyring file for OpenPGP
+ * gnutls_certificate_set_openpgp_keyring_file:
* @c: A certificate credentials structure
* @file: filename of the keyring.
* @format: format of keyring.
@@ -599,7 +599,7 @@ gnutls_certificate_set_openpgp_keyring_file (gnutls_certificate_credentials_t
}
/**
- * gnutls_certificate_set_openpgp_keyring_mem - Add keyring data for OpenPGP
+ * gnutls_certificate_set_openpgp_keyring_mem:
* @c: A certificate credentials structure
* @data: buffer with keyring data.
* @dlen: length of data buffer.
@@ -706,7 +706,7 @@ error:
}
/**
- * gnutls_openpgp_set_recv_key_function - Used to set a key retrieval callback for PGP keys
+ * gnutls_openpgp_set_recv_key_function:
* @session: a TLS session
* @func: the callback
*
@@ -913,7 +913,7 @@ _gnutls_openpgp_crt_to_gcert (gnutls_cert * gcert, gnutls_openpgp_crt_t cert)
/**
- * gnutls_openpgp_privkey_sign_hash - sign the given data using the private key params
+ * gnutls_openpgp_privkey_sign_hash:
* @key: Holds the key
* @hash: holds the data to be signed
* @signature: will contain newly allocated signature
diff --git a/lib/openpgp/output.c b/lib/openpgp/output.c
index 996d9f359a..00543fbf61 100644
--- a/lib/openpgp/output.c
+++ b/lib/openpgp/output.c
@@ -493,7 +493,7 @@ print_oneline (gnutls_string * str, gnutls_openpgp_crt_t cert)
}
/**
- * gnutls_openpgp_crt_print - Pretty print OpenPGP certificates
+ * gnutls_openpgp_crt_print:
* @cert: The structure to be printed
* @format: Indicate the format to use
* @out: Newly allocated datum with zero terminated string.
diff --git a/lib/openpgp/pgp.c b/lib/openpgp/pgp.c
index 6e2a1227ba..1f3a677363 100644
--- a/lib/openpgp/pgp.c
+++ b/lib/openpgp/pgp.c
@@ -35,7 +35,7 @@
#include <gnutls_num.h>
/**
- * gnutls_openpgp_crt_init - initialize a #gnutls_openpgp_crt_t structure
+ * gnutls_openpgp_crt_init:
* @key: The structure to be initialized
*
* This function will initialize an OpenPGP key structure.
@@ -53,7 +53,7 @@ gnutls_openpgp_crt_init (gnutls_openpgp_crt_t * key)
}
/**
- * gnutls_openpgp_crt_deinit - deinitialize memory used by a #gnutls_openpgp_crt_t structure
+ * gnutls_openpgp_crt_deinit:
* @key: The structure to be initialized
*
* This function will deinitialize a key structure.
@@ -74,7 +74,7 @@ gnutls_openpgp_crt_deinit (gnutls_openpgp_crt_t key)
}
/**
- * gnutls_openpgp_crt_import - import a RAW or BASE64 encoded key
+ * gnutls_openpgp_crt_import:
* @key: The structure to store the parsed key.
* @data: The RAW or BASE64 encoded key.
* @format: One of gnutls_openpgp_crt_fmt_t elements.
@@ -213,7 +213,7 @@ _gnutls_openpgp_export (cdk_kbnode_t node,
}
/**
- * gnutls_openpgp_crt_export - export a RAW or BASE64 encoded key
+ * gnutls_openpgp_crt_export:
* @key: Holds the key.
* @format: One of gnutls_openpgp_crt_fmt_t elements.
* @output_data: will contain the key base64 encoded or raw
@@ -236,7 +236,7 @@ gnutls_openpgp_crt_export (gnutls_openpgp_crt_t key,
}
/**
- * gnutls_openpgp_crt_get_fingerprint - Gets the fingerprint
+ * gnutls_openpgp_crt_get_fingerprint:
* @key: the raw data that contains the OpenPGP public key.
* @fpr: the buffer to save the fingerprint, must hold at least 20 bytes.
* @fprlen: the integer to save the length of the fingerprint.
@@ -303,7 +303,7 @@ _gnutls_openpgp_count_key_names (gnutls_openpgp_crt_t key)
/**
- * gnutls_openpgp_crt_get_name - Extracts the userID
+ * gnutls_openpgp_crt_get_name:
* @key: the structure that contains the OpenPGP public key.
* @idx: the index of the ID to extract
* @buf: a pointer to a structure to hold the name, may be %NULL
@@ -375,7 +375,7 @@ gnutls_openpgp_crt_get_name (gnutls_openpgp_crt_t key,
}
/**
- * gnutls_openpgp_crt_get_pk_algorithm - return the key's PublicKey algorithm
+ * gnutls_openpgp_crt_get_pk_algorithm:
* @key: is an OpenPGP key
* @bits: if bits is non null it will hold the size of the parameters' in bits
*
@@ -416,7 +416,7 @@ gnutls_openpgp_crt_get_pk_algorithm (gnutls_openpgp_crt_t key,
/**
- * gnutls_openpgp_crt_get_version - Extracts the version of the key.
+ * gnutls_openpgp_crt_get_version:
* @key: the structure that contains the OpenPGP public key.
*
* Extract the version of the OpenPGP key.
@@ -443,7 +443,7 @@ gnutls_openpgp_crt_get_version (gnutls_openpgp_crt_t key)
/**
- * gnutls_openpgp_crt_get_creation_time - Extract the timestamp
+ * gnutls_openpgp_crt_get_creation_time:
* @key: the structure that contains the OpenPGP public key.
*
* Get key creation time.
@@ -470,7 +470,7 @@ gnutls_openpgp_crt_get_creation_time (gnutls_openpgp_crt_t key)
/**
- * gnutls_openpgp_crt_get_expiration_time - Extract the expire date
+ * gnutls_openpgp_crt_get_expiration_time:
* @key: the structure that contains the OpenPGP public key.
*
* Get key expiration time. A value of '0' means that the key doesn't
@@ -497,7 +497,7 @@ gnutls_openpgp_crt_get_expiration_time (gnutls_openpgp_crt_t key)
}
/**
- * gnutls_openpgp_crt_get_key_id - Gets the keyID
+ * gnutls_openpgp_crt_get_key_id:
* @key: the structure that contains the OpenPGP public key.
* @keyid: the buffer to save the keyid.
*
@@ -532,7 +532,7 @@ gnutls_openpgp_crt_get_key_id (gnutls_openpgp_crt_t key,
}
/**
- * gnutls_openpgp_crt_get_revoked_status - Gets the revoked status of the key
+ * gnutls_openpgp_crt_get_revoked_status:
* @key: the structure that contains the OpenPGP public key.
*
* Get revocation status of key.
@@ -563,7 +563,7 @@ gnutls_openpgp_crt_get_revoked_status (gnutls_openpgp_crt_t key)
}
/**
- * gnutls_openpgp_crt_check_hostname - compare hostname with the key's hostname
+ * gnutls_openpgp_crt_check_hostname:
* @key: should contain a #gnutls_openpgp_crt_t structure
* @hostname: A null terminated string that contains a DNS name
*
@@ -623,7 +623,7 @@ _gnutls_get_pgp_key_usage (unsigned int cdk_usage)
}
/**
- * gnutls_openpgp_crt_get_key_usage - This function returns the key's usage
+ * gnutls_openpgp_crt_get_key_usage:
* @key: should contain a gnutls_openpgp_crt_t structure
* @key_usage: where the key usage bits will be stored
*
@@ -655,7 +655,7 @@ gnutls_openpgp_crt_get_key_usage (gnutls_openpgp_crt_t key,
}
/**
- * gnutls_openpgp_crt_get_subkey_count - return the number of subkeys
+ * gnutls_openpgp_crt_get_subkey_count:
* @key: is an OpenPGP key
*
* This function will return the number of subkeys present in the
@@ -799,7 +799,7 @@ _gnutls_openpgp_find_subkey_idx (cdk_kbnode_t knode, uint32_t keyid[2],
}
/**
- * gnutls_openpgp_crt_get_subkey_revoked_status - Gets the revoked status of the key
+ * gnutls_openpgp_crt_get_subkey_revoked_status:
* @key: the structure that contains the OpenPGP public key.
* @idx: is the subkey index
*
@@ -832,7 +832,7 @@ gnutls_openpgp_crt_get_subkey_revoked_status (gnutls_openpgp_crt_t key,
}
/**
- * gnutls_openpgp_crt_get_subkey_pk_algorithm - return the subkey's PublicKey algorithm
+ * gnutls_openpgp_crt_get_subkey_pk_algorithm:
* @key: is an OpenPGP key
* @idx: is the subkey index
* @bits: if bits is non null it will hold the size of the parameters' in bits
@@ -877,7 +877,7 @@ gnutls_openpgp_crt_get_subkey_pk_algorithm (gnutls_openpgp_crt_t key,
}
/**
- * gnutls_openpgp_crt_get_subkey_creation_time - Extract the timestamp
+ * gnutls_openpgp_crt_get_subkey_creation_time:
* @key: the structure that contains the OpenPGP public key.
* @idx: the subkey index
*
@@ -908,7 +908,7 @@ gnutls_openpgp_crt_get_subkey_creation_time (gnutls_openpgp_crt_t key,
/**
- * gnutls_openpgp_crt_get_subkey_expiration_time - Extract the expire date
+ * gnutls_openpgp_crt_get_subkey_expiration_time:
* @key: the structure that contains the OpenPGP public key.
* @idx: the subkey index
*
@@ -939,7 +939,7 @@ gnutls_openpgp_crt_get_subkey_expiration_time (gnutls_openpgp_crt_t key,
}
/**
- * gnutls_openpgp_crt_get_subkey_id - Gets the keyID
+ * gnutls_openpgp_crt_get_subkey_id:
* @key: the structure that contains the OpenPGP public key.
* @idx: the subkey index
* @keyid: the buffer to save the keyid.
@@ -974,7 +974,7 @@ gnutls_openpgp_crt_get_subkey_id (gnutls_openpgp_crt_t key,
}
/**
- * gnutls_openpgp_crt_get_subkey_fingerprint - Gets the fingerprint of a subkey
+ * gnutls_openpgp_crt_get_subkey_fingerprint:
* @key: the raw data that contains the OpenPGP public key.
* @idx: the subkey index
* @fpr: the buffer to save the fingerprint, must hold at least 20 bytes.
@@ -1019,7 +1019,7 @@ gnutls_openpgp_crt_get_subkey_fingerprint (gnutls_openpgp_crt_t key,
}
/**
- * gnutls_openpgp_crt_get_subkey_idx - Returns the subkey's index
+ * gnutls_openpgp_crt_get_subkey_idx:
* @key: the structure that contains the OpenPGP public key.
* @keyid: the keyid.
*
@@ -1054,7 +1054,7 @@ gnutls_openpgp_crt_get_subkey_idx (gnutls_openpgp_crt_t key,
}
/**
- * gnutls_openpgp_crt_get_subkey_usage - returns the key's usage
+ * gnutls_openpgp_crt_get_subkey_usage:
* @key: should contain a gnutls_openpgp_crt_t structure
* @idx: the subkey index
* @key_usage: where the key usage bits will be stored
@@ -1404,7 +1404,7 @@ cleanup:
/**
- * gnutls_openpgp_crt_get_pk_rsa_raw - export the RSA public key
+ * gnutls_openpgp_crt_get_pk_rsa_raw:
* @crt: Holds the certificate
* @m: will hold the modulus
* @e: will hold the public exponent
@@ -1435,7 +1435,7 @@ gnutls_openpgp_crt_get_pk_rsa_raw (gnutls_openpgp_crt_t crt,
}
/**
- * gnutls_openpgp_crt_get_pk_dsa_raw - export the DSA public key
+ * gnutls_openpgp_crt_get_pk_dsa_raw:
* @crt: Holds the certificate
* @p: will hold the p
* @q: will hold the q
@@ -1469,7 +1469,7 @@ gnutls_openpgp_crt_get_pk_dsa_raw (gnutls_openpgp_crt_t crt,
}
/**
- * gnutls_openpgp_crt_get_subkey_pk_rsa_raw - export the RSA public key
+ * gnutls_openpgp_crt_get_subkey_pk_rsa_raw:
* @crt: Holds the certificate
* @idx: Is the subkey index
* @m: will hold the modulus
@@ -1503,7 +1503,7 @@ gnutls_openpgp_crt_get_subkey_pk_rsa_raw (gnutls_openpgp_crt_t crt,
}
/**
- * gnutls_openpgp_crt_get_subkey_pk_dsa_raw - export the DSA public key
+ * gnutls_openpgp_crt_get_subkey_pk_dsa_raw:
* @crt: Holds the certificate
* @idx: Is the subkey index
* @p: will hold the p
@@ -1541,7 +1541,7 @@ gnutls_openpgp_crt_get_subkey_pk_dsa_raw (gnutls_openpgp_crt_t crt,
}
/**
- * gnutls_openpgp_crt_get_preferred_key_id - Gets the preferred keyID
+ * gnutls_openpgp_crt_get_preferred_key_id:
* @key: the structure that contains the OpenPGP public key.
* @keyid: the struct to save the keyid.
*
@@ -1566,7 +1566,7 @@ gnutls_openpgp_crt_get_preferred_key_id (gnutls_openpgp_crt_t key,
}
/**
- * gnutls_openpgp_crt_set_preferred_key_id - Sets the preferred keyID
+ * gnutls_openpgp_crt_set_preferred_key_id:
* @key: the structure that contains the OpenPGP public key.
* @keyid: the selected keyid
*
@@ -1604,7 +1604,7 @@ gnutls_openpgp_crt_set_preferred_key_id (gnutls_openpgp_crt_t key,
}
/**
- * gnutls_openpgp_crt_get_auth_subkey - Gets the keyID of an authentication subkey
+ * gnutls_openpgp_crt_get_auth_subkey:
* @crt: the structure that contains the OpenPGP public key.
* @keyid: the struct to save the keyid.
* @flag: Non zero indicates that a valid subkey is always returned.
diff --git a/lib/openpgp/pgpverify.c b/lib/openpgp/pgpverify.c
index 0bad94baf0..8677de49ed 100644
--- a/lib/openpgp/pgpverify.c
+++ b/lib/openpgp/pgpverify.c
@@ -33,7 +33,7 @@
#include <gnutls_num.h>
/**
- * gnutls_openpgp_crt_verify_ring - Verify all signatures in the key
+ * gnutls_openpgp_crt_verify_ring:
* @key: the structure that holds the key.
* @keyring: holds the keyring to check against
* @flags: unused (should be 0)
@@ -117,7 +117,7 @@ gnutls_openpgp_crt_verify_ring (gnutls_openpgp_crt_t key,
/**
- * gnutls_openpgp_crt_verify_self - Verify the self signature on the key
+ * gnutls_openpgp_crt_verify_self:
* @key: the structure that holds the key.
* @flags: unused (should be 0)
* @verify: will hold the key verification output.
diff --git a/lib/openpgp/privkey.c b/lib/openpgp/privkey.c
index 6b8cdcaf8f..d27a9d187b 100644
--- a/lib/openpgp/privkey.c
+++ b/lib/openpgp/privkey.c
@@ -36,7 +36,7 @@
#include <gnutls_cert.h>
/**
- * gnutls_openpgp_privkey_init - initializes a #gnutls_openpgp_privkey_t structure
+ * gnutls_openpgp_privkey_init:
* @key: The structure to be initialized
*
* This function will initialize an OpenPGP key structure.
@@ -54,7 +54,7 @@ gnutls_openpgp_privkey_init (gnutls_openpgp_privkey_t * key)
}
/**
- * gnutls_openpgp_privkey_deinit - deinitializes memory used by a #gnutls_openpgp_privkey_t structure
+ * gnutls_openpgp_privkey_deinit:
* @key: The structure to be initialized
*
* This function will deinitialize a key structure.
@@ -75,7 +75,7 @@ gnutls_openpgp_privkey_deinit (gnutls_openpgp_privkey_t key)
}
/**
- * gnutls_openpgp_privkey_import - import a RAW or BASE64 encoded key
+ * gnutls_openpgp_privkey_import:
* @key: The structure to store the parsed key.
* @data: The RAW or BASE64 encoded key.
* @format: One of #gnutls_openpgp_crt_fmt_t elements.
@@ -159,7 +159,7 @@ gnutls_openpgp_privkey_import (gnutls_openpgp_privkey_t key,
}
/**
- * gnutls_openpgp_privkey_export - export a RAW or BASE64 encoded key
+ * gnutls_openpgp_privkey_export:
* @key: Holds the key.
* @format: One of gnutls_openpgp_crt_fmt_t elements.
* @password: the password that will be used to encrypt the key. (unused for now)
@@ -189,7 +189,7 @@ gnutls_openpgp_privkey_export (gnutls_openpgp_privkey_t key,
/**
- * gnutls_openpgp_privkey_get_pk_algorithm - return the key's PublicKey algorithm
+ * gnutls_openpgp_privkey_get_pk_algorithm:
* @key: is an OpenPGP key
* @bits: if bits is non null it will hold the size of the parameters' in bits
*
@@ -249,7 +249,7 @@ _gnutls_openpgp_get_algo (int cdk_algo)
}
/**
- * gnutls_openpgp_privkey_get_revoked_ status - Get the revoked status of the key
+ * gnutls_openpgp_privkey_get_revoked_status:
* @key: the structure that contains the OpenPGP private key.
*
* Get revocation status of key.
@@ -280,7 +280,7 @@ gnutls_openpgp_privkey_get_revoked_status (gnutls_openpgp_privkey_t key)
}
/**
- * gnutls_openpgp_privkey_get_fingerprint - Gets the fingerprint
+ * gnutls_openpgp_privkey_get_fingerprint:
* @key: the raw data that contains the OpenPGP secret key.
* @fpr: the buffer to save the fingerprint, must hold at least 20 bytes.
* @fprlen: the integer to save the length of the fingerprint.
@@ -326,7 +326,7 @@ gnutls_openpgp_privkey_get_fingerprint (gnutls_openpgp_privkey_t key,
}
/**
- * gnutls_openpgp_privkey_get_key_id - Gets the keyID
+ * gnutls_openpgp_privkey_get_key_id:
* @key: the structure that contains the OpenPGP secret key.
* @keyid: the buffer to save the keyid.
*
@@ -362,7 +362,7 @@ gnutls_openpgp_privkey_get_key_id (gnutls_openpgp_privkey_t key,
/**
- * gnutls_openpgp_privkey_get_subkey_count - return the number of subkeys
+ * gnutls_openpgp_privkey_get_subkey_count:
* @key: is an OpenPGP key
*
* This function will return the number of subkeys present in the
@@ -418,7 +418,7 @@ _get_secret_subkey (gnutls_openpgp_privkey_t key, unsigned int indx)
}
/**
- * gnutls_openpgp_privkey_get_subkey_revoked_ status - Get the revoked status of the key
+ * gnutls_openpgp_privkey_get_subkey_revoked_status:
* @key: the structure that contains the OpenPGP private key.
* @idx: is the subkey index
*
@@ -451,7 +451,7 @@ gnutls_openpgp_privkey_get_subkey_revoked_status (gnutls_openpgp_privkey_t
}
/**
- * gnutls_openpgp_privkey_get_subkey_pk_algorithm - return the subkey's PublicKey algorithm
+ * gnutls_openpgp_privkey_get_subkey_pk_algorithm:
* @key: is an OpenPGP key
* @idx: is the subkey index
* @bits: if bits is non null it will hold the size of the parameters' in bits
@@ -502,7 +502,7 @@ gnutls_openpgp_privkey_get_subkey_pk_algorithm (gnutls_openpgp_privkey_t key,
}
/**
- * gnutls_openpgp_privkey_get_subkey_idx - Returns the subkey's index
+ * gnutls_openpgp_privkey_get_subkey_idx:
* @key: the structure that contains the OpenPGP private key.
* @keyid: the keyid.
*
@@ -537,7 +537,7 @@ gnutls_openpgp_privkey_get_subkey_idx (gnutls_openpgp_privkey_t key,
}
/**
- * gnutls_openpgp_privkey_get_subkey_creation_time - Extract the timestamp
+ * gnutls_openpgp_privkey_get_subkey_creation_time:
* @key: the structure that contains the OpenPGP private key.
* @idx: the subkey index
*
@@ -567,7 +567,7 @@ gnutls_openpgp_privkey_get_subkey_creation_time (gnutls_openpgp_privkey_t key,
}
/**
- * gnutls_openpgp_privkey_get_subkey_expiration_time - Extract the expire date
+ * gnutls_openpgp_privkey_get_subkey_expiration_time:
* @key: the structure that contains the OpenPGP private key.
* @idx: the subkey index
*
@@ -598,7 +598,7 @@ gnutls_openpgp_privkey_get_subkey_expiration_time (gnutls_openpgp_privkey_t
}
/**
- * gnutls_openpgp_privkey_get_subkey_id - Gets the keyID
+ * gnutls_openpgp_privkey_get_subkey_id:
* @key: the structure that contains the OpenPGP secret key.
* @idx: the subkey index
* @keyid: the buffer to save the keyid.
@@ -635,7 +635,7 @@ gnutls_openpgp_privkey_get_subkey_id (gnutls_openpgp_privkey_t key,
}
/**
- * gnutls_openpgp_privkey_get_subkey_fingerprint - Gets the fingerprint of a subkey
+ * gnutls_openpgp_privkey_get_subkey_fingerprint:
* @key: the raw data that contains the OpenPGP secret key.
* @idx: the subkey index
* @fpr: the buffer to save the fingerprint, must hold at least 20 bytes.
@@ -966,7 +966,7 @@ cleanup:
/**
- * gnutls_openpgp_privkey_export_rsa_raw - This function will export the RSA private key
+ * gnutls_openpgp_privkey_export_rsa_raw:
* @pkey: Holds the certificate
* @m: will hold the modulus
* @e: will hold the public exponent
@@ -1003,7 +1003,7 @@ gnutls_openpgp_privkey_export_rsa_raw (gnutls_openpgp_privkey_t pkey,
}
/**
- * gnutls_openpgp_privkey_export_dsa_raw - This function will export the DSA private key
+ * gnutls_openpgp_privkey_export_dsa_raw:
* @pkey: Holds the certificate
* @p: will hold the p
* @q: will hold the q
@@ -1039,7 +1039,7 @@ gnutls_openpgp_privkey_export_dsa_raw (gnutls_openpgp_privkey_t pkey,
}
/**
- * gnutls_openpgp_privkey_export_subkey_rsa_raw - export the RSA private key
+ * gnutls_openpgp_privkey_export_subkey_rsa_raw:
* @pkey: Holds the certificate
* @idx: Is the subkey index
* @m: will hold the modulus
@@ -1081,7 +1081,7 @@ gnutls_openpgp_privkey_export_subkey_rsa_raw (gnutls_openpgp_privkey_t pkey,
}
/**
- * gnutls_openpgp_privkey_export_subkey_dsa_raw - export the DSA private key
+ * gnutls_openpgp_privkey_export_subkey_dsa_raw:
* @pkey: Holds the certificate
* @idx: Is the subkey index
* @p: will hold the p
@@ -1121,7 +1121,7 @@ gnutls_openpgp_privkey_export_subkey_dsa_raw (gnutls_openpgp_privkey_t pkey,
}
/**
- * gnutls_openpgp_privkey_get_preferred_key_id - Gets the preferred keyID
+ * gnutls_openpgp_privkey_get_preferred_key_id:
* @key: the structure that contains the OpenPGP public key.
* @keyid: the struct to save the keyid.
*
@@ -1146,7 +1146,7 @@ gnutls_openpgp_privkey_get_preferred_key_id (gnutls_openpgp_privkey_t key,
}
/**
- * gnutls_openpgp_privkey_set_preferred_key_id - Set the preferred keyID
+ * gnutls_openpgp_privkey_set_preferred_key_id:
* @key: the structure that contains the OpenPGP public key.
* @keyid: the selected keyid
*