[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[SCM] GNU gnutls branch, master, updated. gnutls_2_9_9-109-gc1953c3
|
From: |
Simon Josefsson |
|
Subject: |
[SCM] GNU gnutls branch, master, updated. gnutls_2_9_9-109-gc1953c3 |
|
Date: |
Wed, 17 Feb 2010 11:35:36 +0000 |
This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "GNU gnutls".
http://git.savannah.gnu.org/cgit/gnutls.git/commit/?id=c1953c310b347bcb6401ef825265c10518d7c977
The branch, master has been updated
via c1953c310b347bcb6401ef825265c10518d7c977 (commit)
from 5cf6a95171b1a88b13dd7043fb8e0e4f21b90a1d (commit)
Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.
- Log -----------------------------------------------------------------
commit c1953c310b347bcb6401ef825265c10518d7c977
Author: Simon Josefsson <address@hidden>
Date: Wed Feb 17 12:35:31 2010 +0100
Fix GTK-DOC syntax. Unfortunately this looses some information.
-----------------------------------------------------------------------
Summary of changes:
lib/auth_srp_sb64.c | 8 ++--
lib/crypto-api.c | 72 ++++++++++++++-----------------
lib/crypto.c | 18 ++++----
lib/ext_safe_renegotiation.c | 4 +-
lib/ext_server_name.c | 4 +-
lib/ext_signature.c | 2 +-
lib/gnutls_alert.c | 10 ++--
lib/gnutls_algorithms.c | 52 +++++++++++-----------
lib/gnutls_anon_cred.c | 12 +++---
lib/gnutls_auth.c | 10 ++--
lib/gnutls_buffers.c | 2 +-
lib/gnutls_cert.c | 32 +++++++-------
lib/gnutls_compress.c | 6 +-
lib/gnutls_db.c | 16 ++++----
lib/gnutls_dh_primes.c | 16 ++++----
lib/gnutls_errors.c | 6 +-
lib/gnutls_extensions.c | 2 +-
lib/gnutls_global.c | 16 ++++----
lib/gnutls_handshake.c | 10 ++--
lib/gnutls_mem.c | 4 +-
lib/gnutls_priority.c | 24 +++++-----
lib/gnutls_psk.c | 30 +++++++-------
lib/gnutls_psk_netconf.c | 2 +-
lib/gnutls_record.c | 24 +++++-----
lib/gnutls_rsa_export.c | 16 ++++----
lib/gnutls_session.c | 8 ++--
lib/gnutls_srp.c | 22 +++++-----
lib/gnutls_state.c | 42 +++++++++---------
lib/gnutls_str.c | 2 +-
lib/gnutls_ui.c | 38 ++++++++--------
lib/gnutls_x509.c | 20 ++++----
lib/includes/gnutls/crypto.h | 15 ++++---
lib/opencdk/stream.c | 25 ++++++-----
lib/openpgp/compat.c | 8 ++--
lib/openpgp/extras.c | 12 +++---
lib/openpgp/gnutls_openpgp.c | 20 ++++----
lib/openpgp/output.c | 2 +-
lib/openpgp/pgp.c | 60 +++++++++++++-------------
lib/openpgp/pgpverify.c | 4 +-
lib/openpgp/privkey.c | 44 ++++++++++----------
lib/x509/common.c | 2 +-
lib/x509/crl.c | 38 ++++++++--------
lib/x509/crl_write.c | 18 ++++----
lib/x509/crq.c | 70 +++++++++++++++---------------
lib/x509/dn.c | 14 +++---
lib/x509/output.c | 6 +-
lib/x509/pkcs12.c | 16 ++++----
lib/x509/pkcs12_bag.c | 28 ++++++------
lib/x509/pkcs7.c | 28 ++++++------
lib/x509/privkey.c | 32 +++++++-------
lib/x509/privkey_pkcs8.c | 4 +-
lib/x509/rfc2818_hostname.c | 2 +-
lib/x509/verify.c | 10 ++--
lib/x509/x509.c | 96 +++++++++++++++++++++---------------------
lib/x509/x509_write.c | 50 +++++++++++-----------
lib/x509_b64.c | 8 ++--
libextra/gnutls_extra.c | 4 +-
libextra/gnutls_ia.c | 26 ++++++------
libextra/openssl_compat.c | 28 ++++++------
59 files changed, 599 insertions(+), 601 deletions(-)
diff --git a/lib/auth_srp_sb64.c b/lib/auth_srp_sb64.c
index b418eb1..6fb1470 100644
--- a/lib/auth_srp_sb64.c
+++ b/lib/auth_srp_sb64.c
@@ -311,7 +311,7 @@ _gnutls_sbase64_decode (uint8_t * data, size_t idata_size,
uint8_t ** result)
}
/**
- * gnutls_srp_base64_encode - Encode raw data using SRP-Base64
+ * gnutls_srp_base64_encode:
* @data: contain the raw data
* @result: the place where base64 data will be copied
* @result_size: holds the size of the result
@@ -355,7 +355,7 @@ gnutls_srp_base64_encode (const gnutls_datum_t * data, char
*result,
}
/**
- * gnutls_srp_base64_encode_alloc - encode raw data using SRP-Base64
+ * gnutls_srp_base64_encode_alloc:
* @data: contains the raw data
* @result: will hold the newly allocated encoded data
*
@@ -397,7 +397,7 @@ gnutls_srp_base64_encode_alloc (const gnutls_datum_t * data,
}
/**
- * gnutls_srp_base64_decode - decode SRP-base64 encoded data
+ * gnutls_srp_base64_decode:
* @b64_data: contain the encoded data
* @result: the place where decoded data will be copied
* @result_size: holds the size of the result
@@ -441,7 +441,7 @@ gnutls_srp_base64_decode (const gnutls_datum_t * b64_data,
char *result,
}
/**
- * gnutls_srp_base64_decode_alloc - decode SRP-base64 encoded data
+ * gnutls_srp_base64_decode_alloc:
* @b64_data: contains the encoded data
* @result: the place where decoded data lie
*
diff --git a/lib/crypto-api.c b/lib/crypto-api.c
index 022fc58..b2c724e 100644
--- a/lib/crypto-api.c
+++ b/lib/crypto-api.c
@@ -31,7 +31,7 @@
#include <crypto.h>
/**
- * gnutls_cipher_init - initializes a crypto context
+ * gnutls_cipher_init:
* @handle: is a #gnutls_cipher_hd_t structure.
* @cipher: the encryption algorithm to use
* @key: The key to be used for encryption
@@ -45,8 +45,10 @@
* Returns: Zero or a negative value on error.
**/
int
-gnutls_cipher_init (gnutls_cipher_hd_t * handle, gnutls_cipher_algorithm_t
cipher,
- const gnutls_datum_t * key, const gnutls_datum_t * iv)
+gnutls_cipher_init (gnutls_cipher_hd_t * handle,
+ gnutls_cipher_algorithm_t cipher,
+ const gnutls_datum_t * key,
+ const gnutls_datum_t * iv)
{
*handle = gnutls_malloc(sizeof(cipher_hd_st));
if (*handle == NULL) {
@@ -58,7 +60,7 @@ gnutls_cipher_init (gnutls_cipher_hd_t * handle,
gnutls_cipher_algorithm_t ciphe
}
/**
- * gnutls_cipher_encrypt - encrypts the given data
+ * gnutls_cipher_encrypt:
* @handle: is a #gnutls_cipher_hd_t structure.
* @text: the data to encrypt
* @textlen: The length of data to encrypt
@@ -74,10 +76,10 @@ int gnutls_cipher_encrypt (gnutls_cipher_hd_t handle, void
*text, int textlen)
}
/**
- * gnutls_cipher_decrypt - decrypts the given data
+ * gnutls_cipher_decrypt:
* @handle: is a #gnutls_cipher_hd_t structure.
- * @text: the data to encrypt
- * @textlen: The length of data to encrypt
+ * @ciphertext: the data to encrypt
+ * @ciphertextlen: The length of data to encrypt
*
* This function will decrypt the given data using the algorithm
* specified by the context.
@@ -88,17 +90,16 @@ int
gnutls_cipher_decrypt (gnutls_cipher_hd_t handle, void *ciphertext,
int ciphertextlen)
{
- return _gnutls_cipher_decrypt((cipher_hd_st*)handle, ciphertext,
ciphertextlen);
+ return _gnutls_cipher_decrypt((cipher_hd_st*)handle, ciphertext,
+ ciphertextlen);
}
/**
- * gnutls_cipher_deinit - deinitializes resources by a context
+ * gnutls_cipher_deinit:
* @handle: is a #gnutls_cipher_hd_t structure.
*
- * This function will deinitialize all resources occupied by
- * the given encryption context.
- *
- * Returns: This function has no return value.
+ * This function will deinitialize all resources occupied by the given
+ * encryption context.
**/
void
gnutls_cipher_deinit (gnutls_cipher_hd_t handle)
@@ -110,8 +111,8 @@ gnutls_cipher_deinit (gnutls_cipher_hd_t handle)
/* HMAC */
/**
- * gnutls_hmac_init - initializes an HMAC context
- * @handle: is a #gnutls_hmac_hd_t structure.
+ * gnutls_hmac_init:
+ * @dig: is a #gnutls_hmac_hd_t structure.
* @algorithm: the HMAC algorithm to use
* @key: The key to be used for encryption
* @keylen: The length of the key
@@ -124,20 +125,21 @@ gnutls_cipher_deinit (gnutls_cipher_hd_t handle)
* Returns: Zero or a negative value on error.
**/
int
-gnutls_hmac_init (gnutls_hmac_hd_t * dig, gnutls_digest_algorithm_t algorithm,
- const void *key, int keylen)
+gnutls_hmac_init (gnutls_hmac_hd_t * dig,
+ gnutls_digest_algorithm_t algorithm,
+ const void *key, int keylen)
{
*dig = gnutls_malloc(sizeof(digest_hd_st));
if (*dig == NULL) {
gnutls_assert();
return GNUTLS_E_MEMORY_ERROR;
}
-
+
return _gnutls_hmac_init(((digest_hd_st*)*dig), algorithm, key, keylen);
}
/**
- * gnutls_hmac - hashes the given data
+ * gnutls_hmac:
* @handle: is a #gnutls_cipher_hd_t structure.
* @text: the data to hash
* @textlen: The length of data to hash
@@ -153,13 +155,11 @@ int gnutls_hmac (gnutls_hmac_hd_t handle, const void
*text, size_t textlen)
}
/**
- * gnutls_hmac_output - Outputs the current MAC value
+ * gnutls_hmac_output:
* @handle: is a #gnutls_hmac_hd_t structure.
* @digest: is the output value of the MAC
*
* This function will output the current MAC value.
- *
- * Returns: This function has no return value.
**/
void
gnutls_hmac_output (gnutls_hmac_hd_t handle, void *digest)
@@ -168,14 +168,12 @@ gnutls_hmac_output (gnutls_hmac_hd_t handle, void *digest)
}
/**
- * gnutls_hmac_deinit - deinitializes resources by a context
+ * gnutls_hmac_deinit:
* @handle: is a #gnutls_hmac_hd_t structure.
* @digest: is the output value of the MAC
*
* This function will deinitialize all resources occupied by
* the given hmac context.
- *
- * Returns: This function has no return value.
**/
void gnutls_hmac_deinit (gnutls_hmac_hd_t handle, void *digest)
{
@@ -183,7 +181,7 @@ void gnutls_hmac_deinit (gnutls_hmac_hd_t handle, void
*digest)
}
/**
- * gnutls_hmac_get_len - returns the length of the output data
+ * gnutls_hmac_get_len:
* @algorithm: the hmac algorithm to use
*
* This function will return the length of the output data
@@ -198,7 +196,7 @@ int gnutls_hmac_get_len( gnutls_mac_algorithm_t algorithm)
}
/**
- * gnutls_hmac_fast - hashes data
+ * gnutls_hmac_fast:
* @algorithm: the hash algorithm to use
* @key: the key to use
* @keylen: The length of the key
@@ -221,11 +219,9 @@ int gnutls_hmac_fast (gnutls_mac_algorithm_t algorithm,
/* HASH */
/**
- * gnutls_hash_init - initializes an hash context
- * @handle: is a #gnutls_hash_hd_t structure.
+ * gnutls_hash_init:
+ * @dig: is a #gnutls_hash_hd_t structure.
* @algorithm: the hash algorithm to use
- * @key: The key to be used for encryption
- * @keylen: The length of the key
*
* This function will initialize an context that can be used to
* produce a Message Digest of data. This will effectively use the
@@ -247,7 +243,7 @@ int gnutls_hash_init (gnutls_hash_hd_t * dig,
}
/**
- * gnutls_hash - hashes the given data
+ * gnutls_hash:
* @handle: is a #gnutls_cipher_hd_t structure.
* @text: the data to hash
* @textlen: The length of data to hash
@@ -263,13 +259,11 @@ int gnutls_hash (gnutls_hash_hd_t handle, const void
*text, size_t textlen)
}
/**
- * gnutls_hash_output - Outputs the current hash value
+ * gnutls_hash_output:
* @handle: is a #gnutls_hash_hd_t structure.
* @digest: is the output value of the hash
*
* This function will output the current hash value.
- *
- * Returns: This function has no return value.
**/
void gnutls_hash_output (gnutls_hash_hd_t handle, void *digest)
{
@@ -277,14 +271,12 @@ void gnutls_hash_output (gnutls_hash_hd_t handle, void
*digest)
}
/**
- * gnutls_hash_deinit - deinitializes resources by a context
+ * gnutls_hash_deinit:
* @handle: is a #gnutls_hash_hd_t structure.
* @digest: is the output value of the hash
*
* This function will deinitialize all resources occupied by
* the given hash context.
- *
- * Returns: This function has no return value.
**/
void
gnutls_hash_deinit (gnutls_hash_hd_t handle, void *digest)
@@ -293,7 +285,7 @@ gnutls_hash_deinit (gnutls_hash_hd_t handle, void *digest)
}
/**
- * gnutls_hash_get_len - returns the length of the output data
+ * gnutls_hash_get_len:
* @algorithm: the hash algorithm to use
*
* This function will return the length of the output data
@@ -308,7 +300,7 @@ int gnutls_hash_get_len( gnutls_digest_algorithm_t
algorithm)
}
/**
- * gnutls_hash_fast - initializes an hash context
+ * gnutls_hash_fast:
* @algorithm: the hash algorithm to use
* @text: the data to hash
* @textlen: The length of data to hash
diff --git a/lib/crypto.c b/lib/crypto.c
index 9942efb..48ef27e 100644
--- a/lib/crypto.c
+++ b/lib/crypto.c
@@ -142,7 +142,7 @@ _gnutls_crypto_deregister (void)
}
/**
- * gnutls_crypto_single_cipher_register2 - register a cipher algorithm
+ * gnutls_crypto_single_cipher_register2:
* @algorithm: is the gnutls algorithm identifier
* @priority: is the priority of the algorithm
* @version: should be set to %GNUTLS_CRYPTO_API_VERSION
@@ -184,7 +184,7 @@ _gnutls_get_crypto_cipher (gnutls_cipher_algorithm_t algo)
}
/**
- * gnutls_crypto_rnd_register2 - register a random generator
+ * gnutls_crypto_rnd_register2:
* @priority: is the priority of the generator
* @version: should be set to %GNUTLS_CRYPTO_API_VERSION
* @s: is a structure holding new generator's data
@@ -225,7 +225,7 @@ gnutls_crypto_rnd_register2 (int priority, int version,
}
/**
- * gnutls_crypto_single_mac_register2 - register a MAC algorithm
+ * gnutls_crypto_single_mac_register2:
* @algorithm: is the gnutls algorithm identifier
* @priority: is the priority of the algorithm
* @version: should be set to %GNUTLS_CRYPTO_API_VERSION
@@ -266,7 +266,7 @@ _gnutls_get_crypto_mac (gnutls_mac_algorithm_t algo)
}
/**
- * gnutls_crypto_single_digest_register2 - register a digest algorithm
+ * gnutls_crypto_single_digest_register2:
* @algorithm: is the gnutls algorithm identifier
* @priority: is the priority of the algorithm
* @version: should be set to %GNUTLS_CRYPTO_API_VERSION
@@ -308,7 +308,7 @@ _gnutls_get_crypto_digest (gnutls_digest_algorithm_t algo)
}
/**
- * gnutls_crypto_bigint_register2 - register a bigint interface
+ * gnutls_crypto_bigint_register2:
* @priority: is the priority of the interface
* @version: should be set to %GNUTLS_CRYPTO_API_VERSION
* @s: is a structure holding new interface's data
@@ -352,7 +352,7 @@ gnutls_crypto_bigint_register2 (int priority, int version,
}
/**
- * gnutls_crypto_pk_register2 - register a public key interface
+ * gnutls_crypto_pk_register2:
* @priority: is the priority of the interface
* @version: should be set to %GNUTLS_CRYPTO_API_VERSION
* @s: is a structure holding new interface's data
@@ -396,7 +396,7 @@ gnutls_crypto_pk_register2 (int priority, int version,
}
/**
- * gnutls_crypto_cipher_register2 - register a cipher interface
+ * gnutls_crypto_cipher_register2:
* @priority: is the priority of the cipher interface
* @version: should be set to %GNUTLS_CRYPTO_API_VERSION
* @s: is a structure holding new interface's data
@@ -437,7 +437,7 @@ gnutls_crypto_cipher_register2 (int priority, int version,
}
/**
- * gnutls_crypto_mac_register2 - register a mac interface
+ * gnutls_crypto_mac_register2:
* @priority: is the priority of the mac interface
* @version: should be set to %GNUTLS_CRYPTO_API_VERSION
* @s: is a structure holding new interface's data
@@ -478,7 +478,7 @@ gnutls_crypto_mac_register2 (int priority, int version,
}
/**
- * gnutls_crypto_digest_register2 - register a digest interface
+ * gnutls_crypto_digest_register2:
* @priority: is the priority of the digest interface
* @version: should be set to %GNUTLS_CRYPTO_API_VERSION
* @s: is a structure holding new interface's data
diff --git a/lib/ext_safe_renegotiation.c b/lib/ext_safe_renegotiation.c
index b494224..45d3d2f 100644
--- a/lib/ext_safe_renegotiation.c
+++ b/lib/ext_safe_renegotiation.c
@@ -120,7 +120,7 @@ _gnutls_safe_renegotiation_send_params (gnutls_session_t
session,
}
/**
- * gnutls_safe_negotiation_set_initial - Used to enable and disable initial
safe renegotiation
+ * gnutls_safe_negotiation_set_initial:
* @session: is a #gnutls_session_t structure.
* @value: 0 to disable and 1 to enable
*
@@ -137,7 +137,7 @@ gnutls_safe_negotiation_set_initial (gnutls_session_t
session, int value)
}
/**
- * gnutls_safe_negotiation_set - Used to enable and disable safe renegotiation
+ * gnutls_safe_negotiation_set:
* @session: is a #gnutls_session_t structure.
* @value: 0 to disable and 1 to enable
*
diff --git a/lib/ext_server_name.c b/lib/ext_server_name.c
index 533808b..62925e6 100644
--- a/lib/ext_server_name.c
+++ b/lib/ext_server_name.c
@@ -224,7 +224,7 @@ _gnutls_server_name_send_params (gnutls_session_t session,
}
/**
- * gnutls_server_name_get - Used to get the server name indicator send by a
client
+ * gnutls_server_name_get:
* @session: is a #gnutls_session_t structure.
* @data: will hold the data
* @data_length: will hold the data length. Must hold the maximum size of data.
@@ -297,7 +297,7 @@ gnutls_server_name_get (gnutls_session_t session, void
*data,
}
/**
- * gnutls_server_name_set - set a name indicator to be sent as an extension
+ * gnutls_server_name_set:
* @session: is a #gnutls_session_t structure.
* @type: specifies the indicator type
* @name: is a string that contains the server name.
diff --git a/lib/ext_signature.c b/lib/ext_signature.c
index b11a891..a2aefb8 100644
--- a/lib/ext_signature.c
+++ b/lib/ext_signature.c
@@ -284,7 +284,7 @@ _gnutls_session_sign_algo_enabled (gnutls_session_t session,
}
/**
- * gnutls_sign_algorithm_get - get signature algorithms requested by peer
+ * gnutls_sign_algorithm_get:
* @session: is a #gnutls_session_t structure.
* @indx: is an index of the signature algorithm to return
* @algo: the returned certificate type will be stored there
diff --git a/lib/gnutls_alert.c b/lib/gnutls_alert.c
index 3176835..f4c5287 100644
--- a/lib/gnutls_alert.c
+++ b/lib/gnutls_alert.c
@@ -78,7 +78,7 @@ static const gnutls_alert_entry sup_alerts[] = {
};
/**
- * gnutls_alert_get_name - Returns a string describing the alert number given
+ * gnutls_alert_get_name:
* @alert: is an alert number #gnutls_session_t structure.
*
* This function will return a string that describes the given alert
@@ -99,7 +99,7 @@ gnutls_alert_get_name (gnutls_alert_description_t alert)
}
/**
- * gnutls_alert_send - send an alert message to the peer
+ * gnutls_alert_send:
* @session: is a #gnutls_session_t structure.
* @level: is the level of the alert
* @desc: is the alert description
@@ -140,7 +140,7 @@ gnutls_alert_send (gnutls_session_t session,
gnutls_alert_level_t level,
}
/**
- * gnutls_error_to_alert - return an alert code based on the given error code
+ * gnutls_error_to_alert:
* @err: is a negative integer
* @level: the alert level will be stored there
*
@@ -258,7 +258,7 @@ gnutls_error_to_alert (int err, int *level)
}
/**
- * gnutls_alert_send_appropriate - send alert to peer depending on error code
+ * gnutls_alert_send_appropriate:
* @session: is a #gnutls_session_t structure.
* @err: is an integer
*
@@ -291,7 +291,7 @@ gnutls_alert_send_appropriate (gnutls_session_t session,
int err)
}
/**
- * gnutls_alert_get - Returns the last alert number received.
+ * gnutls_alert_get:
* @session: is a #gnutls_session_t structure.
*
* This function will return the last alert number received. This
diff --git a/lib/gnutls_algorithms.c b/lib/gnutls_algorithms.c
index 861fbda..fa12022 100644
--- a/lib/gnutls_algorithms.c
+++ b/lib/gnutls_algorithms.c
@@ -697,7 +697,7 @@ _gnutls_mac_priority (gnutls_session_t session,
}
/**
- * gnutls_mac_get_name - Returns a string with the name of the specified mac
algorithm
+ * gnutls_mac_get_name:
* @algorithm: is a MAC algorithm
*
* Convert a #gnutls_mac_algorithm_t value to a string.
@@ -717,7 +717,7 @@ gnutls_mac_get_name (gnutls_mac_algorithm_t algorithm)
}
/**
- * gnutls_mac_get_id - Returns the gnutls id of the specified in string
algorithm
+ * gnutls_mac_get_id:
* @name: is a MAC algorithm name
*
* Convert a string to a #gnutls_mac_algorithm_t value. The names are
@@ -737,7 +737,7 @@ gnutls_mac_get_id (const char *name)
}
/**
- * gnutls_mac_get_key_size - Returns the length of the MAC's key size
+ * gnutls_mac_get_key_size:
* @algorithm: is an encryption algorithm
*
* Get size of MAC key.
@@ -757,7 +757,7 @@ gnutls_mac_get_key_size (gnutls_mac_algorithm_t algorithm)
}
/**
- * gnutls_mac_list - Get a list of supported MAC algorithms
+ * gnutls_mac_list:
*
* Get a list of hash algorithms for use as MACs. Note that not
* necessarily all MACs are supported in TLS cipher suites. For
@@ -848,7 +848,7 @@ _gnutls_cipher_is_block (gnutls_cipher_algorithm_t
algorithm)
}
/**
- * gnutls_cipher_get_key_size - Returns the length of the cipher's key size
+ * gnutls_cipher_get_key_size:
* @algorithm: is an encryption algorithm
*
* Get key size for cipher.
@@ -884,7 +884,7 @@ _gnutls_cipher_get_export_flag (gnutls_cipher_algorithm_t
algorithm)
}
/**
- * gnutls_cipher_get_name - Returns a string with the name of the specified
cipher algorithm
+ * gnutls_cipher_get_name:
* @algorithm: is an encryption algorithm
*
* Convert a #gnutls_cipher_algorithm_t type to a string.
@@ -904,7 +904,7 @@ gnutls_cipher_get_name (gnutls_cipher_algorithm_t algorithm)
}
/**
- * gnutls_cipher_get_id - Returns the gnutls id of the specified in string
algorithm
+ * gnutls_cipher_get_id:
* @name: is a MAC algorithm name
*
* The names are compared in a case insensitive way.
@@ -923,7 +923,7 @@ gnutls_cipher_get_id (const char *name)
}
/**
- * gnutls_cipher_list - Get a list of supported ciphers
+ * gnutls_cipher_list:
*
* Get a list of supported cipher algorithms. Note that not
* necessarily all ciphers are supported as TLS cipher suites. For
@@ -977,7 +977,7 @@ _gnutls_kx_priority (gnutls_session_t session,
}
/**
- * gnutls_kx_get_name - Returns a string with the name of the specified key
exchange algorithm
+ * gnutls_kx_get_name:
* @algorithm: is a key exchange algorithm
*
* Convert a #gnutls_kx_algorithm_t value to a string.
@@ -997,7 +997,7 @@ gnutls_kx_get_name (gnutls_kx_algorithm_t algorithm)
}
/**
- * gnutls_kx_get_id - Returns the gnutls id of the specified in string
algorithm
+ * gnutls_kx_get_id:
* @name: is a KX name
*
* Convert a string to a #gnutls_kx_algorithm_t value. The names are
@@ -1017,7 +1017,7 @@ gnutls_kx_get_id (const char *name)
}
/**
- * gnutls_kx_list - Get a list of supported key exchange methods
+ * gnutls_kx_list:
*
* Get a list of supported key exchange algorithms.
*
@@ -1109,7 +1109,7 @@ _gnutls_version_max (gnutls_session_t session)
/**
- * gnutls_protocol_get_name - Returns a string with the name of the specified
SSL/TLS version
+ * gnutls_protocol_get_name:
* @version: is a (gnutls) version number
*
* Convert a #gnutls_protocol_t value to a string.
@@ -1128,7 +1128,7 @@ gnutls_protocol_get_name (gnutls_protocol_t version)
}
/**
- * gnutls_protocol_get_id - Returns the gnutls id of the specified in string
protocol
+ * gnutls_protocol_get_id:
* @name: is a protocol name
*
* The names are compared in a case insensitive way.
@@ -1147,7 +1147,7 @@ gnutls_protocol_get_id (const char *name)
}
/**
- * gnutls_protocol_list - Get a list of supported protocols
+ * gnutls_protocol_list:
*
* Get a list of supported protocols, e.g. SSL 3.0, TLS 1.0 etc.
*
@@ -1356,7 +1356,7 @@ _gnutls_cipher_suite_get_name (cipher_suite_st * suite)
}
/**
- * gnutls_cipher_suite_get_name - get name of the specified cipher suite
+ * gnutls_cipher_suite_get_name:
* @kx_algorithm: is a Key exchange algorithm
* @cipher_algorithm: is a cipher algorithm
* @mac_algorithm: is a MAC algorithm
@@ -1722,7 +1722,7 @@ _gnutls_supported_ciphersuites (gnutls_session_t session,
}
/**
- * gnutls_certificate_type_get_name - Returns a string with the name of the
specified certificate type
+ * gnutls_certificate_type_get_name:
* @type: is a certificate type
*
* Convert a #gnutls_certificate_type_t type to a string.
@@ -1744,7 +1744,7 @@ gnutls_certificate_type_get_name
(gnutls_certificate_type_t type)
}
/**
- * gnutls_certificate_type_get_id - Returns the gnutls id of the specified in
string type
+ * gnutls_certificate_type_get_id:
* @name: is a certificate type name
*
* The names are compared in a case insensitive way.
@@ -1772,7 +1772,7 @@ static const gnutls_certificate_type_t
supported_certificate_types[] = {
};
/**
- * gnutls_certificate_type_list - Get a list of supported certificate types
+ * gnutls_certificate_type_list:
*
* Get a list of certificate types. Note that to be able to use
* OpenPGP certificates, you must link to libgnutls-extra and call
@@ -1874,7 +1874,7 @@ static const gnutls_sign_algorithm_t supported_sign[] = {
GNUTLS_SIGN_LOOP( if(p->id && p->id == sign) { a; break; } )
/**
- * gnutls_sign_algorithm_get_name - Returns a string with the name of the
specified sign algorithm
+ * gnutls_sign_algorithm_get_name:
* @sign: is a sign algorithm
*
* Convert a #gnutls_sign_algorithm_t value to a string.
@@ -1894,7 +1894,7 @@ gnutls_sign_algorithm_get_name (gnutls_sign_algorithm_t
sign)
}
/**
- * gnutls_sign_list - Get a list of supported public key signature algorithms
+ * gnutls_sign_list:
*
* Get a list of supported public key signature algorithms.
*
@@ -1909,7 +1909,7 @@ gnutls_sign_list (void)
}
/**
- * gnutls_sign_get_id - Returns the gnutls id of the specified in signature
algorithm
+ * gnutls_sign_get_id:
* @name: is a MAC algorithm name
*
* The names are compared in a case insensitive way.
@@ -1929,7 +1929,7 @@ gnutls_sign_get_id (const char *name)
}
/**
- * gnutls_sign_get_name - Get name string for a #gnutls_sign_algorithm_t
+ * gnutls_sign_get_name:
* @algorithm: is a public key signature algorithm
*
* Convert a #gnutls_sign_algorithm_t value to a string.
@@ -2062,7 +2062,7 @@ static const gnutls_pk_entry pk_algorithms[] = {
};
/**
- * gnutls_pk_algorithm_get_name - Get string with name of public key algorithm
+ * gnutls_pk_algorithm_get_name:
* @algorithm: is a pk algorithm
*
* Convert a #gnutls_pk_algorithm_t value to a string.
@@ -2087,7 +2087,7 @@ gnutls_pk_algorithm_get_name (gnutls_pk_algorithm_t
algorithm)
}
/**
- * gnutls_pk_list - Get a list of supported public key algorithms
+ * gnutls_pk_list:
*
* Get a list of supported public key algorithms.
*
@@ -2109,7 +2109,7 @@ gnutls_pk_list (void)
}
/**
- * gnutls_pk_get_id - Get #gnutls_pk_algorithm_t from a string
+ * gnutls_pk_get_id:
* @name: is a string containing a public key algorithm name.
*
* Convert a string to a #gnutls_pk_algorithm_t value. The names are
@@ -2133,7 +2133,7 @@ gnutls_pk_get_id (const char *name)
}
/**
- * gnutls_pk_get_name - Get name string with #gnutls_pk_algorithm_t algorithm
+ * gnutls_pk_get_name:
* @algorithm: is a public key algorithm
*
* Convert a #gnutls_pk_algorithm_t value to a string.
diff --git a/lib/gnutls_anon_cred.c b/lib/gnutls_anon_cred.c
index 07bde86..41ecb75 100644
--- a/lib/gnutls_anon_cred.c
+++ b/lib/gnutls_anon_cred.c
@@ -35,7 +35,7 @@
#include "gnutls_mpi.h"
/**
- * gnutls_anon_free_server_credentials - Used to free an allocated
gnutls_anon_server_credentials_t structure
+ * gnutls_anon_free_server_credentials:
* @sc: is a #gnutls_anon_server_credentials_t structure.
*
* This structure is complex enough to manipulate directly thus this
@@ -49,7 +49,7 @@ gnutls_anon_free_server_credentials
(gnutls_anon_server_credentials_t sc)
}
/**
- * gnutls_anon_allocate_server_credentials - Used to allocate an
gnutls_anon_server_credentials_t structure
+ * gnutls_anon_allocate_server_credentials:
* @sc: is a pointer to a #gnutls_anon_server_credentials_t structure.
*
* This structure is complex enough to manipulate directly thus this
@@ -69,7 +69,7 @@ gnutls_anon_allocate_server_credentials
(gnutls_anon_server_credentials_t *
/**
- * gnutls_anon_free_client_credentials - Used to free an allocated
gnutls_anon_client_credentials_t structure
+ * gnutls_anon_free_client_credentials:
* @sc: is a #gnutls_anon_client_credentials_t structure.
*
* This structure is complex enough to manipulate directly thus this
@@ -84,7 +84,7 @@ static struct gnutls_anon_client_credentials_st
anon_dummy_struct;
static const gnutls_anon_client_credentials_t anon_dummy = &anon_dummy_struct;
/**
- * gnutls_anon_allocate_client_credentials - Used to allocate a credentials
structure
+ * gnutls_anon_allocate_client_credentials:
* @sc: is a pointer to a #gnutls_anon_client_credentials_t structure.
*
* This structure is complex enough to manipulate directly thus
@@ -105,7 +105,7 @@ gnutls_anon_allocate_client_credentials
(gnutls_anon_client_credentials_t *
}
/**
- * gnutls_anon_set_server_dh_params - set the DH parameters for a server to use
+ * gnutls_anon_set_server_dh_params:
* @res: is a gnutls_anon_server_credentials_t structure
* @dh_params: is a structure that holds Diffie-Hellman parameters.
*
@@ -121,7 +121,7 @@ gnutls_anon_set_server_dh_params
(gnutls_anon_server_credentials_t res,
}
/**
- * gnutls_anon_set_server_params_function - set the DH parameters callback
+ * gnutls_anon_set_server_params_function:
* @res: is a gnutls_certificate_credentials_t structure
* @func: is the function to be called
*
diff --git a/lib/gnutls_auth.c b/lib/gnutls_auth.c
index da8f9a2..5d21514 100644
--- a/lib/gnutls_auth.c
+++ b/lib/gnutls_auth.c
@@ -39,7 +39,7 @@
*/
/**
- * gnutls_credentials_clear - Clears all the credentials previously set
+ * gnutls_credentials_clear:
* @session: is a #gnutls_session_t structure.
*
* Clears all the credentials previously set in this session.
@@ -66,7 +66,7 @@ gnutls_credentials_clear (gnutls_session_t session)
* { algorithm, credentials, pointer to next }
*/
/**
- * gnutls_credentials_set - Sets the needed credentials for the specified
authentication algorithm.
+ * gnutls_credentials_set:
* @session: is a #gnutls_session_t structure.
* @type: is the type of the credentials
* @cred: is a pointer to a structure.
@@ -155,7 +155,7 @@ gnutls_credentials_set (gnutls_session_t session,
}
/**
- * gnutls_auth_get_type - Returns the type of credentials for the current
authentication schema.
+ * gnutls_auth_get_type:
* @session: is a #gnutls_session_t structure.
*
* Returns type of credentials for the current authentication schema.
@@ -184,7 +184,7 @@ gnutls_auth_get_type (gnutls_session_t session)
}
/**
- * gnutls_auth_server_get_type - Returns the type of credentials for the
server authentication schema.
+ * gnutls_auth_server_get_type:
* @session: is a #gnutls_session_t structure.
*
* Returns the type of credentials that were used for server authentication.
@@ -204,7 +204,7 @@ gnutls_auth_server_get_type (gnutls_session_t session)
}
/**
- * gnutls_auth_client_get_type - Returns the type of credentials for the
client authentication schema.
+ * gnutls_auth_client_get_type:
* @session: is a #gnutls_session_t structure.
*
* Returns the type of credentials that were used for client authentication.
diff --git a/lib/gnutls_buffers.c b/lib/gnutls_buffers.c
index 8b20842..9627ee1 100644
--- a/lib/gnutls_buffers.c
+++ b/lib/gnutls_buffers.c
@@ -184,7 +184,7 @@ _gnutls_record_buffer_get_size (content_type_t type,
gnutls_session_t session)
}
/**
- * gnutls_record_check_pending - checks if there are any data to receive in
gnutls buffers.
+ * gnutls_record_check_pending:
* @session: is a #gnutls_session_t structure.
*
* This function checks if there are any data to receive in the gnutls
diff --git a/lib/gnutls_cert.c b/lib/gnutls_cert.c
index 857ee09..a74ccf0 100644
--- a/lib/gnutls_cert.c
+++ b/lib/gnutls_cert.c
@@ -46,7 +46,7 @@
#endif
/**
- * gnutls_certificate_free_keys - Used to free all the keys from a
gnutls_certificate_credentials_t structure
+ * gnutls_certificate_free_keys:
* @sc: is a #gnutls_certificate_credentials_t structure.
*
* This function will delete all the keys and the certificates associated
@@ -87,7 +87,7 @@ gnutls_certificate_free_keys
(gnutls_certificate_credentials_t sc)
}
/**
- * gnutls_certificate_free_cas - Used to free all the CAs from a
gnutls_certificate_credentials_t structure
+ * gnutls_certificate_free_cas:
* @sc: is a #gnutls_certificate_credentials_t structure.
*
* This function will delete all the CAs associated with the given
@@ -113,7 +113,7 @@ gnutls_certificate_free_cas
(gnutls_certificate_credentials_t sc)
}
/**
- * gnutls_certificate_get_x509_cas - Used to export all the CAs from a
gnutls_certificate_credentials_t structure
+ * gnutls_certificate_get_x509_cas:
* @sc: is a #gnutls_certificate_credentials_t structure.
* @x509_ca_list: will point to the CA list. Should be treated as constant
* @ncas: the number of CAs
@@ -133,7 +133,7 @@ gnutls_certificate_get_x509_cas
(gnutls_certificate_credentials_t sc,
}
/**
- * gnutls_certificate_get_x509_crls - Used to export all the CRLs from a
gnutls_certificate_credentials_t structure
+ * gnutls_certificate_get_x509_crls:
* @sc: is a #gnutls_certificate_credentials_t structure.
* @x509_crl_list: the exported CRL list. Should be treated as constant
* @ncrls: the number of exported CRLs
@@ -155,7 +155,7 @@ gnutls_certificate_get_x509_crls
(gnutls_certificate_credentials_t sc,
#ifdef ENABLE_OPENPGP
/**
- * gnutls_certificate_get_openpgp_keyring - export keyring from a
#gnutls_certificate_credentials_t
+ * gnutls_certificate_get_openpgp_keyring:
* @sc: is a #gnutls_certificate_credentials_t structure.
* @keyring: the exported keyring. Should be treated as constant
*
@@ -174,7 +174,7 @@ gnutls_certificate_get_openpgp_keyring
(gnutls_certificate_credentials_t sc,
#endif
/**
- * gnutls_certificate_free_ca_names - Used to free all the CA names from a
gnutls_certificate_credentials_t structure
+ * gnutls_certificate_free_ca_names:
* @sc: is a #gnutls_certificate_credentials_t structure.
*
* This function will delete all the CA name in the given
@@ -230,7 +230,7 @@ _gnutls_certificate_get_rsa_params (gnutls_rsa_params_t
rsa_params,
/**
- * gnutls_certificate_free_credentials - Used to free an allocated
gnutls_certificate_credentials_t structure
+ * gnutls_certificate_free_credentials:
* @sc: is a #gnutls_certificate_credentials_t structure.
*
* This structure is complex enough to manipulate directly thus this
@@ -259,7 +259,7 @@ gnutls_certificate_free_credentials
(gnutls_certificate_credentials_t sc)
/**
- * gnutls_certificate_allocate_credentials - Used to allocate a
gnutls_certificate_credentials_t structure
+ * gnutls_certificate_allocate_credentials:
* @res: is a pointer to a #gnutls_certificate_credentials_t structure.
*
* This structure is complex enough to manipulate directly thus this
@@ -343,7 +343,7 @@ _gnutls_selected_cert_supported_kx (gnutls_session_t
session,
/**
- * gnutls_certificate_server_set_request - Used to set whether to request a
client certificate
+ * gnutls_certificate_server_set_request:
* @session: is a #gnutls_session_t structure.
* @req: is one of GNUTLS_CERT_REQUEST, GNUTLS_CERT_REQUIRE
*
@@ -361,7 +361,7 @@ gnutls_certificate_server_set_request (gnutls_session_t
session,
}
/**
- * gnutls_certificate_client_set_retrieve_function - Used to set a callback to
retrieve the certificate
+ * gnutls_certificate_client_set_retrieve_function:
* @cred: is a #gnutls_certificate_credentials_t structure.
* @func: is the callback function
*
@@ -399,7 +399,7 @@ void gnutls_certificate_client_set_retrieve_function
}
/**
- * gnutls_certificate_server_set_retrieve_function - Used to set a callback to
retrieve the certificate
+ * gnutls_certificate_server_set_retrieve_function:
* @cred: is a #gnutls_certificate_credentials_t structure.
* @func: is the callback function
*
@@ -460,7 +460,7 @@ _gnutls_x509_get_raw_crt_activation_time (const
gnutls_datum_t * cert)
}
/*-
- * gnutls_x509_extract_certificate_expiration_time - return the certificate's
expiration time
+ * gnutls_x509_extract_certificate_expiration_time:
* @cert: should contain an X.509 DER encoded certificate
*
* This function will return the certificate's expiration time in UNIX
@@ -557,7 +557,7 @@ _gnutls_openpgp_crt_verify_peers (gnutls_session_t session,
#endif
/**
- * gnutls_certificate_verify_peers2 - return the peer's certificate
verification status
+ * gnutls_certificate_verify_peers2:
* @session: is a gnutls session
* @status: is the output of the verification
*
@@ -613,7 +613,7 @@ gnutls_certificate_verify_peers2 (gnutls_session_t session,
}
/**
- * gnutls_certificate_verify_peers - return the peer's certificate
verification status
+ * gnutls_certificate_verify_peers:
* @session: is a gnutls session
*
* This function will try to verify the peer's certificate and return
@@ -646,7 +646,7 @@ gnutls_certificate_verify_peers (gnutls_session_t session)
}
/**
- * gnutls_certificate_expiration_time_peers - return the peer's certificate
expiration time
+ * gnutls_certificate_expiration_time_peers:
* @session: is a gnutls session
*
* This function will return the peer's certificate expiration time.
@@ -692,7 +692,7 @@ gnutls_certificate_expiration_time_peers (gnutls_session_t
session)
}
/**
- * gnutls_certificate_activation_time_peers - return the peer's certificate
activation time
+ * gnutls_certificate_activation_time_peers:
* @session: is a gnutls session
*
* This function will return the peer's certificate activation time.
diff --git a/lib/gnutls_compress.c b/lib/gnutls_compress.c
index 67044de..05e980a 100644
--- a/lib/gnutls_compress.c
+++ b/lib/gnutls_compress.c
@@ -121,7 +121,7 @@ static const gnutls_compression_method_t
supported_compressions[] = {
/* Compression Functions */
/**
- * gnutls_compression_get_name - Returns a string with the name of the
specified compression algorithm
+ * gnutls_compression_get_name:
* @algorithm: is a Compression algorithm
*
* Convert a #gnutls_compression_method_t value to a string.
@@ -141,7 +141,7 @@ gnutls_compression_get_name (gnutls_compression_method_t
algorithm)
}
/**
- * gnutls_compression_get_id - Returns the gnutls id of the specified in
string algorithm
+ * gnutls_compression_get_id:
* @name: is a compression method name
*
* The names are compared in a case insensitive way.
@@ -163,7 +163,7 @@ gnutls_compression_get_id (const char *name)
}
/**
- * gnutls_compression_list - Get a list of supported compression methods
+ * gnutls_compression_list:
*
* Get a list of compression methods. Note that to be able to use LZO
* compression, you must link to libgnutls-extra and call
diff --git a/lib/gnutls_db.c b/lib/gnutls_db.c
index e92d53c..4e49ac4 100644
--- a/lib/gnutls_db.c
+++ b/lib/gnutls_db.c
@@ -35,7 +35,7 @@
#include <gnutls_datum.h>
/**
- * gnutls_db_set_retrieve_function - Set the function that will be used to get
data
+ * gnutls_db_set_retrieve_function:
* @session: is a #gnutls_session_t structure.
* @retr_func: is the function.
*
@@ -58,7 +58,7 @@ gnutls_db_set_retrieve_function (gnutls_session_t session,
}
/**
- * gnutls_db_set_remove_function - Set the function that will be used to
remove data
+ * gnutls_db_set_remove_function:
* @session: is a #gnutls_session_t structure.
* @rem_func: is the function.
*
@@ -76,7 +76,7 @@ gnutls_db_set_remove_function (gnutls_session_t session,
}
/**
- * gnutls_db_set_store_function - Set the function that will be used to put
data
+ * gnutls_db_set_store_function:
* @session: is a #gnutls_session_t structure.
* @store_func: is the function
*
@@ -94,7 +94,7 @@ gnutls_db_set_store_function (gnutls_session_t session,
}
/**
- * gnutls_db_set_ptr - Set a pointer to be sent to db functions
+ * gnutls_db_set_ptr:
* @session: is a #gnutls_session_t structure.
* @ptr: is the pointer
*
@@ -108,7 +108,7 @@ gnutls_db_set_ptr (gnutls_session_t session, void *ptr)
}
/**
- * gnutls_db_get_ptr - Returns the pointer which is sent to db functions
+ * gnutls_db_get_ptr:
* @session: is a #gnutls_session_t structure.
*
* Get db function pointer.
@@ -123,7 +123,7 @@ gnutls_db_get_ptr (gnutls_session_t session)
}
/**
- * gnutls_db_set_cache_expiration - Set the expiration time for resumed
sessions.
+ * gnutls_db_set_cache_expiration:
* @session: is a #gnutls_session_t structure.
* @seconds: is the number of seconds.
*
@@ -137,7 +137,7 @@ gnutls_db_set_cache_expiration (gnutls_session_t session,
int seconds)
}
/**
- * gnutls_db_check_entry - check if the given db entry has expired
+ * gnutls_db_check_entry:
* @session: is a #gnutls_session_t structure.
* @session_entry: is the session data (not key)
*
@@ -362,7 +362,7 @@ _gnutls_remove_session (gnutls_session_t session,
gnutls_datum_t session_id)
}
/**
- * gnutls_db_remove_session - remove the current session data from the database
+ * gnutls_db_remove_session:
* @session: is a #gnutls_session_t structure.
*
* This function will remove the current session data from the
diff --git a/lib/gnutls_dh_primes.c b/lib/gnutls_dh_primes.c
index 2d79f07..242ec89 100644
--- a/lib/gnutls_dh_primes.c
+++ b/lib/gnutls_dh_primes.c
@@ -54,7 +54,7 @@ _gnutls_dh_params_to_mpi (gnutls_dh_params_t dh_primes)
* generated one.
*/
/**
- * gnutls_dh_params_import_raw - import DH parameters
+ * gnutls_dh_params_import_raw:
* @dh_params: Is a structure that will hold the prime numbers
* @prime: holds the new prime
* @generator: holds the new generator
@@ -99,7 +99,7 @@ gnutls_dh_params_import_raw (gnutls_dh_params_t dh_params,
}
/**
- * gnutls_dh_params_init - initialize the DH parameters
+ * gnutls_dh_params_init:
* @dh_params: Is a structure that will hold the prime numbers
*
* This function will initialize the DH parameters structure.
@@ -123,7 +123,7 @@ gnutls_dh_params_init (gnutls_dh_params_t * dh_params)
}
/**
- * gnutls_dh_params_deinit - deinitialize the DH parameters
+ * gnutls_dh_params_deinit:
* @dh_params: Is a structure that holds the prime numbers
*
* This function will deinitialize the DH parameters structure.
@@ -142,7 +142,7 @@ gnutls_dh_params_deinit (gnutls_dh_params_t dh_params)
}
/**
- * gnutls_dh_params_cpy - copy a DH parameters structure
+ * gnutls_dh_params_cpy:
* @dst: Is the destination structure, which should be initialized.
* @src: Is the source structure
*
@@ -169,7 +169,7 @@ gnutls_dh_params_cpy (gnutls_dh_params_t dst,
gnutls_dh_params_t src)
/**
- * gnutls_dh_params_generate2 - generate new DH parameters
+ * gnutls_dh_params_generate2:
* @params: Is the structure that the DH parameters will be stored
* @bits: is the prime's number of bits
*
@@ -206,7 +206,7 @@ gnutls_dh_params_generate2 (gnutls_dh_params_t params,
unsigned int bits)
}
/**
- * gnutls_dh_params_import_pkcs3 - import DH params from a pkcs3 structure
+ * gnutls_dh_params_import_pkcs3:
* @params: A structure where the parameters will be copied to
* @pkcs3_params: should contain a PKCS3 DHParams structure PEM or DER encoded
* @format: the format of params. PEM or DER.
@@ -315,7 +315,7 @@ gnutls_dh_params_import_pkcs3 (gnutls_dh_params_t params,
}
/**
- * gnutls_dh_params_export_pkcs3 - export DH params to a pkcs3 structure
+ * gnutls_dh_params_export_pkcs3:
* @params: Holds the DH parameters
* @format: the format of output params. One of PEM or DER.
* @params_data: will contain a PKCS3 DHParams structure PEM or DER encoded
@@ -491,7 +491,7 @@ gnutls_dh_params_export_pkcs3 (gnutls_dh_params_t params,
}
/**
- * gnutls_dh_params_export_raw - export the raw DH parameters
+ * gnutls_dh_params_export_raw:
* @params: Holds the DH parameters
* @prime: will hold the new prime
* @generator: will hold the new generator
diff --git a/lib/gnutls_errors.c b/lib/gnutls_errors.c
index 0de3741..69d92ad 100644
--- a/lib/gnutls_errors.c
+++ b/lib/gnutls_errors.c
@@ -274,7 +274,7 @@ static const gnutls_error_entry error_algorithms[] = {
};
/**
- * gnutls_error_is_fatal - Returns non-zero in case of a fatal error
+ * gnutls_error_is_fatal:
* @error: is a GnuTLS error code, a negative value
*
* If a GnuTLS function returns a negative value you may feed that
@@ -313,7 +313,7 @@ gnutls_error_is_fatal (int error)
}
/**
- * gnutls_perror - prints a string to stderr with a description of an error
+ * gnutls_perror:
* @error: is a GnuTLS error code, a negative value
*
* This function is like perror(). The only difference is that it
@@ -327,7 +327,7 @@ gnutls_perror (int error)
/**
- * gnutls_strerror - Returns a string with a description of an error
+ * gnutls_strerror:
* @error: is a GnuTLS error code, a negative value
*
* This function is similar to strerror. The difference is that it
diff --git a/lib/gnutls_extensions.c b/lib/gnutls_extensions.c
index e76a54d..f330144 100644
--- a/lib/gnutls_extensions.c
+++ b/lib/gnutls_extensions.c
@@ -383,7 +383,7 @@ _gnutls_ext_deinit (void)
}
/**
- * gnutls_ext_register - Register a handler for a TLS extension
+ * gnutls_ext_register:
* @type: the 16-bit integer referring to the extension type
* @name: human printable name of the extension used for debugging
* @parse_type: either #GNUTLS_EXT_TLS or %GNUTLS_EXT_APPLICATION.
diff --git a/lib/gnutls_global.c b/lib/gnutls_global.c
index 01b6ce4..baa6652 100644
--- a/lib/gnutls_global.c
+++ b/lib/gnutls_global.c
@@ -51,7 +51,7 @@ gnutls_log_func _gnutls_log_func;
int _gnutls_log_level = 0; /* default log level */
/**
- * gnutls_global_set_log_function - set the logging function
+ * gnutls_global_set_log_function:
* @log_func: it's a log function
*
* This is the function where you set the logging function gnutls is
@@ -69,7 +69,7 @@ gnutls_global_set_log_function (gnutls_log_func log_func)
}
/**
- * gnutls_global_set_log_level - set the logging level
+ * gnutls_global_set_log_level:
* @level: it's an integer from 0 to 9.
*
* This is the function that allows you to set the log level. The
@@ -86,7 +86,7 @@ gnutls_global_set_log_level (int level)
}
/**
- * gnutls_global_set_mem_functions - set the memory allocation functions
+ * gnutls_global_set_mem_functions:
* @alloc_func: it's the default memory allocation function. Like malloc().
* @secure_alloc_func: This is the memory allocation function that will be
used for sensitive data.
* @is_secure_func: a function that returns 0 if the memory given is not
secure. May be NULL.
@@ -138,7 +138,7 @@ gnutls_global_set_mem_functions (gnutls_alloc_function
alloc_func,
static int _gnutls_init = 0;
/**
- * gnutls_global_init - initialize the global data to defaults.
+ * gnutls_global_init:
*
* This function initializes the global data to defaults. Every
* gnutls application has a global data which holds common parameters
@@ -256,7 +256,7 @@ out:
}
/**
- * gnutls_global_deinit - deinitialize the global data
+ * gnutls_global_deinit:
*
* This function deinitializes the global data, that were initialized
* using gnutls_global_init().
@@ -285,7 +285,7 @@ gnutls_global_deinit (void)
*/
/**
- * gnutls_transport_set_pull_function - set a read like function
+ * gnutls_transport_set_pull_function:
* @pull_func: a callback function similar to read()
* @session: gnutls session
*
@@ -304,7 +304,7 @@ gnutls_transport_set_pull_function (gnutls_session_t
session,
}
/**
- * gnutls_transport_set_push_function - set the function to send data
+ * gnutls_transport_set_push_function:
* @push_func: a callback function similar to write()
* @session: gnutls session
*
@@ -325,7 +325,7 @@ gnutls_transport_set_push_function (gnutls_session_t
session,
}
/**
- * gnutls_check_version - checks the libgnutls version
+ * gnutls_check_version:
* @req_version: version string to compare with, or %NULL.
*
* Check GnuTLS Library version.
diff --git a/lib/gnutls_handshake.c b/lib/gnutls_handshake.c
index a3c07a4..4e2952a 100644
--- a/lib/gnutls_handshake.c
+++ b/lib/gnutls_handshake.c
@@ -2495,7 +2495,7 @@ _gnutls_recv_hello (gnutls_session_t session, opaque *
data, int datalen)
*/
/**
- * gnutls_rehandshake - renegotiate security parameters
+ * gnutls_rehandshake:
* @session: is a #gnutls_session_t structure.
*
* This function will renegotiate security parameters with the
@@ -2699,7 +2699,7 @@ _gnutls_recv_supplemental (gnutls_session_t session)
}
/**
- * gnutls_handshake - This is the main function in the handshake protocol.
+ * gnutls_handshake:
* @session: is a #gnutls_session_t structure.
*
* This function does the handshake of the TLS/SSL protocol, and
@@ -3492,7 +3492,7 @@ _gnutls_remove_unwanted_ciphersuites (gnutls_session_t
session,
}
/**
- * gnutls_handshake_set_max_packet_length - set the maximum size of the
handshake
+ * gnutls_handshake_set_max_packet_length:
* @session: is a #gnutls_session_t structure.
* @max: is the maximum number.
*
@@ -3526,7 +3526,7 @@ _gnutls_get_adv_version (gnutls_session_t session)
}
/**
- * gnutls_handshake_get_last_in - Returns the last handshake message received.
+ * gnutls_handshake_get_last_in:
* @session: is a #gnutls_session_t structure.
*
* This function is only useful to check where the last performed
@@ -3546,7 +3546,7 @@ gnutls_handshake_get_last_in (gnutls_session_t session)
}
/**
- * gnutls_handshake_get_last_out - Returns the last handshake message sent.
+ * gnutls_handshake_get_last_out:
* @session: is a #gnutls_session_t structure.
*
* This function is only useful to check where the last performed
diff --git a/lib/gnutls_mem.c b/lib/gnutls_mem.c
index f6caa8f..68fbff5 100644
--- a/lib/gnutls_mem.c
+++ b/lib/gnutls_mem.c
@@ -105,7 +105,7 @@ _gnutls_strdup (const char *str)
*/
/**
- * gnutls_malloc - Allocates and returns data
+ * gnutls_malloc:
*
* This function will allocate 's' bytes data, and
* return a pointer to memory. This function is supposed
@@ -120,7 +120,7 @@ gnutls_malloc (size_t s)
}
/**
- * gnutls_free - Returns a free() like function
+ * gnutls_free:
* @d: pointer to memory
*
* This function will free data pointed by ptr.
diff --git a/lib/gnutls_priority.c b/lib/gnutls_priority.c
index d00457a..8524dbe 100644
--- a/lib/gnutls_priority.c
+++ b/lib/gnutls_priority.c
@@ -37,7 +37,7 @@ break_comma_list (char *etag,
char sep);
/**
- * gnutls_cipher_set_priority - Sets the priority on the ciphers supported by
gnutls.
+ * gnutls_cipher_set_priority:
* @session: is a #gnutls_session_t structure.
* @list: is a 0 terminated list of gnutls_cipher_algorithm_t elements.
*
@@ -89,7 +89,7 @@ _set_priority (priority_st * st, const int *list)
}
/**
- * gnutls_kx_set_priority - Sets the priority on the key exchange algorithms
supported by gnutls.
+ * gnutls_kx_set_priority:
* @session: is a #gnutls_session_t structure.
* @list: is a 0 terminated list of gnutls_kx_algorithm_t elements.
*
@@ -109,7 +109,7 @@ gnutls_kx_set_priority (gnutls_session_t session, const int
*list)
}
/**
- * gnutls_mac_set_priority - Sets the priority on the mac algorithms supported
by gnutls.
+ * gnutls_mac_set_priority:
* @session: is a #gnutls_session_t structure.
* @list: is a 0 terminated list of gnutls_mac_algorithm_t elements.
*
@@ -129,7 +129,7 @@ gnutls_mac_set_priority (gnutls_session_t session, const
int *list)
}
/**
- * gnutls_compression_set_priority - Sets the priority on the compression
algorithms supported by gnutls.
+ * gnutls_compression_set_priority:
* @session: is a #gnutls_session_t structure.
* @list: is a 0 terminated list of gnutls_compression_method_t elements.
*
@@ -153,7 +153,7 @@ gnutls_compression_set_priority (gnutls_session_t session,
const int *list)
}
/**
- * gnutls_protocol_set_priority - Sets the priority on the protocol versions
supported by gnutls.
+ * gnutls_protocol_set_priority:
* @session: is a #gnutls_session_t structure.
* @list: is a 0 terminated list of gnutls_protocol_t elements.
*
@@ -180,7 +180,7 @@ gnutls_protocol_set_priority (gnutls_session_t session,
const int *list)
}
/**
- * gnutls_certificate_type_set_priority - Sets the priority on the certificate
types supported by gnutls.
+ * gnutls_certificate_type_set_priority:
* @session: is a #gnutls_session_t structure.
* @list: is a 0 terminated list of gnutls_certificate_type_t elements.
*
@@ -427,7 +427,7 @@ prio_add (priority_st * priority_list, unsigned int algo)
/**
- * gnutls_priority_set - Sets priorities for the cipher suites supported by
gnutls.
+ * gnutls_priority_set:
* @session: is a #gnutls_session_t structure.
* @priority: is a #gnutls_priority_t structure.
*
@@ -463,7 +463,7 @@ gnutls_priority_set (gnutls_session_t session,
gnutls_priority_t priority)
#define MAX_ELEMENTS 48
/**
- * gnutls_priority_init - Sets priorities for the cipher suites supported by
gnutls.
+ * gnutls_priority_init:
* @priority_cache: is a #gnutls_prioritity_t structure.
* @priorities: is a string describing priorities
* @err_pos: In case of an error this will have the position in the string the
error occured
@@ -753,7 +753,7 @@ error:
}
/**
- * gnutls_priority_deinit - deinitialize the priorities cache
+ * gnutls_priority_deinit:
* @priority_cache: is a #gnutls_prioritity_t structure.
*
* Deinitializes the priority cache.
@@ -766,7 +766,7 @@ gnutls_priority_deinit (gnutls_priority_t priority_cache)
/**
- * gnutls_priority_set_direct - Sets priorities for the cipher suites
supported by gnutls.
+ * gnutls_priority_set_direct:
* @session: is a #gnutls_session_t structure.
* @priorities: is a string describing priorities
* @err_pos: In case of an error this will have the position in the string the
error occured
@@ -840,7 +840,7 @@ break_comma_list (char *etag,
}
/**
- * gnutls_set_default_priority - Sets some default priority on the cipher
suites supported by gnutls.
+ * gnutls_set_default_priority:
* @session: is a #gnutls_session_t structure.
*
* Sets some default priority on the ciphers, key exchange methods,
@@ -865,7 +865,7 @@ gnutls_set_default_priority (gnutls_session_t session)
}
/**
- * gnutls_set_default_export_priority - Sets some default priority on the
cipher suites supported by gnutls.
+ * gnutls_set_default_export_priority:
* @session: is a #gnutls_session_t structure.
*
* Sets some default priority on the ciphers, key exchange methods, macs
diff --git a/lib/gnutls_psk.c b/lib/gnutls_psk.c
index f98352d..67cef93 100644
--- a/lib/gnutls_psk.c
+++ b/lib/gnutls_psk.c
@@ -39,7 +39,7 @@
#include "debug.h"
/**
- * gnutls_psk_free_client_credentials - Used to free an allocated
gnutls_psk_client_credentials_t structure
+ * gnutls_psk_free_client_credentials:
* @sc: is a #gnutls_psk_client_credentials_t structure.
*
* This structure is complex enough to manipulate directly thus this
@@ -54,7 +54,7 @@ gnutls_psk_free_client_credentials
(gnutls_psk_client_credentials_t sc)
}
/**
- * gnutls_psk_allocate_client_credentials - Used to allocate an
gnutls_psk_server_credentials_t structure
+ * gnutls_psk_allocate_client_credentials:
* @sc: is a pointer to a #gnutls_psk_server_credentials_t structure.
*
* This structure is complex enough to manipulate directly thus this
@@ -74,7 +74,7 @@ gnutls_psk_allocate_client_credentials
(gnutls_psk_client_credentials_t * sc)
}
/**
- * gnutls_psk_set_client_credentials - Used to set the username/password, in a
gnutls_psk_client_credentials_t structure
+ * gnutls_psk_set_client_credentials:
* @res: is a #gnutls_psk_client_credentials_t structure.
* @username: is the user's zero-terminated userid
* @key: is the user's key
@@ -148,7 +148,7 @@ error:
}
/**
- * gnutls_psk_free_server_credentials - Used to free an allocated
gnutls_psk_server_credentials_t structure
+ * gnutls_psk_free_server_credentials:
* @sc: is a #gnutls_psk_server_credentials_t structure.
*
* This structure is complex enough to manipulate directly thus this
@@ -162,7 +162,7 @@ gnutls_psk_free_server_credentials
(gnutls_psk_server_credentials_t sc)
}
/**
- * gnutls_psk_allocate_server_credentials - Used to allocate an
gnutls_psk_server_credentials_t structure
+ * gnutls_psk_allocate_server_credentials:
* @sc: is a pointer to a #gnutls_psk_server_credentials_t structure.
*
* This structure is complex enough to manipulate directly thus this
@@ -183,7 +183,7 @@ gnutls_psk_allocate_server_credentials
(gnutls_psk_server_credentials_t * sc)
/**
- * gnutls_psk_set_server_credentials_file - Used to set the password files, in
a gnutls_psk_server_credentials_t structure
+ * gnutls_psk_set_server_credentials_file:
* @res: is a #gnutls_psk_server_credentials_t structure.
* @password_file: is the PSK password file (passwd.psk)
*
@@ -222,7 +222,7 @@ gnutls_psk_set_server_credentials_file
(gnutls_psk_server_credentials_t
}
/**
- * gnutls_psk_set_server_credentials_hint - Set a identity hint, in a
%gnutls_psk_server_credentials_t structure
+ * gnutls_psk_set_server_credentials_hint:
* @res: is a #gnutls_psk_server_credentials_t structure.
* @hint: is the PSK identity hint string
*
@@ -250,7 +250,7 @@ gnutls_psk_set_server_credentials_hint
(gnutls_psk_server_credentials_t res,
}
/**
- * gnutls_psk_set_server_credentials_function - Used to set a callback to
retrieve the user's PSK credentials
+ * gnutls_psk_set_server_credentials_function:
* @cred: is a #gnutls_psk_server_credentials_t structure.
* @func: is the callback function
*
@@ -279,7 +279,7 @@ gnutls_psk_set_server_credentials_function
(gnutls_psk_server_credentials_t
}
/**
- * gnutls_psk_set_client_credentials_function - Used to set a callback to
retrieve the username and key
+ * gnutls_psk_set_client_credentials_function:
* @cred: is a #gnutls_psk_server_credentials_t structure.
* @func: is the callback function
*
@@ -309,7 +309,7 @@ gnutls_psk_set_client_credentials_function
(gnutls_psk_client_credentials_t
/**
- * gnutls_psk_server_get_username - return the username of the peer
+ * gnutls_psk_server_get_username:
* @session: is a gnutls session
*
* This should only be called in case of PSK authentication and in
@@ -335,7 +335,7 @@ gnutls_psk_server_get_username (gnutls_session_t session)
}
/**
- * gnutls_psk_client_get_hint - return the PSK identity hint of the peer
+ * gnutls_psk_client_get_hint:
* @session: is a gnutls session
*
* The PSK identity hint may give the client help in deciding which
@@ -364,7 +364,7 @@ gnutls_psk_client_get_hint (gnutls_session_t session)
}
/**
- * gnutls_hex_decode - decode hex encoded data
+ * gnutls_hex_decode:
* @hex_data: contain the encoded data
* @result: the place where decoded data will be copied
* @result_size: holds the size of the result
@@ -393,7 +393,7 @@ gnutls_hex_decode (const gnutls_datum_t * hex_data, char
*result,
}
/**
- * gnutls_hex_encode - convert raw data to hex encoded
+ * gnutls_hex_encode:
* @data: contain the raw data
* @result: the place where hex data will be copied
* @result_size: holds the size of the result
@@ -423,7 +423,7 @@ gnutls_hex_encode (const gnutls_datum_t * data, char
*result,
}
/**
- * gnutls_psk_set_server_dh_params - set the DH parameters for a server to use
+ * gnutls_psk_set_server_dh_params:
* @res: is a gnutls_psk_server_credentials_t structure
* @dh_params: is a structure that holds Diffie-Hellman parameters.
*
@@ -439,7 +439,7 @@ gnutls_psk_set_server_dh_params
(gnutls_psk_server_credentials_t res,
}
/**
- * gnutls_psk_set_server_params_function - set the DH parameters callback
+ * gnutls_psk_set_server_params_function:
* @res: is a #gnutls_certificate_credentials_t structure
* @func: is the function to be called
*
diff --git a/lib/gnutls_psk_netconf.c b/lib/gnutls_psk_netconf.c
index b6e5b9a..99bbd03 100644
--- a/lib/gnutls_psk_netconf.c
+++ b/lib/gnutls_psk_netconf.c
@@ -32,7 +32,7 @@
/**
- * gnutls_psk_netconf_derive_key - derive PSK Netconf key from password
+ * gnutls_psk_netconf_derive_key:
* @password: zero terminated string containing password.
* @psk_identity: zero terminated string with PSK identity.
* @psk_identity_hint: zero terminated string with PSK identity hint.
diff --git a/lib/gnutls_record.c b/lib/gnutls_record.c
index c90d316..f1cf2ac 100644
--- a/lib/gnutls_record.c
+++ b/lib/gnutls_record.c
@@ -46,7 +46,7 @@
#include <gnutls_dh.h>
/**
- * gnutls_protocol_get_version - Returns the version of the currently used
protocol
+ * gnutls_protocol_get_version:
* @session: is a #gnutls_session_t structure.
*
* Get TLS version, a #gnutls_protocol_t value.
@@ -67,7 +67,7 @@ _gnutls_set_current_version (gnutls_session_t session,
}
/**
- * gnutls_transport_set_lowat - Used to set the lowat value in order for
select to check for pending data.
+ * gnutls_transport_set_lowat:
* @session: is a #gnutls_session_t structure.
* @num: is the low water value.
*
@@ -85,7 +85,7 @@ gnutls_transport_set_lowat (gnutls_session_t session, int num)
}
/**
- * gnutls_record_disable_padding - Used to disabled padding in TLS 1.0 and
above
+ * gnutls_record_disable_padding:
* @session: is a #gnutls_session_t structure.
*
* Used to disabled padding in TLS 1.0 and above. Normally you do not
@@ -103,7 +103,7 @@ gnutls_record_disable_padding (gnutls_session_t session)
}
/**
- * gnutls_transport_set_ptr - Used to set first argument of the transport
functions
+ * gnutls_transport_set_ptr:
* @session: is a #gnutls_session_t structure.
* @ptr: is the value.
*
@@ -120,7 +120,7 @@ gnutls_transport_set_ptr (gnutls_session_t session,
}
/**
- * gnutls_transport_set_ptr2 - Used to set first argument of the transport
functions
+ * gnutls_transport_set_ptr2:
* @session: is a #gnutls_session_t structure.
* @recv_ptr: is the value for the pull function
* @send_ptr: is the value for the push function
@@ -140,7 +140,7 @@ gnutls_transport_set_ptr2 (gnutls_session_t session,
}
/**
- * gnutls_transport_get_ptr - Used to return the first argument of the
transport functions
+ * gnutls_transport_get_ptr:
* @session: is a #gnutls_session_t structure.
*
* Used to get the first argument of the transport function (like
@@ -156,7 +156,7 @@ gnutls_transport_get_ptr (gnutls_session_t session)
}
/**
- * gnutls_transport_get_ptr2 - Used to return the first argument of the
transport functions
+ * gnutls_transport_get_ptr2:
* @session: is a #gnutls_session_t structure.
* @recv_ptr: will hold the value for the pull function
* @send_ptr: will hold the value for the push function
@@ -176,7 +176,7 @@ gnutls_transport_get_ptr2 (gnutls_session_t session,
}
/**
- * gnutls_bye - terminate the current TLS/SSL connection.
+ * gnutls_bye:
* @session: is a #gnutls_session_t structure.
* @how: is an integer
*
@@ -1108,7 +1108,7 @@ begin:
/**
- * gnutls_record_send - sends to the peer the specified data
+ * gnutls_record_send:
* @session: is a #gnutls_session_t structure.
* @data: contains the data to send
* @sizeofdata: is the length of the data
@@ -1144,7 +1144,7 @@ gnutls_record_send (gnutls_session_t session, const void
*data,
}
/**
- * gnutls_record_recv - reads data from the TLS record protocol
+ * gnutls_record_recv:
* @session: is a #gnutls_session_t structure.
* @data: the buffer that the data will be read into
* @sizeofdata: the number of requested bytes
@@ -1181,7 +1181,7 @@ gnutls_record_recv (gnutls_session_t session, void *data,
size_t sizeofdata)
}
/**
- * gnutls_record_get_max_size - returns the maximum record size
+ * gnutls_record_get_max_size:
* @session: is a #gnutls_session_t structure.
*
* Get the record size. The maximum record size is negotiated by the
@@ -1200,7 +1200,7 @@ gnutls_record_get_max_size (gnutls_session_t session)
/**
- * gnutls_record_set_max_size - sets the maximum record size
+ * gnutls_record_set_max_size:
* @session: is a #gnutls_session_t structure.
* @size: is the new size
*
diff --git a/lib/gnutls_rsa_export.c b/lib/gnutls_rsa_export.c
index 96879fb..0f5a1ef 100644
--- a/lib/gnutls_rsa_export.c
+++ b/lib/gnutls_rsa_export.c
@@ -49,7 +49,7 @@ _gnutls_rsa_params_to_mpi (gnutls_rsa_params_t rsa_params)
}
/**
- * gnutls_rsa_params_import_raw - set the RSA parameters
+ * gnutls_rsa_params_import_raw:
* @rsa_params: Is a structure will hold the parameters
* @m: holds the modulus
* @e: holds the public exponent
@@ -77,7 +77,7 @@ gnutls_rsa_params_import_raw (gnutls_rsa_params_t rsa_params,
}
/**
- * gnutls_rsa_params_init - initialize the temporary RSA parameters
+ * gnutls_rsa_params_init:
* @rsa_params: Is a structure that will hold the parameters
*
* This function will initialize the temporary RSA parameters structure.
@@ -102,7 +102,7 @@ gnutls_rsa_params_init (gnutls_rsa_params_t * rsa_params)
}
/**
- * gnutls_rsa_params_deinit - deinitialize the RSA parameters
+ * gnutls_rsa_params_deinit:
* @rsa_params: Is a structure that holds the parameters
*
* This function will deinitialize the RSA parameters structure.
@@ -114,7 +114,7 @@ gnutls_rsa_params_deinit (gnutls_rsa_params_t rsa_params)
}
/**
- * gnutls_rsa_params_cpy - copy an RSA parameters structure
+ * gnutls_rsa_params_cpy:
* @dst: Is the destination structure, which should be initialized.
* @src: Is the source structure
*
@@ -130,7 +130,7 @@ gnutls_rsa_params_cpy (gnutls_rsa_params_t dst,
gnutls_rsa_params_t src)
}
/**
- * gnutls_rsa_params_generate2 - generate temporary RSA parameters
+ * gnutls_rsa_params_generate2:
* @params: The structure where the parameters will be stored
* @bits: is the prime's number of bits
*
@@ -152,7 +152,7 @@ gnutls_rsa_params_generate2 (gnutls_rsa_params_t params,
unsigned int bits)
}
/**
- * gnutls_rsa_params_import_pkcs1 - import RSA params from a pkcs1 structure
+ * gnutls_rsa_params_import_pkcs1:
* @params: A structure where the parameters will be copied to
* @pkcs1_params: should contain a PKCS1 RSAPublicKey structure PEM or DER
encoded
* @format: the format of params. PEM or DER.
@@ -174,7 +174,7 @@ gnutls_rsa_params_import_pkcs1 (gnutls_rsa_params_t params,
}
/**
- * gnutls_rsa_params_export_pkcs1 - export RSA params to a pkcs1 structure
+ * gnutls_rsa_params_export_pkcs1:
* @params: Holds the RSA parameters
* @format: the format of output params. One of PEM or DER.
* @params_data: will contain a PKCS1 RSAPublicKey structure PEM or DER encoded
@@ -200,7 +200,7 @@ gnutls_rsa_params_export_pkcs1 (gnutls_rsa_params_t params,
}
/**
- * gnutls_rsa_params_export_raw - export the RSA parameters
+ * gnutls_rsa_params_export_raw:
* @params: a structure that holds the rsa parameters
* @m: will hold the modulus
* @e: will hold the public exponent
diff --git a/lib/gnutls_session.c b/lib/gnutls_session.c
index 1ef3b2b..19aee7a 100644
--- a/lib/gnutls_session.c
+++ b/lib/gnutls_session.c
@@ -29,7 +29,7 @@
#include <gnutls_datum.h>
/**
- * gnutls_session_get_data - Returns all session parameters.
+ * gnutls_session_get_data:
* @session: is a #gnutls_session_t structure.
* @session_data: is a pointer to space to hold the session.
* @session_data_size: is the session_data's size, or it will be set by the
function.
@@ -84,7 +84,7 @@ error:
}
/**
- * gnutls_session_get_data2 - Returns all session parameters.
+ * gnutls_session_get_data2:
* @session: is a #gnutls_session_t structure.
* @data: is a pointer to a datum that will hold the session.
*
@@ -127,7 +127,7 @@ gnutls_session_get_data2 (gnutls_session_t session,
gnutls_datum_t * data)
/**
- * gnutls_session_get_id - Returns session id.
+ * gnutls_session_get_id:
* @session: is a #gnutls_session_t structure.
* @session_id: is a pointer to space to hold the session id.
* @session_id_size: is the session id's size, or it will be set by the
function.
@@ -170,7 +170,7 @@ gnutls_session_get_id (gnutls_session_t session,
}
/**
- * gnutls_session_set_data - Sets all session parameters
+ * gnutls_session_set_data:
* @session: is a #gnutls_session_t structure.
* @session_data: is a pointer to space to hold the session.
* @session_data_size: is the session's size
diff --git a/lib/gnutls_srp.c b/lib/gnutls_srp.c
index f404e7f..3b9a858 100644
--- a/lib/gnutls_srp.c
+++ b/lib/gnutls_srp.c
@@ -391,7 +391,7 @@ freeall:
}
/**
- * gnutls_srp_free_client_credentials - Used to free an allocated
gnutls_srp_client_credentials_t structure
+ * gnutls_srp_free_client_credentials:
* @sc: is a #gnutls_srp_client_credentials_t structure.
*
* This structure is complex enough to manipulate directly thus
@@ -406,7 +406,7 @@ gnutls_srp_free_client_credentials
(gnutls_srp_client_credentials_t sc)
}
/**
- * gnutls_srp_allocate_client_credentials - Used to allocate an
gnutls_srp_server_credentials_t structure
+ * gnutls_srp_allocate_client_credentials:
* @sc: is a pointer to a #gnutls_srp_server_credentials_t structure.
*
* This structure is complex enough to manipulate directly thus
@@ -427,7 +427,7 @@ gnutls_srp_allocate_client_credentials
(gnutls_srp_client_credentials_t * sc)
}
/**
- * gnutls_srp_set_client_credentials - Used to set the username/password, in a
gnutls_srp_client_credentials_t structure
+ * gnutls_srp_set_client_credentials:
* @res: is a #gnutls_srp_client_credentials_t structure.
* @username: is the user's userid
* @password: is the user's password
@@ -467,7 +467,7 @@ gnutls_srp_set_client_credentials
(gnutls_srp_client_credentials_t res,
}
/**
- * gnutls_srp_free_server_credentials - Used to free an allocated
gnutls_srp_server_credentials_t structure
+ * gnutls_srp_free_server_credentials:
* @sc: is a #gnutls_srp_server_credentials_t structure.
*
* This structure is complex enough to manipulate directly thus
@@ -483,7 +483,7 @@ gnutls_srp_free_server_credentials
(gnutls_srp_server_credentials_t sc)
}
/**
- * gnutls_srp_allocate_server_credentials - Used to allocate an
gnutls_srp_server_credentials_t structure
+ * gnutls_srp_allocate_server_credentials:
* @sc: is a pointer to a #gnutls_srp_server_credentials_t structure.
*
* This structure is complex enough to manipulate directly thus this
@@ -504,7 +504,7 @@ gnutls_srp_allocate_server_credentials
(gnutls_srp_server_credentials_t * sc)
}
/**
- * gnutls_srp_set_server_credentials_file - Used to set the password files, in
a gnutls_srp_server_credentials_t structure
+ * gnutls_srp_set_server_credentials_file:
* @res: is a #gnutls_srp_server_credentials_t structure.
* @password_file: is the SRP password file (tpasswd)
* @password_conf_file: is the SRP password conf file (tpasswd.conf)
@@ -563,7 +563,7 @@ gnutls_srp_set_server_credentials_file
(gnutls_srp_server_credentials_t res,
/**
- * gnutls_srp_set_server_credentials_function - Used to set a callback to
retrieve the user's SRP credentials
+ * gnutls_srp_set_server_credentials_function:
* @cred: is a #gnutls_srp_server_credentials_t structure.
* @func: is the callback function
*
@@ -601,7 +601,7 @@ gnutls_srp_set_server_credentials_function
(gnutls_srp_server_credentials_t
}
/**
- * gnutls_srp_set_client_credentials_function - Used to set a callback to
retrieve the username and password
+ * gnutls_srp_set_client_credentials_function:
* @cred: is a #gnutls_srp_server_credentials_t structure.
* @func: is the callback function
*
@@ -636,7 +636,7 @@ gnutls_srp_set_client_credentials_function
(gnutls_srp_client_credentials_t
/**
- * gnutls_srp_server_get_username - return the username of the peer
+ * gnutls_srp_server_get_username:
* @session: is a gnutls session
*
* This function will return the username of the peer. This should
@@ -659,7 +659,7 @@ gnutls_srp_server_get_username (gnutls_session_t session)
}
/**
- * gnutls_srp_verifier - Used to calculate an SRP verifier
+ * gnutls_srp_verifier:
* @username: is the user's name
* @password: is the user's password
* @salt: should be some randomly generated bytes
@@ -724,7 +724,7 @@ gnutls_srp_verifier (const char *username, const char
*password,
}
/**
- * gnutls_srp_set_prime_bits - set the minimum bits for a SRP ciphersuite
+ * gnutls_srp_set_prime_bits:
* @session: is a #gnutls_session_t structure.
* @bits: is the number of bits
*
diff --git a/lib/gnutls_state.c b/lib/gnutls_state.c
index 26b6bde..d770ecd 100644
--- a/lib/gnutls_state.c
+++ b/lib/gnutls_state.c
@@ -62,7 +62,7 @@ _gnutls_session_cert_type_set (gnutls_session_t session,
}
/**
- * gnutls_cipher_get - Returns the currently used cipher.
+ * gnutls_cipher_get:
* @session: is a #gnutls_session_t structure.
*
* Get currently used cipher.
@@ -77,7 +77,7 @@ gnutls_cipher_get (gnutls_session_t session)
}
/**
- * gnutls_certificate_type_get - Returns the currently used certificate type.
+ * gnutls_certificate_type_get:
* @session: is a #gnutls_session_t structure.
*
* The certificate type is by default X.509, unless it is negotiated
@@ -93,7 +93,7 @@ gnutls_certificate_type_get (gnutls_session_t session)
}
/**
- * gnutls_kx_get - Returns the key exchange algorithm.
+ * gnutls_kx_get:
* @session: is a #gnutls_session_t structure.
*
* Get currently used key exchange algorithm.
@@ -108,7 +108,7 @@ gnutls_kx_get (gnutls_session_t session)
}
/**
- * gnutls_mac_get - Returns the currently used mac algorithm.
+ * gnutls_mac_get:
* @session: is a #gnutls_session_t structure.
*
* Get currently used MAC algorithm.
@@ -123,7 +123,7 @@ gnutls_mac_get (gnutls_session_t session)
}
/**
- * gnutls_compression_get - Returns the currently used compression algorithm.
+ * gnutls_compression_get:
* @session: is a #gnutls_session_t structure.
*
* Get currently used compression algorithm.
@@ -251,7 +251,7 @@ _gnutls_handshake_internal_state_clear (gnutls_session_t
session)
#define MIN_DH_BITS 727
/**
- * gnutls_init - initialize the session to null (null encryption etc...).
+ * gnutls_init:
* @con_end: indicate if this session is to be used for server or client.
* @session: is a pointer to a #gnutls_session_t structure.
*
@@ -363,7 +363,7 @@ _gnutls_session_is_resumable (gnutls_session_t session)
/**
- * gnutls_deinit - clear all buffers associated with a session
+ * gnutls_deinit:
* @session: is a #gnutls_session_t structure.
*
* This function clears all buffers associated with the @session.
@@ -675,7 +675,7 @@ _gnutls_dh_set_group (gnutls_session_t session, bigint_t
gen, bigint_t prime)
#ifdef ENABLE_OPENPGP
/**
- * gnutls_openpgp_send_cert - order gnutls to send the openpgp fingerprint
instead of the key
+ * gnutls_openpgp_send_cert:
* @session: is a pointer to a #gnutls_session_t structure.
* @status: is one of GNUTLS_OPENPGP_CERT, or GNUTLS_OPENPGP_CERT_FINGERPRINT
*
@@ -693,7 +693,7 @@ gnutls_openpgp_send_cert (gnutls_session_t session,
#endif
/**
- * gnutls_certificate_send_x509_rdn_sequence - order gnutls to send or not the
x.509 rdn sequence
+ * gnutls_certificate_send_x509_rdn_sequence:
* @session: is a pointer to a #gnutls_session_t structure.
* @status: is 0 or 1
*
@@ -740,7 +740,7 @@ _gnutls_record_set_default_version (gnutls_session_t
session,
}
/**
- * gnutls_handshake_set_private_extensions - Used to enable the private cipher
suites
+ * gnutls_handshake_set_private_extensions:
* @session: is a #gnutls_session_t structure.
* @allow: is an integer (0 or 1)
*
@@ -965,7 +965,7 @@ _gnutls_PRF (gnutls_session_t session,
}
/**
- * gnutls_prf_raw - access the TLS PRF directly
+ * gnutls_prf_raw:
* @session: is a #gnutls_session_t structure.
* @label_size: length of the @label variable.
* @label: label used in PRF computation, typically a short string.
@@ -1011,7 +1011,7 @@ gnutls_prf_raw (gnutls_session_t session,
}
/**
- * gnutls_prf - derive pseudo-random data using the TLS PRF
+ * gnutls_prf:
* @session: is a #gnutls_session_t structure.
* @label_size: length of the @label variable.
* @label: label used in PRF computation, typically a short string.
@@ -1076,7 +1076,7 @@ gnutls_prf (gnutls_session_t session,
}
/**
- * gnutls_session_get_client_random - get the session's client random value
+ * gnutls_session_get_client_random:
* @session: is a #gnutls_session_t structure.
*
* Return a pointer to the 32-byte client random field used in the
@@ -1095,7 +1095,7 @@ gnutls_session_get_client_random (gnutls_session_t
session)
}
/**
- * gnutls_session_get_server_random - get the session's server random value
+ * gnutls_session_get_server_random:
* @session: is a #gnutls_session_t structure.
*
* Return a pointer to the 32-byte server random field used in the
@@ -1114,7 +1114,7 @@ gnutls_session_get_server_random (gnutls_session_t
session)
}
/**
- * gnutls_session_get_master_secret - get the session's master secret value
+ * gnutls_session_get_master_secret:
* @session: is a #gnutls_session_t structure.
*
* Return a pointer to the 48-byte master secret in the session. The
@@ -1168,7 +1168,7 @@ gnutls_session_set_finished_function (gnutls_session_t
session,
}
/**
- * gnutls_session_is_resumed - check whether this session is a resumed one
+ * gnutls_session_is_resumed:
* @session: is a #gnutls_session_t structure.
*
* Check whether session is resumed or not.
@@ -1242,7 +1242,7 @@ _gnutls_session_is_psk (gnutls_session_t session)
}
/**
- * gnutls_session_get_ptr - Get the user pointer from the session structure
+ * gnutls_session_get_ptr:
* @session: is a #gnutls_session_t structure.
*
* Get user pointer for session. Useful in callbacks. This is the
@@ -1258,7 +1258,7 @@ gnutls_session_get_ptr (gnutls_session_t session)
}
/**
- * gnutls_session_set_ptr - Used to set the user pointer to the session
structure
+ * gnutls_session_set_ptr:
* @session: is a #gnutls_session_t structure.
* @ptr: is the user pointer
*
@@ -1274,7 +1274,7 @@ gnutls_session_set_ptr (gnutls_session_t session, void
*ptr)
/**
- * gnutls_record_get_direction - return the direction of the last interrupted
function call
+ * gnutls_record_get_direction:
* @session: is a #gnutls_session_t structure.
*
* This function provides information about the internals of the
@@ -1315,7 +1315,7 @@ _gnutls_rsa_pms_set_version (gnutls_session_t session,
}
/**
- * gnutls_handshake_set_post_client_hello_function - set callback to be called
after the client hello is received
+ * gnutls_handshake_set_post_client_hello_function:
* @session: is a #gnutls_session_t structure.
* @func: is the function to be called
*
@@ -1344,7 +1344,7 @@ gnutls_handshake_set_post_client_hello_function
(gnutls_session_t session,
}
/**
- * gnutls_session_enable_compatibility_mode - disable certain features in TLS
in order to honour compatibility
+ * gnutls_session_enable_compatibility_mode:
* @session: is a #gnutls_session_t structure.
*
* This function can be used to disable certain (security) features in
diff --git a/lib/gnutls_str.c b/lib/gnutls_str.c
index 02d6290..0bb4b2b 100644
--- a/lib/gnutls_str.c
+++ b/lib/gnutls_str.c
@@ -306,7 +306,7 @@ _gnutls_bin2hex (const void *_old, size_t oldlen,
}
/**
- * gnutls_hex2bin - convert hex string into binary buffer.
+ * gnutls_hex2bin:
* @hex_data: string with data in hex format
* @hex_size: size of hex data
* @bin_data: output array with binary data
diff --git a/lib/gnutls_ui.c b/lib/gnutls_ui.c
index 32f3e38..cbec3a3 100644
--- a/lib/gnutls_ui.c
+++ b/lib/gnutls_ui.c
@@ -40,7 +40,7 @@
/* ANON & DHE */
/**
- * gnutls_dh_set_prime_bits - Used to set the bits for a DH ciphersuite
+ * gnutls_dh_set_prime_bits:
* @session: is a #gnutls_session_t structure.
* @bits: is the number of bits
*
@@ -64,7 +64,7 @@ gnutls_dh_set_prime_bits (gnutls_session_t session, unsigned
int bits)
/**
- * gnutls_dh_get_group - return the group of the D-H key exchange
+ * gnutls_dh_get_group:
* @session: is a gnutls session
* @raw_gen: will hold the generator.
* @raw_prime: will hold the prime.
@@ -132,7 +132,7 @@ gnutls_dh_get_group (gnutls_session_t session,
}
/**
- * gnutls_dh_get_pubkey - return the peer's public key used in D-H key exchange
+ * gnutls_dh_get_pubkey:
* @session: is a gnutls session
* @raw_key: will hold the public key.
*
@@ -189,7 +189,7 @@ gnutls_dh_get_pubkey (gnutls_session_t session,
gnutls_datum_t * raw_key)
}
/**
- * gnutls_rsa_export_get_pubkey - return the peer's public key used in
RSA-EXPORT authentication
+ * gnutls_rsa_export_get_pubkey:
* @session: is a gnutls session
* @exponent: will hold the exponent.
* @modulus: will hold the modulus.
@@ -240,7 +240,7 @@ gnutls_rsa_export_get_pubkey (gnutls_session_t session,
/**
- * gnutls_dh_get_secret_bits - return the bits used in D-H key exchange
+ * gnutls_dh_get_secret_bits:
* @session: is a gnutls session
*
* This function will return the bits used in the last Diffie-Hellman
@@ -309,7 +309,7 @@ mpi_buf2bits (gnutls_datum_t * mpi_buf)
}
/**
- * gnutls_dh_get_prime_bits - return the bits used in D-H key exchange
+ * gnutls_dh_get_prime_bits:
* @session: is a gnutls session
*
* This function will return the bits of the prime used in the last
@@ -369,7 +369,7 @@ gnutls_dh_get_prime_bits (gnutls_session_t session)
}
/**
- * gnutls_rsa_export_get_modulus_bits - return the bits used in RSA-export key
exchange
+ * gnutls_rsa_export_get_modulus_bits:
* @session: is a gnutls session
*
* Get the export RSA parameter's modulus size.
@@ -390,7 +390,7 @@ gnutls_rsa_export_get_modulus_bits (gnutls_session_t
session)
}
/**
- * gnutls_dh_get_peers_public_bits - return the bits used in D-H key exchange
+ * gnutls_dh_get_peers_public_bits:
* @session: is a gnutls session
*
* Get the Diffie-Hellman public key bit size. Can be used for both
@@ -450,7 +450,7 @@ gnutls_dh_get_peers_public_bits (gnutls_session_t session)
/* CERTIFICATE STUFF */
/**
- * gnutls_certificate_get_ours - return the raw certificate sent in the last
handshake
+ * gnutls_certificate_get_ours:
* @session: is a gnutls session
*
* Get the certificate as sent to the peer, in the last handshake.
@@ -483,7 +483,7 @@ gnutls_certificate_get_ours (gnutls_session_t session)
}
/**
- * gnutls_certificate_get_peers - return the peer's raw certificate
+ * gnutls_certificate_get_peers:
* @session: is a gnutls session
* @list_size: is the length of the certificate list
*
@@ -518,7 +518,7 @@ gnutls_certificate_get_peers (gnutls_session_t
/**
- * gnutls_certificate_client_get_request_status - return the certificate
request status
+ * gnutls_certificate_client_get_request_status:
* @session: is a gnutls session
*
* Get whether client certificate is requested or not.
@@ -534,7 +534,7 @@ gnutls_certificate_client_get_request_status
(gnutls_session_t session)
}
/**
- * gnutls_fingerprint - calculate the fingerprint of the given data
+ * gnutls_fingerprint:
* @algo: is a digest algorithm
* @data: is the data
* @result: is the place where the result will be copied (may be null).
@@ -587,7 +587,7 @@ gnutls_fingerprint (gnutls_digest_algorithm_t algo,
/**
- * gnutls_certificate_set_dh_params - set the DH parameters for a server to use
+ * gnutls_certificate_set_dh_params:
* @res: is a gnutls_certificate_credentials_t structure
* @dh_params: is a structure that holds Diffie-Hellman parameters.
*
@@ -607,7 +607,7 @@ gnutls_certificate_set_dh_params
(gnutls_certificate_credentials_t res,
}
/**
- * gnutls_certificate_set_params_function - set the DH or RSA parameters
callback
+ * gnutls_certificate_set_params_function:
* @res: is a gnutls_certificate_credentials_t structure
* @func: is the function to be called
*
@@ -624,7 +624,7 @@ gnutls_certificate_set_params_function
(gnutls_certificate_credentials_t res,
/**
- * gnutls_certificate_set_verify_flags - set the flags to be used at
certificate verification
+ * gnutls_certificate_set_verify_flags:
* @res: is a gnutls_certificate_credentials_t structure
* @flags: are the flags
*
@@ -641,7 +641,7 @@ gnutls_certificate_set_verify_flags
(gnutls_certificate_credentials_t
}
/**
- * gnutls_certificate_set_verify_limits - set the upper limits to be used at
certificate verification
+ * gnutls_certificate_set_verify_limits:
* @res: is a gnutls_certificate_credentials structure
* @max_bits: is the number of bits of an acceptable certificate (default 8200)
* @max_depth: is maximum depth of the verification of a certificate chain
(default 5)
@@ -661,7 +661,7 @@ gnutls_certificate_set_verify_limits
(gnutls_certificate_credentials_t res,
}
/**
- * gnutls_certificate_set_rsa_export_params - set the RSA parameters for a
server to use
+ * gnutls_certificate_set_rsa_export_params:
* @res: is a gnutls_certificate_credentials_t structure
* @rsa_params: is a structure that holds temporary RSA parameters.
*
@@ -677,7 +677,7 @@ gnutls_certificate_set_rsa_export_params
(gnutls_certificate_credentials_t
}
/**
- * gnutls_psk_set_params_function - set the DH or RSA parameters callback
+ * gnutls_psk_set_params_function:
* @res: is a gnutls_psk_server_credentials_t structure
* @func: is the function to be called
*
@@ -693,7 +693,7 @@ gnutls_psk_set_params_function
(gnutls_psk_server_credentials_t res,
}
/**
- * gnutls_anon_set_params_function - set the DH or RSA parameters callback
+ * gnutls_anon_set_params_function:
* @res: is a gnutls_anon_server_credentials_t structure
* @func: is the function to be called
*
diff --git a/lib/gnutls_x509.c b/lib/gnutls_x509.c
index d664a5b..44a9042 100644
--- a/lib/gnutls_x509.c
+++ b/lib/gnutls_x509.c
@@ -663,7 +663,7 @@ read_key_file (gnutls_certificate_credentials_t res,
}
/**
- * gnutls_certificate_set_x509_key_mem - Used to set keys in a
gnutls_certificate_credentials_t structure
+ * gnutls_certificate_set_x509_key_mem:
* @res: is a #gnutls_certificate_credentials_t structure.
* @cert: contains a certificate list (path) for the specified private key
* @key: is the private key, or %NULL
@@ -721,7 +721,7 @@ gnutls_certificate_set_x509_key_mem
(gnutls_certificate_credentials_t res,
}
/**
- * gnutls_certificate_set_x509_key - Used to set keys in a
gnutls_certificate_credentials_t structure
+ * gnutls_certificate_set_x509_key:
* @res: is a #gnutls_certificate_credentials_t structure.
* @cert_list: contains a certificate list (path) for the specified private key
* @cert_list_size: holds the size of the certificate list
@@ -810,7 +810,7 @@ gnutls_certificate_set_x509_key
(gnutls_certificate_credentials_t res,
}
/**
- * gnutls_certificate_set_x509_key_file - Used to set keys in a
gnutls_certificate_credentials_t structure
+ * gnutls_certificate_set_x509_key_file:
* @res: is a #gnutls_certificate_credentials_t structure.
* @certfile: is a file that containing the certificate list (path) for
* the specified private key, in PKCS7 format, or a list of certificates
@@ -1112,7 +1112,7 @@ parse_der_ca_mem (gnutls_x509_crt_t ** cert_list,
unsigned *ncerts,
}
/**
- * gnutls_certificate_set_x509_trust_mem - Used to add trusted CAs in a
gnutls_certificate_credentials_t structure
+ * gnutls_certificate_set_x509_trust_mem:
* @res: is a #gnutls_certificate_credentials_t structure.
* @ca: is a list of trusted CAs or a DER certificate
* @type: is DER or PEM
@@ -1151,7 +1151,7 @@ gnutls_certificate_set_x509_trust_mem
(gnutls_certificate_credentials_t res,
}
/**
- * gnutls_certificate_set_x509_trust - Used to add trusted CAs in a
gnutls_certificate_credentials_t structure
+ * gnutls_certificate_set_x509_trust:
* @res: is a #gnutls_certificate_credentials_t structure.
* @ca_list: is a list of trusted CAs
* @ca_list_size: holds the size of the CA list
@@ -1214,7 +1214,7 @@ gnutls_certificate_set_x509_trust
(gnutls_certificate_credentials_t res,
}
/**
- * gnutls_certificate_set_x509_trust_file - Used to add trusted CAs in a
gnutls_certificate_credentials_t structure
+ * gnutls_certificate_set_x509_trust_file:
* @res: is a #gnutls_certificate_credentials_t structure.
* @cafile: is a file containing the list of trusted CAs (DER or PEM list)
* @type: is PEM or DER
@@ -1434,7 +1434,7 @@ read_crl_mem (gnutls_certificate_credentials_t res, const
void *crl,
}
/**
- * gnutls_certificate_set_x509_crl_mem - Used to add CRLs in a
gnutls_certificate_credentials_t structure
+ * gnutls_certificate_set_x509_crl_mem:
* @res: is a #gnutls_certificate_credentials_t structure.
* @CRL: is a list of trusted CRLs. They should have been verified before.
* @type: is DER or PEM
@@ -1461,7 +1461,7 @@ gnutls_certificate_set_x509_crl_mem
(gnutls_certificate_credentials_t res,
}
/**
- * gnutls_certificate_set_x509_crl - Used to add CRLs in a
gnutls_certificate_credentials_t structure
+ * gnutls_certificate_set_x509_crl:
* @res: is a #gnutls_certificate_credentials_t structure.
* @crl_list: is a list of trusted CRLs. They should have been verified before.
* @crl_list_size: holds the size of the crl_list
@@ -1516,7 +1516,7 @@ gnutls_certificate_set_x509_crl
(gnutls_certificate_credentials_t res,
}
/**
- * gnutls_certificate_set_x509_crl_file - Used to add CRLs in a
gnutls_certificate_credentials_t structure
+ * gnutls_certificate_set_x509_crl_file:
* @res: is a #gnutls_certificate_credentials_t structure.
* @crlfile: is a file containing the list of verified CRLs (DER or PEM list)
* @type: is PEM or DER
@@ -2044,7 +2044,7 @@ done:
/**
- * gnutls_certificate_free_crls - Used to free all the CRLs from a
gnutls_certificate_credentials_t structure
+ * gnutls_certificate_free_crls:
* @sc: is a #gnutls_certificate_credentials_t structure.
*
* This function will delete all the CRLs associated
diff --git a/lib/includes/gnutls/crypto.h b/lib/includes/gnutls/crypto.h
index 0c136de..84b1af0 100644
--- a/lib/includes/gnutls/crypto.h
+++ b/lib/includes/gnutls/crypto.h
@@ -27,12 +27,15 @@
typedef struct cipher_hd_st* gnutls_cipher_hd_t;
-int gnutls_cipher_init (gnutls_cipher_hd_t*, gnutls_cipher_algorithm_t cipher,
- const gnutls_datum_t * key,
- const gnutls_datum_t * iv);
-int gnutls_cipher_encrypt (const gnutls_cipher_hd_t handle, void *text, int
textlen);
-int gnutls_cipher_decrypt (const gnutls_cipher_hd_t handle, void *ciphertext,
- int ciphertextlen);
+int gnutls_cipher_init (gnutls_cipher_hd_t *handle,
+ gnutls_cipher_algorithm_t cipher,
+ const gnutls_datum_t * key,
+ const gnutls_datum_t * iv);
+int gnutls_cipher_encrypt (const gnutls_cipher_hd_t handle,
+ void *text, int textlen);
+int gnutls_cipher_decrypt (const gnutls_cipher_hd_t handle,
+ void *ciphertext,
+ int ciphertextlen);
void gnutls_cipher_deinit (gnutls_cipher_hd_t handle);
int gnutls_cipher_get_block_size (gnutls_cipher_algorithm_t algorithm);
diff --git a/lib/opencdk/stream.c b/lib/opencdk/stream.c
index 68c6b3a..4dfa8f1 100644
--- a/lib/opencdk/stream.c
+++ b/lib/opencdk/stream.c
@@ -437,14 +437,15 @@ cdk_stream_tmp_set_mode (cdk_stream_t s, int val)
/**
- * cdk_stream_close: Close a stream and flush all buffers.
+ * cdk_stream_close:
* @s: The STREAM object.
*
- * This function work different for read or write streams. When the
- * stream is for reading, the filtering is already done and we can
- * simply close the file and all buffers.
- * But for the case it's a write stream, we need to apply all registered
- * filters now. The file is closed in the filter function and not here.
+ * Close a stream and flush all buffers. This function work different
+ * for read or write streams. When the stream is for reading, the
+ * filtering is already done and we can simply close the file and all
+ * buffers. But for the case it's a write stream, we need to apply
+ * all registered filters now. The file is closed in the filter
+ * function and not here.
**/
cdk_error_t
cdk_stream_close (cdk_stream_t s)
@@ -517,10 +518,11 @@ cdk_stream_close (cdk_stream_t s)
/**
- * cdk_stream_eof: Return if the associated file handle was set to EOF.
+ * cdk_stream_eof:
* @s: The STREAM object.
*
- * This function will only work with read streams.
+ * Return if the associated file handle was set to EOF. This
+ * function will only work with read streams.
**/
int
cdk_stream_eof (cdk_stream_t s)
@@ -557,11 +559,12 @@ _cdk_stream_get_errno (cdk_stream_t s)
/**
- * cdk_stream_get_length: Return the length of the associated file handle.
+ * cdk_stream_get_length:
* @s: The STREAM object.
*
- * This function should work for both read and write streams. For write
- * streams an additional flush is used to write possible pending data.
+ * Return the length of the associated file handle. This function
+ * should work for both read and write streams. For write streams an
+ * additional flush is used to write possible pending data.
**/
off_t
cdk_stream_get_length (cdk_stream_t s)
diff --git a/lib/openpgp/compat.c b/lib/openpgp/compat.c
index 0f4a602..3c5d881 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 60261c9..82a29c5 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 1c6818e..511c4d7 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 996d9f3..00543fb 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 6e2a122..1f3a677 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 0bad94b..8677de4 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 6b8cdca..d27a9d1 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
*
diff --git a/lib/x509/common.c b/lib/x509/common.c
index d49f0db..f85e0ee 100644
--- a/lib/x509/common.c
+++ b/lib/x509/common.c
@@ -106,7 +106,7 @@ _gnutls_x509_oid_data_printable (const char *oid)
}
/**
- * gnutls_x509_dn_oid_known - return true if the given OID is known
+ * gnutls_x509_dn_oid_known:
* @oid: holds an Object Identifier in a null terminated string
*
* This function will inform about known DN OIDs. This is useful since
diff --git a/lib/x509/crl.c b/lib/x509/crl.c
index 42621ab..92e0ef0 100644
--- a/lib/x509/crl.c
+++ b/lib/x509/crl.c
@@ -36,7 +36,7 @@
#include <x509_int.h>
/**
- * gnutls_x509_crl_init - initializes a #gnutls_x509_crl_t structure
+ * gnutls_x509_crl_init:
* @crl: The structure to be initialized
*
* This function will initialize a CRL structure. CRL stands for
@@ -70,7 +70,7 @@ gnutls_x509_crl_init (gnutls_x509_crl_t * crl)
}
/**
- * gnutls_x509_crl_deinit - deinitializes a #gnutls_x509_crl_t structure
+ * gnutls_x509_crl_deinit:
* @crl: The structure to be initialized
*
* This function will deinitialize a CRL structure.
@@ -88,7 +88,7 @@ gnutls_x509_crl_deinit (gnutls_x509_crl_t crl)
}
/**
- * gnutls_x509_crl_import - import a DER or PEM encoded CRL
+ * gnutls_x509_crl_import:
* @crl: The structure to store the parsed CRL.
* @data: The DER or PEM encoded CRL.
* @format: One of DER or PEM
@@ -162,7 +162,7 @@ cleanup:
/**
- * gnutls_x509_crl_get_issuer_dn - returns the CRL's issuer distinguished name
+ * gnutls_x509_crl_get_issuer_dn:
* @crl: should contain a gnutls_x509_crl_t structure
* @buf: a pointer to a structure to hold the peer's name (may be null)
* @sizeof_buf: initially holds the size of @buf
@@ -195,7 +195,7 @@ gnutls_x509_crl_get_issuer_dn (const gnutls_x509_crl_t crl,
char *buf,
}
/**
- * gnutls_x509_crl_get_issuer_dn_by_oid - return the CRL's issuer
distinguished name
+ * gnutls_x509_crl_get_issuer_dn_by_oid:
* @crl: should contain a gnutls_x509_crl_t structure
* @oid: holds an Object Identified in null terminated string
* @indx: In case multiple same OIDs exist in the RDN, this specifies which to
send. Use zero to get the first one.
@@ -238,7 +238,7 @@ gnutls_x509_crl_get_issuer_dn_by_oid (gnutls_x509_crl_t crl,
}
/**
- * gnutls_x509_crl_get_dn_oid - returns the Certificate request issuer's
distinguished name OIDs
+ * gnutls_x509_crl_get_dn_oid:
* @crl: should contain a gnutls_x509_crl_t structure
* @indx: Specifies which DN OID to send. Use zero to get the first one.
* @oid: a pointer to a structure to hold the name (may be null)
@@ -270,7 +270,7 @@ gnutls_x509_crl_get_dn_oid (gnutls_x509_crl_t crl,
/**
- * gnutls_x509_crl_get_signature_algorithm - returns the CRL's signature
algorithm
+ * gnutls_x509_crl_get_signature_algorithm:
* @crl: should contain a #gnutls_x509_crl_t structure
*
* This function will return a value of the #gnutls_sign_algorithm_t
@@ -313,7 +313,7 @@ gnutls_x509_crl_get_signature_algorithm (gnutls_x509_crl_t
crl)
}
/**
- * gnutls_x509_crl_get_signature - Returns the CRL's signature
+ * gnutls_x509_crl_get_signature:
* @crl: should contain a gnutls_x509_crl_t structure
* @sig: a pointer where the signature part will be copied (may be null).
* @sizeof_sig: initially holds the size of @sig
@@ -370,7 +370,7 @@ gnutls_x509_crl_get_signature (gnutls_x509_crl_t crl,
}
/**
- * gnutls_x509_crl_get_version - returns the CRL's version number
+ * gnutls_x509_crl_get_version:
* @crl: should contain a #gnutls_x509_crl_t structure
*
* This function will return the version of the specified CRL.
@@ -402,7 +402,7 @@ gnutls_x509_crl_get_version (gnutls_x509_crl_t crl)
}
/**
- * gnutls_x509_crl_get_this_update - return the CRL's thisUpdate time
+ * gnutls_x509_crl_get_this_update:
* @crl: should contain a #gnutls_x509_crl_t structure
*
* This function will return the time this CRL was issued.
@@ -422,7 +422,7 @@ gnutls_x509_crl_get_this_update (gnutls_x509_crl_t crl)
}
/**
- * gnutls_x509_crl_get_next_update - return the CRL's nextUpdate time
+ * gnutls_x509_crl_get_next_update:
* @crl: should contain a #gnutls_x509_crl_t structure
*
* This function will return the time the next CRL will be issued.
@@ -444,7 +444,7 @@ gnutls_x509_crl_get_next_update (gnutls_x509_crl_t crl)
}
/**
- * gnutls_x509_crl_get_crt_count - get number of revoked certificates in a CRL
+ * gnutls_x509_crl_get_crt_count:
* @crl: should contain a #gnutls_x509_crl_t structure
*
* This function will return the number of revoked certificates in the
@@ -478,7 +478,7 @@ gnutls_x509_crl_get_crt_count (gnutls_x509_crl_t crl)
}
/**
- * gnutls_x509_crl_get_crt_serial - get the serial number of a revoked
certificate
+ * gnutls_x509_crl_get_crt_serial:
* @crl: should contain a #gnutls_x509_crl_t structure
* @indx: the index of the certificate to extract (starting from 0)
* @serial: where the serial number will be copied
@@ -611,7 +611,7 @@ cleanup:
}
/**
- * gnutls_x509_crl_export - export the CRL
+ * gnutls_x509_crl_export:
* @crl: Holds the revocation list
* @format: the format of output params. One of PEM or DER.
* @output_data: will contain a private key PEM or DER encoded
@@ -701,7 +701,7 @@ _gnutls_x509_crl_cpy (gnutls_x509_crl_t dest,
gnutls_x509_crl_t src)
}
/**
- * gnutls_x509_crl_get_authority_key_id - get the CRL authority's identifier
+ * gnutls_x509_crl_get_authority_key_id:
* @crl: should contain a #gnutls_x509_crl_t structure
* @ret: The place where the identifier will be copied
* @ret_size: Holds the size of the result field.
@@ -792,7 +792,7 @@ gnutls_x509_crl_get_authority_key_id (gnutls_x509_crl_t
crl, void *ret,
}
/**
- * gnutls_x509_crl_get_number - get the CRL number (extension)
+ * gnutls_x509_crl_get_number:
* @crl: should contain a #gnutls_x509_crl_t structure
* @ret: The place where the number will be copied
* @ret_size: Holds the size of the result field.
@@ -853,7 +853,7 @@ gnutls_x509_crl_get_number (gnutls_x509_crl_t crl, void
*ret,
}
/**
- * gnutls_x509_crl_get_extension_oid - get the specified extension OID
+ * gnutls_x509_crl_get_extension_oid:
* @crl: should contain a #gnutls_x509_crl_t structure
* @indx: Specifies which extension OID to send, use zero to get the first one.
* @oid: a pointer to a structure to hold the OID (may be null)
@@ -893,7 +893,7 @@ gnutls_x509_crl_get_extension_oid (gnutls_x509_crl_t crl,
int indx,
}
/**
- * gnutls_x509_crl_get_extension_info - Get extension id and criticality
+ * gnutls_x509_crl_get_extension_info:
* @crl: should contain a #gnutls_x509_crl_t structure
* @indx: Specifies which extension OID to send, use zero to get the first one.
* @oid: a pointer to a structure to hold the OID
@@ -971,7 +971,7 @@ gnutls_x509_crl_get_extension_info (gnutls_x509_crl_t crl,
int indx,
}
/**
- * gnutls_x509_crl_get_extension_data - Get the specified extension data
+ * gnutls_x509_crl_get_extension_data:
* @crl: should contain a #gnutls_x509_crl_t structure
* @indx: Specifies which extension OID to send. Use zero to get the first one.
* @data: a pointer to a structure to hold the data (may be null)
diff --git a/lib/x509/crl_write.c b/lib/x509/crl_write.c
index df23054..cfc806d 100644
--- a/lib/x509/crl_write.c
+++ b/lib/x509/crl_write.c
@@ -42,7 +42,7 @@
static void disable_optional_stuff (gnutls_x509_crl_t crl);
/**
- * gnutls_x509_crl_set_version - This function will set the CRL version
+ * gnutls_x509_crl_set_version:
* @crl: should contain a gnutls_x509_crl_t structure
* @version: holds the version number. For CRLv1 crls must be 1.
*
@@ -79,7 +79,7 @@ gnutls_x509_crl_set_version (gnutls_x509_crl_t crl, unsigned
int version)
}
/**
- * gnutls_x509_crl_sign2 - This function will sign a CRL with a key
+ * gnutls_x509_crl_sign2:
* @crl: should contain a gnutls_x509_crl_t structure
* @issuer: is the certificate of the certificate issuer
* @issuer_key: holds the issuer's private key
@@ -124,7 +124,7 @@ gnutls_x509_crl_sign2 (gnutls_x509_crl_t crl,
gnutls_x509_crt_t issuer,
}
/**
- * gnutls_x509_crl_sign - This function will sign a CRL with a key
+ * gnutls_x509_crl_sign:
* @crl: should contain a gnutls_x509_crl_t structure
* @issuer: is the certificate of the certificate issuer
* @issuer_key: holds the issuer's private key
@@ -143,7 +143,7 @@ gnutls_x509_crl_sign (gnutls_x509_crl_t crl,
gnutls_x509_crt_t issuer,
}
/**
- * gnutls_x509_crl_set_this_update - This function will set the CRL's issuing
time
+ * gnutls_x509_crl_set_this_update:
* @crl: should contain a gnutls_x509_crl_t structure
* @act_time: The actual time
*
@@ -165,7 +165,7 @@ gnutls_x509_crl_set_this_update (gnutls_x509_crl_t crl,
time_t act_time)
}
/**
- * gnutls_x509_crl_set_next_update - This function will set the CRL next
update time
+ * gnutls_x509_crl_set_next_update:
* @crl: should contain a gnutls_x509_crl_t structure
* @exp_time: The actual time
*
@@ -186,7 +186,7 @@ gnutls_x509_crl_set_next_update (gnutls_x509_crl_t crl,
time_t exp_time)
}
/**
- * gnutls_x509_crl_set_crt_serial - This function will set a revoked
certificate's serial number
+ * gnutls_x509_crl_set_crt_serial:
* @crl: should contain a gnutls_x509_crl_t structure
* @serial: The revoked certificate's serial number
* @serial_size: Holds the size of the serial field.
@@ -252,7 +252,7 @@ gnutls_x509_crl_set_crt_serial (gnutls_x509_crl_t crl,
}
/**
- * gnutls_x509_crl_set_crt - This function will set a revoked certificate's
serial number
+ * gnutls_x509_crl_set_crt:
* @crl: should contain a gnutls_x509_crl_t structure
* @crt: a certificate of type #gnutls_x509_crt_t with the revoked certificate
* @revocation_time: The time this certificate was revoked
@@ -313,7 +313,7 @@ disable_optional_stuff (gnutls_x509_crl_t crl)
}
/**
- * gnutls_x509_crl_set_authority_key_id - Set the CRL's authority key id
+ * gnutls_x509_crl_set_authority_key_id:
* @crl: a CRL of type #gnutls_x509_crl_t
* @id: The key ID
* @id_size: Holds the size of the serial field.
@@ -378,7 +378,7 @@ gnutls_x509_crl_set_authority_key_id (gnutls_x509_crl_t crl,
}
/**
- * gnutls_x509_crl_set_number - Set the CRL's number extension
+ * gnutls_x509_crl_set_number:
* @crl: a CRL of type #gnutls_x509_crl_t
* @nr: The CRL number
* @nr_size: Holds the size of the nr field.
diff --git a/lib/x509/crq.c b/lib/x509/crq.c
index a57988c..ca21c48 100644
--- a/lib/x509/crq.c
+++ b/lib/x509/crq.c
@@ -41,7 +41,7 @@
#include <libtasn1.h>
/**
- * gnutls_x509_crq_init - initializes a #gnutls_x509_crq_t structure
+ * gnutls_x509_crq_init:
* @crq: The structure to be initialized
*
* This function will initialize a PKCS#10 certificate request
@@ -73,7 +73,7 @@ gnutls_x509_crq_init (gnutls_x509_crq_t * crq)
}
/**
- * gnutls_x509_crq_deinit - deinitializes a #gnutls_x509_crq_t structure
+ * gnutls_x509_crq_deinit:
* @crq: The structure to be initialized
*
* This function will deinitialize a PKCS#10 certificate request
@@ -95,7 +95,7 @@ gnutls_x509_crq_deinit (gnutls_x509_crq_t crq)
#define PEM_CRQ2 "CERTIFICATE REQUEST"
/**
- * gnutls_x509_crq_import - import a DER or PEM encoded Certificate request
+ * gnutls_x509_crq_import:
* @crq: The structure to store the parsed certificate request.
* @data: The DER or PEM encoded certificate.
* @format: One of DER or PEM
@@ -173,7 +173,7 @@ cleanup:
/**
- * gnutls_x509_crq_get_dn - get certificate request subject's distinguished
name
+ * gnutls_x509_crq_get_dn:
* @crq: should contain a #gnutls_x509_crq_t structure
* @buf: a pointer to a structure to hold the name (may be %NULL)
* @sizeof_buf: initially holds the size of @buf
@@ -203,7 +203,7 @@ gnutls_x509_crq_get_dn (gnutls_x509_crq_t crq, char *buf,
size_t * sizeof_buf)
}
/**
- * gnutls_x509_crq_get_dn_by_oid - get certificate request subject's
distinguished name
+ * gnutls_x509_crq_get_dn_by_oid:
* @crq: should contain a gnutls_x509_crq_t structure
* @oid: holds an Object Identified in null terminated string
* @indx: In case multiple same OIDs exist in the RDN, this specifies
@@ -245,7 +245,7 @@ gnutls_x509_crq_get_dn_by_oid (gnutls_x509_crq_t crq, const
char *oid,
}
/**
- * gnutls_x509_crq_get_dn_oid - This function returns the Certificate request
subject's distinguished name OIDs
+ * gnutls_x509_crq_get_dn_oid:
* @crq: should contain a gnutls_x509_crq_t structure
* @indx: Specifies which DN OID to send. Use zero to get the first one.
* @oid: a pointer to a structure to hold the name (may be %NULL)
@@ -409,7 +409,7 @@ cleanup:
}
/**
- * gnutls_x509_crq_get_challenge_password - get challenge password
+ * gnutls_x509_crq_get_challenge_password:
* @crq: should contain a #gnutls_x509_crq_t structure
* @pass: will hold a zero-terminated password string
* @sizeof_pass: Initially holds the size of @pass.
@@ -593,7 +593,7 @@ set_attribute (ASN1_TYPE asn, const char *root,
}
/**
- * gnutls_x509_crq_set_attribute_by_oid - set attribute in the request
+ * gnutls_x509_crq_set_attribute_by_oid:
* @crq: should contain a #gnutls_x509_crq_t structure
* @oid: holds an Object Identified in zero-terminated string
* @buf: a pointer to a structure that holds the attribute data
@@ -627,7 +627,7 @@ gnutls_x509_crq_set_attribute_by_oid (gnutls_x509_crq_t crq,
}
/**
- * gnutls_x509_crq_get_attribute_by_oid - get an attribute in the request
+ * gnutls_x509_crq_get_attribute_by_oid:
* @crq: should contain a #gnutls_x509_crq_t structure
* @oid: holds an Object Identified in zero-terminated string
* @indx: In case multiple same OIDs exist in the attribute list, this
@@ -658,7 +658,7 @@ gnutls_x509_crq_get_attribute_by_oid (gnutls_x509_crq_t crq,
}
/**
- * gnutls_x509_crq_set_dn_by_oid - set the certificate request subject's
distinguished name
+ * gnutls_x509_crq_set_dn_by_oid:
* @crq: should contain a #gnutls_x509_crq_t structure
* @oid: holds an Object Identifier in a zero-terminated string
* @raw_flag: must be 0, or 1 if the data are DER encoded
@@ -694,7 +694,7 @@ gnutls_x509_crq_set_dn_by_oid (gnutls_x509_crq_t crq, const
char *oid,
}
/**
- * gnutls_x509_crq_set_version - set the Certificate request version
+ * gnutls_x509_crq_set_version:
* @crq: should contain a #gnutls_x509_crq_t structure
* @version: holds the version number, for v1 Requests must be 1
*
@@ -731,7 +731,7 @@ gnutls_x509_crq_set_version (gnutls_x509_crq_t crq,
unsigned int version)
}
/**
- * gnutls_x509_crq_get_version - get certificate request's version number
+ * gnutls_x509_crq_get_version:
* @crq: should contain a #gnutls_x509_crq_t structure
*
* This function will return the version of the specified Certificate
@@ -768,7 +768,7 @@ gnutls_x509_crq_get_version (gnutls_x509_crq_t crq)
}
/**
- * gnutls_x509_crq_set_key - associate the certificate request with a key
+ * gnutls_x509_crq_set_key:
* @crq: should contain a #gnutls_x509_crq_t structure
* @key: holds a private key
*
@@ -804,7 +804,7 @@ gnutls_x509_crq_set_key (gnutls_x509_crq_t crq,
gnutls_x509_privkey_t key)
}
/**
- * gnutls_x509_crq_get_key_rsa_raw - export the RSA public key
+ * gnutls_x509_crq_get_key_rsa_raw:
* @crq: Holds the certificate
* @m: will hold the modulus
* @e: will hold the public exponent
@@ -873,7 +873,7 @@ cleanup:
}
/**
- * gnutls_x509_crq_set_key_rsa_raw - associate Certificate request with a key
+ * gnutls_x509_crq_set_key_rsa_raw:
* @crq: should contain a #gnutls_x509_crq_t structure
* @m: holds the modulus
* @e: holds the public exponent
@@ -940,7 +940,7 @@ error:
}
/**
- * gnutls_x509_crq_set_challenge_password - set a challenge password
+ * gnutls_x509_crq_set_challenge_password:
* @crq: should contain a #gnutls_x509_crq_t structure
* @pass: holds a zero-terminated password
*
@@ -985,7 +985,7 @@ gnutls_x509_crq_set_challenge_password (gnutls_x509_crq_t
crq,
}
/**
- * gnutls_x509_crq_sign2 - Sign a Certificate request with a key
+ * gnutls_x509_crq_sign2:
* @crq: should contain a #gnutls_x509_crq_t structure
* @key: holds a private key
* @dig: The message digest to use, i.e., %GNUTLS_DIG_SHA1
@@ -1070,7 +1070,7 @@ gnutls_x509_crq_sign2 (gnutls_x509_crq_t crq,
gnutls_x509_privkey_t key,
}
/**
- * gnutls_x509_crq_sign - sign a Certificate request with a key
+ * gnutls_x509_crq_sign:
* @crq: should contain a #gnutls_x509_crq_t structure
* @key: holds a private key
*
@@ -1087,7 +1087,7 @@ gnutls_x509_crq_sign (gnutls_x509_crq_t crq,
gnutls_x509_privkey_t key)
}
/**
- * gnutls_x509_crq_export - Export the generated certificate request
+ * gnutls_x509_crq_export:
* @crq: should contain a #gnutls_x509_crq_t structure
* @format: the format of output params. One of PEM or DER.
* @output_data: will contain a certificate request PEM or DER encoded
@@ -1123,7 +1123,7 @@ gnutls_x509_crq_export (gnutls_x509_crq_t crq,
}
/**
- * gnutls_x509_crq_get_pk_algorithm - get certificate request public key
algorithm
+ * gnutls_x509_crq_get_pk_algorithm:
* @crq: should contain a #gnutls_x509_crq_t structure
* @bits: if bits is non-%NULL it will hold the size of the parameters' in bits
*
@@ -1159,7 +1159,7 @@ gnutls_x509_crq_get_pk_algorithm (gnutls_x509_crq_t crq,
unsigned int *bits)
}
/**
- * gnutls_x509_crq_get_attribute_info - Get attribute id
+ * gnutls_x509_crq_get_attribute_info:
* @crq: should contain a #gnutls_x509_crq_t structure
* @indx: Specifies which attribute OID to send. Use zero to get the first one.
* @oid: a pointer to a structure to hold the OID
@@ -1216,7 +1216,7 @@ gnutls_x509_crq_get_attribute_info (gnutls_x509_crq_t
crq, int indx,
}
/**
- * gnutls_x509_crq_get_attribute_data - Get the specified attribute data
+ * gnutls_x509_crq_get_attribute_data:
* @crq: should contain a #gnutls_x509_crq_t structure
* @indx: Specifies which attribute OID to send. Use zero to get the first one.
* @data: a pointer to a structure to hold the data (may be null)
@@ -1270,7 +1270,7 @@ gnutls_x509_crq_get_attribute_data (gnutls_x509_crq_t
crq, int indx,
}
/**
- * gnutls_x509_crq_get_extension_info - Get extension id and criticality
+ * gnutls_x509_crq_get_extension_info:
* @crq: should contain a #gnutls_x509_crq_t structure
* @indx: Specifies which extension OID to send. Use zero to get the first one.
* @oid: a pointer to a structure to hold the OID
@@ -1402,7 +1402,7 @@ out:
}
/**
- * gnutls_x509_crq_get_extension_data - Get the specified extension data
+ * gnutls_x509_crq_get_extension_data:
* @crq: should contain a #gnutls_x509_crq_t structure
* @indx: Specifies which extension OID to send. Use zero to get the first one.
* @data: a pointer to a structure to hold the data (may be null)
@@ -1504,7 +1504,7 @@ gnutls_x509_crq_get_extension_data (gnutls_x509_crq_t
crq, int indx,
}
/**
- * gnutls_x509_crq_get_key_usage - return the certificate's key usage
+ * gnutls_x509_crq_get_key_usage:
* @crq: should contain a #gnutls_x509_crq_t structure
* @key_usage: where the key usage bits will be stored
* @critical: will be non zero if the extension is marked as critical
@@ -1562,7 +1562,7 @@ gnutls_x509_crq_get_key_usage (gnutls_x509_crq_t crq,
}
/**
- * gnutls_x509_crq_get_basic_constraints - get certificate's basic constraints
+ * gnutls_x509_crq_get_basic_constraints:
* @crq: should contain a #gnutls_x509_crq_t structure
* @critical: will be non zero if the extension is marked as critical
* @ca: pointer to output integer indicating CA status, may be NULL,
@@ -1705,7 +1705,7 @@ get_subject_alt_name (gnutls_x509_crq_t crq,
}
/**
- * gnutls_x509_crq_get_subject_alt_name - Get certificate's alternative name
+ * gnutls_x509_crq_get_subject_alt_name:
* @crq: should contain a #gnutls_x509_crq_t structure
* @seq: specifies the sequence number of the alt name, 0 for the
* first one, 1 for the second etc.
@@ -1744,7 +1744,7 @@ gnutls_x509_crq_get_subject_alt_name (gnutls_x509_crq_t
crq,
}
/**
- * gnutls_x509_crq_get_subject_alt_othername_oid - Get SAN otherName OID
+ * gnutls_x509_crq_get_subject_alt_othername_oid:
* @crq: should contain a #gnutls_x509_crq_t structure
* @seq: specifies the sequence number of the alt name (0 for the first one, 1
for the second etc.)
* @ret: is the place where the otherName OID will be copied to
@@ -1780,7 +1780,7 @@ gnutls_x509_crq_get_subject_alt_othername_oid
(gnutls_x509_crq_t crq,
}
/**
- * gnutls_x509_crq_get_extension_by_oid - get the specified extension
+ * gnutls_x509_crq_get_extension_by_oid:
* @crq: should contain a #gnutls_x509_crq_t structure
* @oid: holds an Object Identified in null terminated string
* @indx: In case multiple same OIDs exist in the extensions, this
@@ -1839,7 +1839,7 @@ gnutls_x509_crq_get_extension_by_oid (gnutls_x509_crq_t
crq,
}
/**
- * gnutls_x509_crq_set_subject_alt_name - Set the subject Alternative Name
+ * gnutls_x509_crq_set_subject_alt_name:
* @crq: a certificate request of type #gnutls_x509_crq_t
* @nt: is one of the #gnutls_x509_subject_alt_name_t enumerations
* @data: The data to be set
@@ -1954,7 +1954,7 @@ finish:
}
/**
- * gnutls_x509_crq_set_basic_constraints - Set the basicConstraints extension
+ * gnutls_x509_crq_set_basic_constraints:
* @crq: a certificate request of type #gnutls_x509_crq_t
* @ca: true(1) or false(0) depending on the Certificate authority status.
* @pathLenConstraint: non-negative values indicate maximum length of path,
@@ -2005,7 +2005,7 @@ gnutls_x509_crq_set_basic_constraints (gnutls_x509_crq_t
crq,
}
/**
- * gnutls_x509_crq_set_key_usage - Set the keyUsage extension
+ * gnutls_x509_crq_set_key_usage:
* @crq: a certificate request of type #gnutls_x509_crq_t
* @usage: an ORed sequence of the GNUTLS_KEY_* elements.
*
@@ -2051,7 +2051,7 @@ gnutls_x509_crq_set_key_usage (gnutls_x509_crq_t crq,
unsigned int usage)
}
/**
- * gnutls_x509_crq_get_key_purpose_oid - get Certificate's key purpose OIDs
+ * gnutls_x509_crq_get_key_purpose_oid:
* @crq: should contain a #gnutls_x509_crq_t structure
* @indx: This specifies which OID to return, use zero to get the first one
* @oid: a pointer to a buffer to hold the OID (may be %NULL)
@@ -2159,7 +2159,7 @@ gnutls_x509_crq_get_key_purpose_oid (gnutls_x509_crq_t
crq,
}
/**
- * gnutls_x509_crq_set_key_purpose_oid - Sets the Certificate's key purpose
OIDs
+ * gnutls_x509_crq_set_key_purpose_oid:
* @crq: a certificate of type #gnutls_x509_crq_t
* @oid: a pointer to a zero-terminated string that holds the OID
* @critical: Whether this extension will be critical or not
@@ -2352,7 +2352,7 @@ cleanup:
}
/**
- * gnutls_x509_crq_get_key_id - Return unique ID of public key's parameters
+ * gnutls_x509_crq_get_key_id:
* @crq: a certificate of type #gnutls_x509_crq_t
* @flags: should be 0 for now
* @output_data: will contain the key ID
diff --git a/lib/x509/dn.c b/lib/x509/dn.c
index 29d7696..a601264 100644
--- a/lib/x509/dn.c
+++ b/lib/x509/dn.c
@@ -945,7 +945,7 @@ _gnutls_x509_set_dn_oid (ASN1_TYPE asn1_struct,
}
/**
- * gnutls_x509_dn_init: initialize an opaque DN object
+ * gnutls_x509_dn_init:
* @dn: the object to be initialized
*
* This function initializes a #gnutls_x509_dn_t structure.
@@ -978,7 +978,7 @@ gnutls_x509_dn_init (gnutls_x509_dn_t * dn)
}
/**
- * gnutls_x509_dn_import: get opaque DN object from DER RDN sequence
+ * gnutls_x509_dn_import:
* @dn: the structure that will hold the imported DN
* @data: should contain a DER encoded RDN sequence
*
@@ -1012,7 +1012,7 @@ gnutls_x509_dn_import (gnutls_x509_dn_t dn, const
gnutls_datum_t * data)
}
/**
- * gnutls_x509_dn_deinit: deallocate a DN object
+ * gnutls_x509_dn_deinit:
* @dn: a DN opaque object pointer.
*
* This function deallocates the DN object as returned by
@@ -1027,7 +1027,7 @@ gnutls_x509_dn_deinit (gnutls_x509_dn_t dn)
}
/**
- * gnutls_x509_rdn_get - parse an RDN sequence and returns a string
+ * gnutls_x509_rdn_get:
* @idn: should contain a DER encoded RDN sequence
* @buf: a pointer to a structure to hold the peer's name
* @sizeof_buf: holds the size of @buf
@@ -1083,7 +1083,7 @@ gnutls_x509_rdn_get (const gnutls_datum_t * idn,
}
/**
- * gnutls_x509_rdn_get_by_oid - parse an RDN sequence and returns a string
+ * gnutls_x509_rdn_get_by_oid:
* @idn: should contain a DER encoded RDN sequence
* @oid: an Object Identifier
* @indx: In case multiple same OIDs exist in the RDN indicates which
@@ -1141,7 +1141,7 @@ gnutls_x509_rdn_get_by_oid (const gnutls_datum_t * idn,
const char *oid,
}
/**
- * gnutls_x509_rdn_get_oid - parse an RDN sequence and returns an OID.
+ * gnutls_x509_rdn_get_oid:
* @idn: should contain a DER encoded RDN sequence
* @indx: Indicates which OID to return. Use 0 for the first one.
* @buf: a pointer to a structure to hold the peer's name OID
@@ -1220,7 +1220,7 @@ _gnutls_x509_compare_raw_dn (const gnutls_datum_t * dn1,
}
/**
- * gnutls_x509_dn_export - This function will export the DN
+ * gnutls_x509_dn_export:
* @dn: Holds the opaque DN object
* @format: the format of output params. One of PEM or DER.
* @output_data: will contain a DN PEM or DER encoded
diff --git a/lib/x509/output.c b/lib/x509/output.c
index 1263d17..c262305 100644
--- a/lib/x509/output.c
+++ b/lib/x509/output.c
@@ -1437,7 +1437,7 @@ print_oneline (gnutls_string * str, gnutls_x509_crt_t
cert)
}
/**
- * gnutls_x509_crt_print - Pretty print X.509 certificates
+ * gnutls_x509_crt_print:
* @cert: The structure to be printed
* @format: Indicate the format to use
* @out: Newly allocated datum with zero terminated string.
@@ -1798,7 +1798,7 @@ print_crl (gnutls_string * str, gnutls_x509_crl_t crl,
int notsigned)
}
/**
- * gnutls_x509_crl_print - Pretty print X.509 certificate revocation list
+ * gnutls_x509_crl_print:
* @crl: The structure to be printed
* @format: Indicate the format to use
* @out: Newly allocated datum with zero terminated string.
@@ -2110,7 +2110,7 @@ print_crq_other (gnutls_string * str, gnutls_x509_crq_t
crq)
}
/**
- * gnutls_x509_crq_print - Pretty print PKCS 10 certificate request
+ * gnutls_x509_crq_print:
* @crq: The structure to be printed
* @format: Indicate the format to use
* @out: Newly allocated datum with zero terminated string.
diff --git a/lib/x509/pkcs12.c b/lib/x509/pkcs12.c
index 1689274..8bdb1c0 100644
--- a/lib/x509/pkcs12.c
+++ b/lib/x509/pkcs12.c
@@ -126,7 +126,7 @@ cleanup:
}
/**
- * gnutls_pkcs12_init - This function initializes a gnutls_pkcs12_t structure
+ * gnutls_pkcs12_init:
* @pkcs12: The structure to be initialized
*
* This function will initialize a PKCS12 structure. PKCS12 structures
@@ -158,7 +158,7 @@ gnutls_pkcs12_init (gnutls_pkcs12_t * pkcs12)
}
/**
- * gnutls_pkcs12_deinit - This function deinitializes memory used by a
gnutls_pkcs12_t structure
+ * gnutls_pkcs12_deinit:
* @pkcs12: The structure to be initialized
*
* This function will deinitialize a PKCS12 structure.
@@ -176,7 +176,7 @@ gnutls_pkcs12_deinit (gnutls_pkcs12_t pkcs12)
}
/**
- * gnutls_pkcs12_import - This function will import a DER or PEM encoded
PKCS12 structure
+ * gnutls_pkcs12_import:
* @pkcs12: The structure to store the parsed PKCS12.
* @data: The DER or PEM encoded PKCS12.
* @format: One of DER or PEM
@@ -254,7 +254,7 @@ cleanup:
/**
- * gnutls_pkcs12_export - This function will export the pkcs12 structure
+ * gnutls_pkcs12_export:
* @pkcs12: Holds the pkcs12 structure
* @format: the format of output params. One of PEM or DER.
* @output_data: will contain a structure PEM or DER encoded
@@ -572,7 +572,7 @@ cleanup:
/**
- * gnutls_pkcs12_get_bag - This function returns a Bag from a PKCS12 structure
+ * gnutls_pkcs12_get_bag:
* @pkcs12: should contain a gnutls_pkcs12_t structure
* @indx: contains the index of the bag to extract
* @bag: An initialized bag, where the contents of the bag will be copied
@@ -721,7 +721,7 @@ cleanup:
}
/**
- * gnutls_pkcs12_set_bag - This function inserts a Bag into a PKCS12 structure
+ * gnutls_pkcs12_set_bag:
* @pkcs12: should contain a gnutls_pkcs12_t structure
* @bag: An initialized bag
*
@@ -853,7 +853,7 @@ cleanup:
}
/**
- * gnutls_pkcs12_generate_mac - This function generates the MAC of the PKCS12
structure
+ * gnutls_pkcs12_generate_mac:
* @pkcs12: should contain a gnutls_pkcs12_t structure
* @pass: The password for the MAC
*
@@ -986,7 +986,7 @@ cleanup:
}
/**
- * gnutls_pkcs12_verify_mac - This function verifies the MAC of the PKCS12
structure
+ * gnutls_pkcs12_verify_mac:
* @pkcs12: should contain a gnutls_pkcs12_t structure
* @pass: The password for the MAC
*
diff --git a/lib/x509/pkcs12_bag.c b/lib/x509/pkcs12_bag.c
index 799538c..8d4af70 100644
--- a/lib/x509/pkcs12_bag.c
+++ b/lib/x509/pkcs12_bag.c
@@ -37,7 +37,7 @@
#include "x509_int.h"
/**
- * gnutls_pkcs12_bag_init - This function initializes a gnutls_pkcs12_bag_t
structure
+ * gnutls_pkcs12_bag_init:
* @bag: The structure to be initialized
*
* This function will initialize a PKCS12 bag structure. PKCS12 Bags
@@ -77,7 +77,7 @@ _pkcs12_bag_free_data (gnutls_pkcs12_bag_t bag)
/**
- * gnutls_pkcs12_bag_deinit - This function deinitializes memory used by a
gnutls_pkcs12_t structure
+ * gnutls_pkcs12_bag_deinit:
* @bag: The structure to be initialized
*
* This function will deinitialize a PKCS12 Bag structure.
@@ -94,7 +94,7 @@ gnutls_pkcs12_bag_deinit (gnutls_pkcs12_bag_t bag)
}
/**
- * gnutls_pkcs12_bag_get_type - This function returns the bag's type
+ * gnutls_pkcs12_bag_get_type:
* @bag: The bag
* @indx: The element of the bag to get the type
*
@@ -117,7 +117,7 @@ gnutls_pkcs12_bag_get_type (gnutls_pkcs12_bag_t bag, int
indx)
}
/**
- * gnutls_pkcs12_bag_get_count - This function returns the bag's elements count
+ * gnutls_pkcs12_bag_get_count:
* @bag: The bag
*
* This function will return the number of the elements withing the bag.
@@ -138,7 +138,7 @@ gnutls_pkcs12_bag_get_count (gnutls_pkcs12_bag_t bag)
}
/**
- * gnutls_pkcs12_bag_get_data - This function returns the bag's data
+ * gnutls_pkcs12_bag_get_data:
* @bag: The bag
* @indx: The element of the bag to get the data from
* @data: where the bag's data will be. Should be treated as constant.
@@ -392,7 +392,7 @@ cleanup:
/**
- * gnutls_pkcs12_bag_set_data - This function inserts data into the bag
+ * gnutls_pkcs12_bag_set_data:
* @bag: The bag
* @type: The data's type
* @data: the data to be copied.
@@ -455,7 +455,7 @@ gnutls_pkcs12_bag_set_data (gnutls_pkcs12_bag_t bag,
}
/**
- * gnutls_pkcs12_bag_set_crt - This function inserts a certificate into the bag
+ * gnutls_pkcs12_bag_set_crt:
* @bag: The bag
* @crt: the certificate to be copied.
*
@@ -492,7 +492,7 @@ gnutls_pkcs12_bag_set_crt (gnutls_pkcs12_bag_t bag,
gnutls_x509_crt_t crt)
}
/**
- * gnutls_pkcs12_bag_set_crl - insert the CRL into the bag
+ * gnutls_pkcs12_bag_set_crl:
* @bag: The bag
* @crl: the CRL to be copied.
*
@@ -530,7 +530,7 @@ gnutls_pkcs12_bag_set_crl (gnutls_pkcs12_bag_t bag,
gnutls_x509_crl_t crl)
}
/**
- * gnutls_pkcs12_bag_set_key_id - This function sets a key ID into the bag
element
+ * gnutls_pkcs12_bag_set_key_id:
* @bag: The bag
* @indx: The bag's element to add the id
* @id: the ID
@@ -575,7 +575,7 @@ gnutls_pkcs12_bag_set_key_id (gnutls_pkcs12_bag_t bag, int
indx,
}
/**
- * gnutls_pkcs12_bag_get_key_id - This function gets the key ID from the bag
element
+ * gnutls_pkcs12_bag_get_key_id:
* @bag: The bag
* @indx: The bag's element to add the id
* @id: where the ID will be copied (to be treated as const)
@@ -610,7 +610,7 @@ gnutls_pkcs12_bag_get_key_id (gnutls_pkcs12_bag_t bag, int
indx,
}
/**
- * gnutls_pkcs12_bag_get_friendly_name - This function returns the friendly
name of the bag element
+ * gnutls_pkcs12_bag_get_friendly_name:
* @bag: The bag
* @indx: The bag's element to add the id
* @name: will hold a pointer to the name (to be treated as const)
@@ -645,7 +645,7 @@ gnutls_pkcs12_bag_get_friendly_name (gnutls_pkcs12_bag_t
bag, int indx,
/**
- * gnutls_pkcs12_bag_set_friendly_name - This function sets a friendly name
into the bag element
+ * gnutls_pkcs12_bag_set_friendly_name:
* @bag: The bag
* @indx: The bag's element to add the id
* @name: the name
@@ -687,7 +687,7 @@ gnutls_pkcs12_bag_set_friendly_name (gnutls_pkcs12_bag_t
bag, int indx,
/**
- * gnutls_pkcs12_bag_decrypt - This function will decrypt an encrypted bag
+ * gnutls_pkcs12_bag_decrypt:
* @bag: The bag
* @pass: The password used for encryption, must be ASCII.
*
@@ -743,7 +743,7 @@ gnutls_pkcs12_bag_decrypt (gnutls_pkcs12_bag_t bag, const
char *pass)
}
/**
- * gnutls_pkcs12_bag_encrypt - This function will encrypt a bag
+ * gnutls_pkcs12_bag_encrypt:
* @bag: The bag
* @pass: The password used for encryption, must be ASCII
* @flags: should be one of #gnutls_pkcs_encrypt_flags_t elements bitwise or'd
diff --git a/lib/x509/pkcs7.c b/lib/x509/pkcs7.c
index fdcf625..f1bedc6 100644
--- a/lib/x509/pkcs7.c
+++ b/lib/x509/pkcs7.c
@@ -139,7 +139,7 @@ cleanup:
}
/**
- * gnutls_pkcs7_init - initialize a #gnutls_pkcs7_t structure
+ * gnutls_pkcs7_init:
* @pkcs7: The structure to be initialized
*
* This function will initialize a PKCS7 structure. PKCS7 structures
@@ -171,7 +171,7 @@ gnutls_pkcs7_init (gnutls_pkcs7_t * pkcs7)
}
/**
- * gnutls_pkcs7_deinit - deinitializes a #gnutls_pkcs7_t structure
+ * gnutls_pkcs7_deinit:
* @pkcs7: The structure to be initialized
*
* This function will deinitialize a PKCS7 structure.
@@ -189,7 +189,7 @@ gnutls_pkcs7_deinit (gnutls_pkcs7_t pkcs7)
}
/**
- * gnutls_pkcs7_import - import a DER or PEM encoded PKCS7
+ * gnutls_pkcs7_import:
* @pkcs7: The structure to store the parsed PKCS7.
* @data: The DER or PEM encoded PKCS7.
* @format: One of DER or PEM
@@ -260,7 +260,7 @@ cleanup:
}
/**
- * gnutls_pkcs7_get_crt_raw - get a certificate from a PKCS7 certificate set
+ * gnutls_pkcs7_get_crt_raw:
* @pkcs7: should contain a gnutls_pkcs7_t structure
* @indx: contains the index of the certificate to extract
* @certificate: the contents of the certificate will be copied
@@ -369,7 +369,7 @@ cleanup:
}
/**
- * gnutls_pkcs7_get_crt_count - return the number of certificates in a PKCS7
certificate set
+ * gnutls_pkcs7_get_crt_count:
* @pkcs7: should contain a #gnutls_pkcs7_t structure
*
* This function will return the number of certifcates in the PKCS7
@@ -413,7 +413,7 @@ gnutls_pkcs7_get_crt_count (gnutls_pkcs7_t pkcs7)
}
/**
- * gnutls_pkcs7_export - export the pkcs7 structure
+ * gnutls_pkcs7_export:
* @pkcs7: Holds the pkcs7 structure
* @format: the format of output params. One of PEM or DER.
* @output_data: will contain a structure PEM or DER encoded
@@ -524,7 +524,7 @@ cleanup:
}
/**
- * gnutls_pkcs7_set_crt_raw - add a certificate in a PKCS7 certificate set
+ * gnutls_pkcs7_set_crt_raw:
* @pkcs7: should contain a #gnutls_pkcs7_t structure
* @crt: the DER encoded certificate to be added
*
@@ -618,7 +618,7 @@ cleanup:
}
/**
- * gnutls_pkcs7_set_crt - add a parsed certificate in a PKCS7 certificate set
+ * gnutls_pkcs7_set_crt:
* @pkcs7: should contain a #gnutls_pkcs7_t structure
* @crt: the certificate to be copied.
*
@@ -660,7 +660,7 @@ gnutls_pkcs7_set_crt (gnutls_pkcs7_t pkcs7,
gnutls_x509_crt_t crt)
/**
- * gnutls_pkcs7_delete_crt - deletes a certificate from a PKCS7 certificate set
+ * gnutls_pkcs7_delete_crt:
* @pkcs7: should contain a gnutls_pkcs7_t structure
* @indx: the index of the certificate to delete
*
@@ -726,7 +726,7 @@ cleanup:
*/
/**
- * gnutls_pkcs7_get_crl_raw - returns a crl in a PKCS7 crl set
+ * gnutls_pkcs7_get_crl_raw:
* @pkcs7: should contain a #gnutls_pkcs7_t structure
* @indx: contains the index of the crl to extract
* @crl: the contents of the crl will be copied there (may be null)
@@ -803,7 +803,7 @@ cleanup:
}
/**
- * gnutls_pkcs7_get_crl_count - returns the number of CRLs in a PKCS7 crl set
+ * gnutls_pkcs7_get_crl_count:
* @pkcs7: should contain a gnutls_pkcs7_t structure
*
* This function will return the number of certifcates in the PKCS7
@@ -847,7 +847,7 @@ gnutls_pkcs7_get_crl_count (gnutls_pkcs7_t pkcs7)
}
/**
- * gnutls_pkcs7_set_crl_raw - add a crl in a PKCS7 crl set
+ * gnutls_pkcs7_set_crl_raw:
* @pkcs7: should contain a #gnutls_pkcs7_t structure
* @crl: the DER encoded crl to be added
*
@@ -930,7 +930,7 @@ cleanup:
}
/**
- * gnutls_pkcs7_set_crl - add a parsed crl in a PKCS7 crl set
+ * gnutls_pkcs7_set_crl:
* @pkcs7: should contain a #gnutls_pkcs7_t structure
* @crl: the DER encoded crl to be added
*
@@ -970,7 +970,7 @@ gnutls_pkcs7_set_crl (gnutls_pkcs7_t pkcs7,
gnutls_x509_crl_t crl)
}
/**
- * gnutls_pkcs7_delete_crl - deletes a CRL from a PKCS7 crl set
+ * gnutls_pkcs7_delete_crl:
* @pkcs7: should contain a #gnutls_pkcs7_t structure
* @indx: the index of the crl to delete
*
diff --git a/lib/x509/privkey.c b/lib/x509/privkey.c
index edd82f1..4e235a8 100644
--- a/lib/x509/privkey.c
+++ b/lib/x509/privkey.c
@@ -38,7 +38,7 @@
static int _gnutls_asn1_encode_rsa (ASN1_TYPE * c2, bigint_t * params);
/**
- * gnutls_x509_privkey_init - initialize a #gnutls_privkey_t structure
+ * gnutls_x509_privkey_init:
* @key: The structure to be initialized
*
* This function will initialize an private key structure.
@@ -62,7 +62,7 @@ gnutls_x509_privkey_init (gnutls_x509_privkey_t * key)
}
/**
- * gnutls_x509_privkey_deinit - deinitializes a #gnutls_x509_privkey_t
structure
+ * gnutls_x509_privkey_deinit:
* @key: The structure to be initialized
*
* This function will deinitialize a private key structure.
@@ -85,7 +85,7 @@ gnutls_x509_privkey_deinit (gnutls_x509_privkey_t key)
}
/**
- * gnutls_x509_privkey_cpy - copy a private key
+ * gnutls_x509_privkey_cpy:
* @dst: The destination key, which should be initialized.
* @src: The source key
*
@@ -314,7 +314,7 @@ error:
#define PEM_KEY_RSA "RSA PRIVATE KEY"
/**
- * gnutls_x509_privkey_import - import a DER or PEM encoded key
+ * gnutls_x509_privkey_import:
* @key: The structure to store the parsed key
* @data: The DER or PEM encoded certificate.
* @format: One of DER or PEM
@@ -439,7 +439,7 @@ cleanup:
_gnutls_mpi_release(&key->params[i])
/**
- * gnutls_x509_privkey_import_rsa_raw - import a raw RSA key
+ * gnutls_x509_privkey_import_rsa_raw:
* @key: The structure to store the parsed key
* @m: holds the modulus
* @e: holds the public exponent
@@ -540,7 +540,7 @@ gnutls_x509_privkey_import_rsa_raw (gnutls_x509_privkey_t
key,
}
/**
- * gnutls_x509_privkey_import_dsa_raw - import a raw DSA key
+ * gnutls_x509_privkey_import_dsa_raw:
* @key: The structure to store the parsed key
* @p: holds the p
* @q: holds the q
@@ -632,7 +632,7 @@ gnutls_x509_privkey_import_dsa_raw (gnutls_x509_privkey_t
key,
/**
- * gnutls_x509_privkey_get_pk_algorithm - returns the key's PublicKey algorithm
+ * gnutls_x509_privkey_get_pk_algorithm:
* @key: should contain a #gnutls_x509_privkey_t structure
*
* This function will return the public key algorithm of a private
@@ -654,7 +654,7 @@ gnutls_x509_privkey_get_pk_algorithm (gnutls_x509_privkey_t
key)
}
/**
- * gnutls_x509_privkey_export - export the private key
+ * gnutls_x509_privkey_export:
* @key: Holds the key
* @format: the format of output params. One of PEM or DER.
* @output_data: will contain a private key PEM or DER encoded
@@ -728,7 +728,7 @@ gnutls_x509_privkey_export (gnutls_x509_privkey_t key,
}
/**
- * gnutls_x509_privkey_export_rsa_raw - export the RSA private key
+ * gnutls_x509_privkey_export_rsa_raw:
* @key: a structure that holds the rsa parameters
* @m: will hold the modulus
* @e: will hold the public exponent
@@ -839,7 +839,7 @@ error:
}
/**
- * gnutls_x509_privkey_export_dsa_raw - export the DSA private key
+ * gnutls_x509_privkey_export_dsa_raw:
* @key: a structure that holds the DSA parameters
* @p: will hold the p
* @q: will hold the q
@@ -1288,7 +1288,7 @@ cleanup:
/**
- * gnutls_x509_privkey_generate - generate a private key
+ * gnutls_x509_privkey_generate:
* @key: should contain a #gnutls_x509_privkey_t structure
* @algo: is one of RSA or DSA.
* @bits: the size of the modulus
@@ -1377,7 +1377,7 @@ cleanup:
}
/**
- * gnutls_x509_privkey_get_key_id - Return unique ID of the key's parameters
+ * gnutls_x509_privkey_get_key_id:
* @key: Holds the key
* @flags: should be 0 for now
* @output_data: will contain the key ID
@@ -1466,7 +1466,7 @@ cleanup:
#ifdef ENABLE_PKI
/**
- * gnutls_x509_privkey_sign_data - sign data using the private key
+ * gnutls_x509_privkey_sign_data:
* @key: Holds the key
* @digest: should be MD5 or SHA1
* @flags: should be 0 for now
@@ -1526,7 +1526,7 @@ gnutls_x509_privkey_sign_data (gnutls_x509_privkey_t key,
}
/**
- * gnutls_x509_privkey_sign_hash - sign hash using the private key
+ * gnutls_x509_privkey_sign_hash:
* @key: Holds the key
* @hash: holds the data to be signed
* @signature: will contain newly allocated signature
@@ -1564,7 +1564,7 @@ gnutls_x509_privkey_sign_hash (gnutls_x509_privkey_t key,
}
/**
- * gnutls_x509_privkey_verify_data - Verify the signed data using private key
+ * gnutls_x509_privkey_verify_data:
* @key: Holds the key
* @flags: should be 0 for now
* @data: holds the data to be signed
@@ -1601,7 +1601,7 @@ gnutls_x509_privkey_verify_data (gnutls_x509_privkey_t
key,
}
/**
- * gnutls_x509_privkey_fix - recalculate some parameters of the key.
+ * gnutls_x509_privkey_fix:
* @key: Holds the key
*
* This function will recalculate the secondary parameters in a key.
diff --git a/lib/x509/privkey_pkcs8.c b/lib/x509/privkey_pkcs8.c
index 463bc9e..9f2721f 100644
--- a/lib/x509/privkey_pkcs8.c
+++ b/lib/x509/privkey_pkcs8.c
@@ -580,7 +580,7 @@ error:
/**
- * gnutls_x509_privkey_export_pkcs8 - This function will export the private
key to PKCS8 format
+ * gnutls_x509_privkey_export_pkcs8:
* @key: Holds the key
* @format: the format of output params. One of PEM or DER.
* @password: the password that will be used to encrypt the key.
@@ -1136,7 +1136,7 @@ error:
}
/**
- * gnutls_x509_privkey_import_pkcs8 - This function will import a DER or PEM
PKCS8 encoded key
+ * gnutls_x509_privkey_import_pkcs8:
* @key: The structure to store the parsed key
* @data: The DER or PEM encoded key.
* @format: One of DER or PEM
diff --git a/lib/x509/rfc2818_hostname.c b/lib/x509/rfc2818_hostname.c
index 2be1540..17c5b27 100644
--- a/lib/x509/rfc2818_hostname.c
+++ b/lib/x509/rfc2818_hostname.c
@@ -29,7 +29,7 @@
#include <gnutls_errors.h>
/**
- * gnutls_x509_crt_check_hostname - compares the hostname with certificate's
hostname
+ * gnutls_x509_crt_check_hostname:
* @cert: should contain an gnutls_x509_crt_t structure
* @hostname: A null terminated string that contains a DNS name
*
diff --git a/lib/x509/verify.c b/lib/x509/verify.c
index 5c58ffd..b1fb97c 100644
--- a/lib/x509/verify.c
+++ b/lib/x509/verify.c
@@ -381,7 +381,7 @@ cleanup:
}
/**
- * gnutls_x509_crt_check_issuer - check if certificate has given issuer
+ * gnutls_x509_crt_check_issuer:
* @cert: is the certificate to be checked
* @issuer: is the certificate of a possible issuer
*
@@ -925,7 +925,7 @@ _gnutls_x509_privkey_verify_signature (const gnutls_datum_t
* tbs,
}
/**
- * gnutls_x509_crt_list_verify - This function verifies the given certificate
list
+ * gnutls_x509_crt_list_verify:
* @cert_list: is the certificate list to be verified
* @cert_list_length: holds the number of certificate in cert_list
* @CA_list: is the CA list which will be used in verification
@@ -979,7 +979,7 @@ gnutls_x509_crt_list_verify (const gnutls_x509_crt_t *
cert_list,
}
/**
- * gnutls_x509_crt_verify - This function verifies the given certificate
against a given trusted one
+ * gnutls_x509_crt_verify:
* @cert: is the certificate to be verified
* @CA_list: is one certificate that is considered to be trusted one
* @CA_list_length: holds the number of CA certificate in CA_list
@@ -1019,7 +1019,7 @@ gnutls_x509_crt_verify (gnutls_x509_crt_t cert,
#ifdef ENABLE_PKI
/**
- * gnutls_x509_crl_check_issuer - checks if CRL has given issuer
+ * gnutls_x509_crl_check_issuer:
* @crl: is the CRL to be checked
* @issuer: is the certificate of a possible issuer
*
@@ -1038,7 +1038,7 @@ gnutls_x509_crl_check_issuer (gnutls_x509_crl_t cert,
}
/**
- * gnutls_x509_crl_verify - This function verifies the given crl against a
given trusted one
+ * gnutls_x509_crl_verify:
* @crl: is the crl to be verified
* @CA_list: is a certificate list that is considered to be trusted one
* @CA_list_length: holds the number of CA certificates in CA_list
diff --git a/lib/x509/x509.c b/lib/x509/x509.c
index bf6bd7d..8d27e71 100644
--- a/lib/x509/x509.c
+++ b/lib/x509/x509.c
@@ -36,7 +36,7 @@
#include <libtasn1.h>
/**
- * gnutls_x509_crt_init - This function initializes a gnutls_x509_crt_t
structure
+ * gnutls_x509_crt_init:
* @cert: The structure to be initialized
*
* This function will initialize an X.509 certificate structure.
@@ -127,7 +127,7 @@ _gnutls_x509_crt_cpy (gnutls_x509_crt_t dest,
gnutls_x509_crt_t src)
}
/**
- * gnutls_x509_crt_deinit - This function deinitializes memory used by a
gnutls_x509_crt_t structure
+ * gnutls_x509_crt_deinit:
* @cert: The structure to be initialized
*
* This function will deinitialize a CRL structure.
@@ -145,7 +145,7 @@ gnutls_x509_crt_deinit (gnutls_x509_crt_t cert)
}
/**
- * gnutls_x509_crt_import - This function will import a DER or PEM encoded
Certificate
+ * gnutls_x509_crt_import:
* @cert: The structure to store the parsed certificate.
* @data: The DER or PEM encoded certificate.
* @format: One of DER or PEM
@@ -250,7 +250,7 @@ cleanup:
/**
- * gnutls_x509_crt_get_issuer_dn - This function returns the Certificate's
issuer distinguished name
+ * gnutls_x509_crt_get_issuer_dn:
* @cert: should contain a #gnutls_x509_crt_t structure
* @buf: a pointer to a structure to hold the name (may be null)
* @sizeof_buf: initially holds the size of @buf
@@ -282,7 +282,7 @@ gnutls_x509_crt_get_issuer_dn (gnutls_x509_crt_t cert, char
*buf,
}
/**
- * gnutls_x509_crt_get_issuer_dn_by_oid - This function returns the
Certificate's issuer distinguished name
+ * gnutls_x509_crt_get_issuer_dn_by_oid:
* @cert: should contain a #gnutls_x509_crt_t structure
* @oid: holds an Object Identified in null terminated string
* @indx: In case multiple same OIDs exist in the RDN, this specifies which to
send. Use zero to get the first one.
@@ -325,7 +325,7 @@ gnutls_x509_crt_get_issuer_dn_by_oid (gnutls_x509_crt_t
cert,
}
/**
- * gnutls_x509_crt_get_issuer_dn_oid - This function returns the Certificate's
issuer distinguished name OIDs
+ * gnutls_x509_crt_get_issuer_dn_oid:
* @cert: should contain a #gnutls_x509_crt_t structure
* @indx: This specifies which OID to return. Use zero to get the first one.
* @oid: a pointer to a buffer to hold the OID (may be null)
@@ -356,7 +356,7 @@ gnutls_x509_crt_get_issuer_dn_oid (gnutls_x509_crt_t cert,
}
/**
- * gnutls_x509_crt_get_dn - This function returns the Certificate's
distinguished name
+ * gnutls_x509_crt_get_dn:
* @cert: should contain a #gnutls_x509_crt_t structure
* @buf: a pointer to a structure to hold the name (may be null)
* @sizeof_buf: initially holds the size of @buf
@@ -388,7 +388,7 @@ gnutls_x509_crt_get_dn (gnutls_x509_crt_t cert, char *buf,
}
/**
- * gnutls_x509_crt_get_dn_by_oid - This function returns the Certificate's
distinguished name
+ * gnutls_x509_crt_get_dn_by_oid:
* @cert: should contain a #gnutls_x509_crt_t structure
* @oid: holds an Object Identified in null terminated string
* @indx: In case multiple same OIDs exist in the RDN, this specifies which to
send. Use zero to get the first one.
@@ -430,7 +430,7 @@ gnutls_x509_crt_get_dn_by_oid (gnutls_x509_crt_t cert,
const char *oid,
}
/**
- * gnutls_x509_crt_get_dn_oid - This function returns the Certificate's
subject distinguished name OIDs
+ * gnutls_x509_crt_get_dn_oid:
* @cert: should contain a #gnutls_x509_crt_t structure
* @indx: This specifies which OID to return. Use zero to get the first one.
* @oid: a pointer to a buffer to hold the OID (may be null)
@@ -461,7 +461,7 @@ gnutls_x509_crt_get_dn_oid (gnutls_x509_crt_t cert,
}
/**
- * gnutls_x509_crt_get_signature_algorithm - This function returns the
Certificate's signature algorithm
+ * gnutls_x509_crt_get_signature_algorithm:
* @cert: should contain a #gnutls_x509_crt_t structure
*
* This function will return a value of the #gnutls_sign_algorithm_t
@@ -503,7 +503,7 @@ gnutls_x509_crt_get_signature_algorithm (gnutls_x509_crt_t
cert)
}
/**
- * gnutls_x509_crt_get_signature - Returns the Certificate's signature
+ * gnutls_x509_crt_get_signature:
* @cert: should contain a #gnutls_x509_crt_t structure
* @sig: a pointer where the signature part will be copied (may be null).
* @sizeof_sig: initially holds the size of @sig
@@ -559,7 +559,7 @@ gnutls_x509_crt_get_signature (gnutls_x509_crt_t cert,
}
/**
- * gnutls_x509_crt_get_version - return the Certificate's version number
+ * gnutls_x509_crt_get_version:
* @cert: should contain a #gnutls_x509_crt_t structure
*
* This function will return the version of the specified Certificate.
@@ -594,7 +594,7 @@ gnutls_x509_crt_get_version (gnutls_x509_crt_t cert)
}
/**
- * gnutls_x509_crt_get_activation_time - returns the Certificate's activation
time
+ * gnutls_x509_crt_get_activation_time:
* @cert: should contain a #gnutls_x509_crt_t structure
*
* This function will return the time this Certificate was or will be
@@ -616,7 +616,7 @@ gnutls_x509_crt_get_activation_time (gnutls_x509_crt_t cert)
}
/**
- * gnutls_x509_crt_get_expiration_time - returns the Certificate's expiration
time
+ * gnutls_x509_crt_get_expiration_time:
* @cert: should contain a #gnutls_x509_crt_t structure
*
* This function will return the time this Certificate was or will be
@@ -638,7 +638,7 @@ gnutls_x509_crt_get_expiration_time (gnutls_x509_crt_t cert)
}
/**
- * gnutls_x509_crt_get_serial - This function returns the certificate's serial
number
+ * gnutls_x509_crt_get_serial:
* @cert: should contain a #gnutls_x509_crt_t structure
* @result: The place where the serial number will be copied
* @result_size: Holds the size of the result field.
@@ -678,7 +678,7 @@ gnutls_x509_crt_get_serial (gnutls_x509_crt_t cert, void
*result,
}
/**
- * gnutls_x509_crt_get_subject_key_id - This function returns the
certificate's key identifier
+ * gnutls_x509_crt_get_subject_key_id:
* @cert: should contain a #gnutls_x509_crt_t structure
* @ret: The place where the identifier will be copied
* @ret_size: Holds the size of the result field.
@@ -765,7 +765,7 @@ gnutls_x509_crt_get_subject_key_id (gnutls_x509_crt_t cert,
void *ret,
}
/**
- * gnutls_x509_crt_get_authority_key_id - This function returns the
certificate authority's identifier
+ * gnutls_x509_crt_get_authority_key_id:
* @cert: should contain a #gnutls_x509_crt_t structure
* @ret: The place where the identifier will be copied
* @ret_size: Holds the size of the result field.
@@ -854,7 +854,7 @@ gnutls_x509_crt_get_authority_key_id (gnutls_x509_crt_t
cert, void *ret,
}
/**
- * gnutls_x509_crt_get_pk_algorithm - return the certificate's PublicKey
algorithm
+ * gnutls_x509_crt_get_pk_algorithm:
* @cert: should contain a #gnutls_x509_crt_t structure
* @bits: if bits is non null it will hold the size of the parameters' in bits
*
@@ -1178,7 +1178,7 @@ get_alt_name (gnutls_x509_crt_t cert, const char
*extension_id,
}
/**
- * gnutls_x509_crt_get_subject_alt_name - Get certificate's alternative name,
if any
+ * gnutls_x509_crt_get_subject_alt_name:
* @cert: should contain a #gnutls_x509_crt_t structure
* @seq: specifies the sequence number of the alt name (0 for the first one, 1
for the second etc.)
* @ret: is the place where the alternative name will be copied to
@@ -1221,7 +1221,7 @@ gnutls_x509_crt_get_subject_alt_name (gnutls_x509_crt_t
cert,
}
/**
- * gnutls_x509_crt_get_issuer_alt_name - Get certificate's issuer alternative
name, if any
+ * gnutls_x509_crt_get_issuer_alt_name:
* @cert: should contain a #gnutls_x509_crt_t structure
* @seq: specifies the sequence number of the alt name (0 for the first one, 1
for the second etc.)
* @ret: is the place where the alternative name will be copied to
@@ -1266,7 +1266,7 @@ gnutls_x509_crt_get_issuer_alt_name (gnutls_x509_crt_t
cert,
}
/**
- * gnutls_x509_crt_get_subject_alt_name2 - Get certificate's alternative name,
if any
+ * gnutls_x509_crt_get_subject_alt_name2:
* @cert: should contain a #gnutls_x509_crt_t structure
* @seq: specifies the sequence number of the alt name (0 for the first one, 1
for the second etc.)
* @ret: is the place where the alternative name will be copied to
@@ -1301,7 +1301,7 @@ gnutls_x509_crt_get_subject_alt_name2 (gnutls_x509_crt_t
cert,
}
/**
- * gnutls_x509_crt_get_issuer_alt_name2 - Get certificate issuer's alternative
name, if any
+ * gnutls_x509_crt_get_issuer_alt_name2:
* @cert: should contain a #gnutls_x509_crt_t structure
* @seq: specifies the sequence number of the alt name (0 for the first one, 1
for the second etc.)
* @ret: is the place where the alternative name will be copied to
@@ -1339,7 +1339,7 @@ gnutls_x509_crt_get_issuer_alt_name2 (gnutls_x509_crt_t
cert,
}
/**
- * gnutls_x509_crt_get_subject_alt_othername_oid - Get SAN otherName OID
+ * gnutls_x509_crt_get_subject_alt_othername_oid:
* @cert: should contain a #gnutls_x509_crt_t structure
* @seq: specifies the sequence number of the alt name (0 for the first one, 1
for the second etc.)
* @ret: is the place where the otherName OID will be copied to
@@ -1373,7 +1373,7 @@ gnutls_x509_crt_get_subject_alt_othername_oid
(gnutls_x509_crt_t cert,
}
/**
- * gnutls_x509_crt_get_issuer_alt_othername_oid - Get Issuer AltName otherName
OID
+ * gnutls_x509_crt_get_issuer_alt_othername_oid:
* @cert: should contain a #gnutls_x509_crt_t structure
* @seq: specifies the sequence number of the alt name (0 for the first one, 1
for the second etc.)
* @ret: is the place where the otherName OID will be copied to
@@ -1410,7 +1410,7 @@ gnutls_x509_crt_get_issuer_alt_othername_oid
(gnutls_x509_crt_t cert,
}
/**
- * gnutls_x509_crt_get_basic_constraints - This function returns the
certificate basic constraints
+ * gnutls_x509_crt_get_basic_constraints:
* @cert: should contain a #gnutls_x509_crt_t structure
* @critical: will be non zero if the extension is marked as critical
* @ca: pointer to output integer indicating CA status, may be NULL,
@@ -1476,7 +1476,7 @@ gnutls_x509_crt_get_basic_constraints (gnutls_x509_crt_t
cert,
}
/**
- * gnutls_x509_crt_get_ca_status - This function returns the certificate CA
status
+ * gnutls_x509_crt_get_ca_status:
* @cert: should contain a #gnutls_x509_crt_t structure
* @critical: will be non zero if the extension is marked as critical
*
@@ -1501,7 +1501,7 @@ gnutls_x509_crt_get_ca_status (gnutls_x509_crt_t cert,
unsigned int *critical)
}
/**
- * gnutls_x509_crt_get_key_usage - return the certificate's key usage
+ * gnutls_x509_crt_get_key_usage:
* @cert: should contain a #gnutls_x509_crt_t structure
* @key_usage: where the key usage bits will be stored
* @critical: will be non zero if the extension is marked as critical
@@ -1563,7 +1563,7 @@ gnutls_x509_crt_get_key_usage (gnutls_x509_crt_t cert,
}
/**
- * gnutls_x509_crt_get_proxy - This function returns the proxy certificate info
+ * gnutls_x509_crt_get_proxy:
* @cert: should contain a #gnutls_x509_crt_t structure
* @critical: will be non zero if the extension is marked as critical
* @pathlen: pointer to output integer indicating path length (may be
@@ -1625,7 +1625,7 @@ gnutls_x509_crt_get_proxy (gnutls_x509_crt_t cert,
}
/**
- * gnutls_x509_crt_get_extension_by_oid - This function returns the specified
extension
+ * gnutls_x509_crt_get_extension_by_oid:
* @cert: should contain a #gnutls_x509_crt_t structure
* @oid: holds an Object Identified in null terminated string
* @indx: In case multiple same OIDs exist in the extensions, this specifies
which to send. Use zero to get the first one.
@@ -1690,7 +1690,7 @@ gnutls_x509_crt_get_extension_by_oid (gnutls_x509_crt_t
cert,
}
/**
- * gnutls_x509_crt_get_extension_oid - get the specified extension OID
+ * gnutls_x509_crt_get_extension_oid:
* @cert: should contain a #gnutls_x509_crt_t structure
* @indx: Specifies which extension OID to send. Use zero to get the first one.
* @oid: a pointer to a structure to hold the OID (may be null)
@@ -1727,7 +1727,7 @@ gnutls_x509_crt_get_extension_oid (gnutls_x509_crt_t
cert, int indx,
}
/**
- * gnutls_x509_crt_get_extension_info - Get extension id and criticality
+ * gnutls_x509_crt_get_extension_info:
* @cert: should contain a #gnutls_x509_crt_t structure
* @indx: Specifies which extension OID to send. Use zero to get the first one.
* @oid: a pointer to a structure to hold the OID
@@ -1803,7 +1803,7 @@ gnutls_x509_crt_get_extension_info (gnutls_x509_crt_t
cert, int indx,
}
/**
- * gnutls_x509_crt_get_extension_data - Get the specified extension data
+ * gnutls_x509_crt_get_extension_data:
* @cert: should contain a #gnutls_x509_crt_t structure
* @indx: Specifies which extension OID to send. Use zero to get the first one.
* @data: a pointer to a structure to hold the data (may be null)
@@ -1914,7 +1914,7 @@ cleanup:
}
/**
- * gnutls_x509_crt_get_raw_issuer_dn - This function returns the issuer's DN
DER encoded
+ * gnutls_x509_crt_get_raw_issuer_dn:
* @cert: should contain a #gnutls_x509_crt_t structure
* @start: will hold the starting point of the DN
*
@@ -1933,7 +1933,7 @@ gnutls_x509_crt_get_raw_issuer_dn (gnutls_x509_crt_t cert,
}
/**
- * gnutls_x509_crt_get_raw_dn - This function returns the subject's DN DER
encoded
+ * gnutls_x509_crt_get_raw_dn:
* @cert: should contain a #gnutls_x509_crt_t structure
* @start: will hold the starting point of the DN
*
@@ -1960,7 +1960,7 @@ get_dn (gnutls_x509_crt_t cert, const char *whom,
gnutls_x509_dn_t * dn)
}
/**
- * gnutls_x509_crt_get_subject: get opaque subject DN pointer
+ * gnutls_x509_crt_get_subject:
* @cert: should contain a #gnutls_x509_crt_t structure
* @dn: output variable with pointer to opaque DN.
*
@@ -1980,7 +1980,7 @@ gnutls_x509_crt_get_subject (gnutls_x509_crt_t cert,
gnutls_x509_dn_t * dn)
}
/**
- * gnutls_x509_crt_get_issuer: get opaque issuer DN pointer
+ * gnutls_x509_crt_get_issuer:
* @cert: should contain a #gnutls_x509_crt_t structure
* @dn: output variable with pointer to opaque DN
*
@@ -2097,7 +2097,7 @@ gnutls_x509_dn_get_rdn_ava (gnutls_x509_dn_t dn,
}
/**
- * gnutls_x509_crt_get_fingerprint - This function returns the Certificate's
fingerprint
+ * gnutls_x509_crt_get_fingerprint:
* @cert: should contain a #gnutls_x509_crt_t structure
* @algo: is a digest algorithm
* @buf: a pointer to a structure to hold the fingerprint (may be null)
@@ -2156,7 +2156,7 @@ gnutls_x509_crt_get_fingerprint (gnutls_x509_crt_t cert,
}
/**
- * gnutls_x509_crt_export - This function will export the certificate
+ * gnutls_x509_crt_export:
* @cert: Holds the certificate
* @format: the format of output params. One of PEM or DER.
* @output_data: will contain a certificate PEM or DER encoded
@@ -2257,7 +2257,7 @@ cleanup:
}
/**
- * gnutls_x509_crt_get_key_id - Return unique ID of public key's parameters
+ * gnutls_x509_crt_get_key_id:
* @crt: Holds the certificate
* @flags: should be 0 for now
* @output_data: will contain the key ID
@@ -2351,7 +2351,7 @@ gnutls_x509_crt_get_key_id (gnutls_x509_crt_t crt,
unsigned int flags,
#ifdef ENABLE_PKI
/**
- * gnutls_x509_crt_check_revocation - This function checks if the given
certificate is revoked
+ * gnutls_x509_crt_check_revocation:
* @cert: should contain a #gnutls_x509_crt_t structure
* @crl_list: should contain a list of gnutls_x509_crl_t structures
* @crl_list_length: the length of the crl_list
@@ -2458,7 +2458,7 @@ gnutls_x509_crt_check_revocation (gnutls_x509_crt_t cert,
}
/**
- * gnutls_x509_crt_get_verify_algorithm - get hash algorithm used to verify
signature.
+ * gnutls_x509_crt_get_verify_algorithm:
* @crt: Holds the certificate
* @signature: contains the signature
* @hash: The result of the call with the hash algorithm used for signature
@@ -2487,7 +2487,7 @@ gnutls_x509_crt_get_verify_algorithm (gnutls_x509_crt_t
crt,
}
/**
- * gnutls_x509_crt_verify_data - verify the given signed data.
+ * gnutls_x509_crt_verify_data:
* @crt: Holds the certificate
* @flags: should be 0 for now
* @data: holds the data to be signed
@@ -2523,7 +2523,7 @@ gnutls_x509_crt_verify_data (gnutls_x509_crt_t crt,
unsigned int flags,
}
/**
- * gnutls_x509_crt_verify_hash - verify the given signed digest
+ * gnutls_x509_crt_verify_hash:
* @crt: Holds the certificate
* @flags: should be 0 for now
* @hash: holds the hash digest to be verified
@@ -2559,7 +2559,7 @@ gnutls_x509_crt_verify_hash (gnutls_x509_crt_t crt,
unsigned int flags,
}
/**
- * gnutls_x509_crt_get_crl_dist_points - This function returns the CRL
distribution points
+ * gnutls_x509_crt_get_crl_dist_points:
* @cert: should contain a #gnutls_x509_crt_t structure
* @seq: specifies the sequence number of the distribution point (0 for the
first one, 1 for the second etc.)
* @ret: is the place where the distribution point will be copied to
@@ -2694,7 +2694,7 @@ gnutls_x509_crt_get_crl_dist_points (gnutls_x509_crt_t
cert,
}
/**
- * gnutls_x509_crt_get_key_purpose_oid - This function returns the
Certificate's key purpose OIDs
+ * gnutls_x509_crt_get_key_purpose_oid:
* @cert: should contain a #gnutls_x509_crt_t structure
* @indx: This specifies which OID to return. Use zero to get the first one.
* @oid: a pointer to a buffer to hold the OID (may be null)
@@ -2792,7 +2792,7 @@ gnutls_x509_crt_get_key_purpose_oid (gnutls_x509_crt_t
cert,
}
/**
- * gnutls_x509_crt_get_pk_rsa_raw - This function will export the RSA public
key
+ * gnutls_x509_crt_get_pk_rsa_raw:
* @crt: Holds the certificate
* @m: will hold the modulus
* @e: will hold the public exponent
@@ -2858,7 +2858,7 @@ cleanup:
}
/**
- * gnutls_x509_crt_get_pk_dsa_raw - This function will export the DSA public
key
+ * gnutls_x509_crt_get_pk_dsa_raw:
* @crt: Holds the certificate
* @p: will hold the p
* @q: will hold the q
@@ -2956,7 +2956,7 @@ cleanup:
#endif
/**
- * gnutls_x509_crt_list_import - This function will import a PEM encoded
certificate list
+ * gnutls_x509_crt_list_import:
* @certs: The structures to store the parsed certificate. Must not be
initialized.
* @cert_max: Initially must hold the maximum number of certs. It will be
updated with the number of certs available.
* @data: The PEM encoded certificate.
diff --git a/lib/x509/x509_write.c b/lib/x509/x509_write.c
index c1928f6..62e0fe8 100644
--- a/lib/x509/x509_write.c
+++ b/lib/x509/x509_write.c
@@ -42,7 +42,7 @@
static void disable_optional_stuff (gnutls_x509_crt_t cert);
/**
- * gnutls_x509_crt_set_dn_by_oid - Set the Certificate request subject's
distinguished name
+ * gnutls_x509_crt_set_dn_by_oid:
* @crt: a certificate of type #gnutls_x509_crt_t
* @oid: holds an Object Identifier in a null terminated string
* @raw_flag: must be 0, or 1 if the data are DER encoded
@@ -77,7 +77,7 @@ gnutls_x509_crt_set_dn_by_oid (gnutls_x509_crt_t crt, const
char *oid,
}
/**
- * gnutls_x509_crt_set_issuer_dn_by_oid - Set the Certificate request issuer's
distinguished name
+ * gnutls_x509_crt_set_issuer_dn_by_oid:
* @crt: a certificate of type #gnutls_x509_crt_t
* @oid: holds an Object Identifier in a null terminated string
* @raw_flag: must be 0, or 1 if the data are DER encoded
@@ -118,7 +118,7 @@ gnutls_x509_crt_set_issuer_dn_by_oid (gnutls_x509_crt_t crt,
}
/**
- * gnutls_x509_crt_set_proxy_dn - Set Proxy Certificate subject's
distinguished name
+ * gnutls_x509_crt_set_proxy_dn:
* @crt: a gnutls_x509_crt_t structure with the new proxy cert
* @eecrt: the end entity certificate that will be issuing the proxy
* @raw_flag: must be 0, or 1 if the CN is DER encoded
@@ -165,7 +165,7 @@ gnutls_x509_crt_set_proxy_dn (gnutls_x509_crt_t crt,
gnutls_x509_crt_t eecrt,
}
/**
- * gnutls_x509_crt_set_version - Set the Certificate request version
+ * gnutls_x509_crt_set_version:
* @crt: a certificate of type #gnutls_x509_crt_t
* @version: holds the version number. For X.509v1 certificates must be 1.
*
@@ -207,7 +207,7 @@ gnutls_x509_crt_set_version (gnutls_x509_crt_t crt,
unsigned int version)
}
/**
- * gnutls_x509_crt_set_key - This function will associate the Certificate with
a key
+ * gnutls_x509_crt_set_key:
* @crt: a certificate of type #gnutls_x509_crt_t
* @key: holds a private key
*
@@ -246,7 +246,7 @@ gnutls_x509_crt_set_key (gnutls_x509_crt_t crt,
gnutls_x509_privkey_t key)
}
/**
- * gnutls_x509_crt_set_crq - Associate the Certificate with a request
+ * gnutls_x509_crt_set_crq:
* @crt: a certificate of type #gnutls_x509_crt_t
* @crq: holds a certificate request
*
@@ -289,7 +289,7 @@ gnutls_x509_crt_set_crq (gnutls_x509_crt_t crt,
gnutls_x509_crq_t crq)
}
/**
- * gnutls_x509_crt_set_crq_extensions - Associate the Certificate with a
request
+ * gnutls_x509_crt_set_crq_extensions:
* @crt: a certificate of type #gnutls_x509_crt_t
* @crq: holds a certificate request
*
@@ -379,7 +379,7 @@ gnutls_x509_crt_set_crq_extensions (gnutls_x509_crt_t crt,
}
/**
- * gnutls_x509_crt_set_extension_by_oid - Set an arbitrary extension
+ * gnutls_x509_crt_set_extension_by_oid:
* @crt: a certificate of type #gnutls_x509_crt_t
* @oid: holds an Object Identified in null terminated string
* @buf: a pointer to a DER encoded data
@@ -425,7 +425,7 @@ gnutls_x509_crt_set_extension_by_oid (gnutls_x509_crt_t crt,
}
/**
- * gnutls_x509_crt_set_basic_constraints - Set the basicConstraints extension
+ * gnutls_x509_crt_set_basic_constraints:
* @crt: a certificate of type #gnutls_x509_crt_t
* @ca: true(1) or false(0). Depending on the Certificate authority status.
* @pathLenConstraint: non-negative values indicate maximum length of path,
@@ -476,7 +476,7 @@ gnutls_x509_crt_set_basic_constraints (gnutls_x509_crt_t
crt,
}
/**
- * gnutls_x509_crt_set_ca_status - Set the basicConstraints extension
+ * gnutls_x509_crt_set_ca_status:
* @crt: a certificate of type #gnutls_x509_crt_t
* @ca: true(1) or false(0). Depending on the Certificate authority status.
*
@@ -494,7 +494,7 @@ gnutls_x509_crt_set_ca_status (gnutls_x509_crt_t crt,
unsigned int ca)
}
/**
- * gnutls_x509_crt_set_key_usage - Set the keyUsage extension
+ * gnutls_x509_crt_set_key_usage:
* @crt: a certificate of type #gnutls_x509_crt_t
* @usage: an ORed sequence of the GNUTLS_KEY_* elements.
*
@@ -540,7 +540,7 @@ gnutls_x509_crt_set_key_usage (gnutls_x509_crt_t crt,
unsigned int usage)
}
/**
- * gnutls_x509_crt_set_subject_alternative_name - Set the subject Alternative
Name
+ * gnutls_x509_crt_set_subject_alternative_name:
* @crt: a certificate of type #gnutls_x509_crt_t
* @type: is one of the gnutls_x509_subject_alt_name_t enumerations
* @data_string: The data to be set, a zero terminated string
@@ -580,7 +580,7 @@ gnutls_x509_crt_set_subject_alternative_name
(gnutls_x509_crt_t crt,
}
/**
- * gnutls_x509_crt_set_subject_alt_name - Set the subject Alternative Name
+ * gnutls_x509_crt_set_subject_alt_name:
* @crt: a certificate of type #gnutls_x509_crt_t
* @type: is one of the gnutls_x509_subject_alt_name_t enumerations
* @data: The data to be set
@@ -672,7 +672,7 @@ finish:
}
/**
- * gnutls_x509_crt_set_proxy - Set the proxyCertInfo extension
+ * gnutls_x509_crt_set_proxy:
* @crt: a certificate of type #gnutls_x509_crt_t
* @pathLenConstraint: non-negative values indicate maximum length of path,
* and negative values indicate that the pathLenConstraints field should
@@ -730,7 +730,7 @@ gnutls_x509_crt_set_proxy (gnutls_x509_crt_t crt,
}
/**
- * gnutls_x509_crt_sign2 - Sign a certificate with a key
+ * gnutls_x509_crt_sign2:
* @crt: a certificate of type #gnutls_x509_crt_t
* @issuer: is the certificate of the certificate issuer
* @issuer_key: holds the issuer's private key
@@ -775,7 +775,7 @@ gnutls_x509_crt_sign2 (gnutls_x509_crt_t crt,
gnutls_x509_crt_t issuer,
}
/**
- * gnutls_x509_crt_sign - Sign a certificate with a key
+ * gnutls_x509_crt_sign:
* @crt: a certificate of type #gnutls_x509_crt_t
* @issuer: is the certificate of the certificate issuer
* @issuer_key: holds the issuer's private key
@@ -794,7 +794,7 @@ gnutls_x509_crt_sign (gnutls_x509_crt_t crt,
gnutls_x509_crt_t issuer,
}
/**
- * gnutls_x509_crt_set_activation_time - Set the Certificate's activation time
+ * gnutls_x509_crt_set_activation_time:
* @cert: a certificate of type #gnutls_x509_crt_t
* @act_time: The actual time
*
@@ -819,7 +819,7 @@ gnutls_x509_crt_set_activation_time (gnutls_x509_crt_t
cert, time_t act_time)
}
/**
- * gnutls_x509_crt_set_expiration_time - Set the Certificate's expiration time
+ * gnutls_x509_crt_set_expiration_time:
* @cert: a certificate of type #gnutls_x509_crt_t
* @exp_time: The actual time
*
@@ -841,7 +841,7 @@ gnutls_x509_crt_set_expiration_time (gnutls_x509_crt_t
cert, time_t exp_time)
}
/**
- * gnutls_x509_crt_set_serial - Set the certificate's serial number
+ * gnutls_x509_crt_set_serial:
* @cert: a certificate of type #gnutls_x509_crt_t
* @serial: The serial number
* @serial_size: Holds the size of the serial field.
@@ -900,7 +900,7 @@ disable_optional_stuff (gnutls_x509_crt_t cert)
}
/**
- * gnutls_x509_crt_set_crl_dist_points - Set the CRL dist points
+ * gnutls_x509_crt_set_crl_dist_points:
* @crt: a certificate of type #gnutls_x509_crt_t
* @type: is one of the gnutls_x509_subject_alt_name_t enumerations
* @data_string: The data to be set
@@ -923,7 +923,7 @@ gnutls_x509_crt_set_crl_dist_points (gnutls_x509_crt_t crt,
}
/**
- * gnutls_x509_crt_set_crl_dist_points2 - Set the CRL dist points
+ * gnutls_x509_crt_set_crl_dist_points2:
* @crt: a certificate of type #gnutls_x509_crt_t
* @type: is one of the gnutls_x509_subject_alt_name_t enumerations
* @data: The data to be set
@@ -996,7 +996,7 @@ gnutls_x509_crt_set_crl_dist_points2 (gnutls_x509_crt_t crt,
}
/**
- * gnutls_x509_crt_cpy_crl_dist_points - Copy the CRL dist points
+ * gnutls_x509_crt_cpy_crl_dist_points:
* @dst: a certificate of type #gnutls_x509_crt_t
* @src: the certificate where the dist points will be copied from
*
@@ -1048,7 +1048,7 @@ gnutls_x509_crt_cpy_crl_dist_points (gnutls_x509_crt_t
dst,
}
/**
- * gnutls_x509_crt_set_subject_key_id - Set the certificate's subject key id
+ * gnutls_x509_crt_set_subject_key_id:
* @cert: a certificate of type #gnutls_x509_crt_t
* @id: The key ID
* @id_size: Holds the size of the serial field.
@@ -1111,7 +1111,7 @@ gnutls_x509_crt_set_subject_key_id (gnutls_x509_crt_t
cert,
}
/**
- * gnutls_x509_crt_set_authority_key_id - Set the certificate authority's key
id
+ * gnutls_x509_crt_set_authority_key_id:
* @cert: a certificate of type #gnutls_x509_crt_t
* @id: The key ID
* @id_size: Holds the size of the serial field.
@@ -1174,7 +1174,7 @@ gnutls_x509_crt_set_authority_key_id (gnutls_x509_crt_t
cert,
}
/**
- * gnutls_x509_crt_set_key_purpose_oid - Sets the Certificate's key purpose
OIDs
+ * gnutls_x509_crt_set_key_purpose_oid:
* @cert: a certificate of type #gnutls_x509_crt_t
* @oid: a pointer to a null terminated string that holds the OID
* @critical: Whether this extension will be critical or not
diff --git a/lib/x509_b64.c b/lib/x509_b64.c
index 9b2d1df..d6be088 100644
--- a/lib/x509_b64.c
+++ b/lib/x509_b64.c
@@ -288,7 +288,7 @@ _gnutls_fbase64_encode (const char *msg, const uint8_t *
data,
}
/**
- * gnutls_pem_base64_encode - convert raw data to Base64 encoded
+ * gnutls_pem_base64_encode:
* @msg: is a message to be put in the header
* @data: contain the raw data
* @result: the place where base64 data will be copied
@@ -332,7 +332,7 @@ gnutls_pem_base64_encode (const char *msg, const
gnutls_datum_t * data,
}
/**
- * gnutls_pem_base64_encode_alloc - convert raw data to Base64 encoded
+ * gnutls_pem_base64_encode_alloc:
* @msg: is a message to be put in the encoded header
* @data: contains the raw data
* @result: will hold the newly allocated encoded data
@@ -526,7 +526,7 @@ _gnutls_fbase64_decode (const char *header, const opaque *
data,
}
/**
- * gnutls_pem_base64_decode - decode base64 encoded data
+ * gnutls_pem_base64_decode:
* @header: A null terminated string with the PEM header (eg. CERTIFICATE)
* @b64_data: contain the encoded data
* @result: the place where decoded data will be copied
@@ -571,7 +571,7 @@ gnutls_pem_base64_decode (const char *header,
}
/**
- * gnutls_pem_base64_decode_alloc - decode base64 encoded data
+ * gnutls_pem_base64_decode_alloc:
* @header: The PEM header (eg. CERTIFICATE)
* @b64_data: contains the encoded data
* @result: the place where decoded data lie
diff --git a/libextra/gnutls_extra.c b/libextra/gnutls_extra.c
index 57ebb81..1cbdd64 100644
--- a/libextra/gnutls_extra.c
+++ b/libextra/gnutls_extra.c
@@ -87,7 +87,7 @@ _gnutls_add_lzo_comp (void)
static int _gnutls_init_extra = 0;
/**
- * gnutls_global_init_extra - initializes the global state of gnutls-extra
+ * gnutls_global_init_extra:
*
* This function initializes the global state of gnutls-extra library
* to defaults.
@@ -150,7 +150,7 @@ gnutls_global_init_extra (void)
}
/**
- * gnutls_extra_check_version - checks the libgnutls-extra version
+ * gnutls_extra_check_version:
* @req_version: version string to compare with, or %NULL.
*
* Check GnuTLS Extra Library version.
diff --git a/libextra/gnutls_ia.c b/libextra/gnutls_ia.c
index 2bedf77..ad2c3e8 100644
--- a/libextra/gnutls_ia.c
+++ b/libextra/gnutls_ia.c
@@ -371,7 +371,7 @@ gnutls_ia_verify_endphase (gnutls_session_t session, const
char *checksum)
}
/**
- * gnutls_ia_send: Send peer the specified TLS/IA data.
+ * gnutls_ia_send:
* @session: is a #gnutls_session_t structure.
* @data: contains the data to send
* @sizeofdata: is the length of the data
@@ -410,7 +410,7 @@ gnutls_ia_send (gnutls_session_t session, const char *data,
size_t sizeofdata)
}
/**
- * gnutls_ia_recv - read data from the TLS/IA protocol
+ * gnutls_ia_recv:
* @session: is a #gnutls_session_t structure.
* @data: the buffer that the data will be read into, must hold >= 12 bytes.
* @sizeofdata: the number of requested bytes, must be >= 12.
@@ -653,7 +653,7 @@ gnutls_ia_handshake (gnutls_session_t session)
}
/**
- * gnutls_ia_allocate_client_credentials - Used to allocate an
gnutls_ia_server_credentials_t structure
+ * gnutls_ia_allocate_client_credentials:
* @sc: is a pointer to a #gnutls_ia_server_credentials_t structure.
*
* This structure is complex enough to manipulate directly thus this
@@ -679,7 +679,7 @@ gnutls_ia_allocate_client_credentials
(gnutls_ia_client_credentials_t * sc)
}
/**
- * gnutls_ia_free_client_credentials - Used to free an allocated
#gnutls_ia_client_credentials_t structure
+ * gnutls_ia_free_client_credentials:
* @sc: is a #gnutls_ia_client_credentials_t structure.
*
* This structure is complex enough to manipulate directly thus this
@@ -693,7 +693,7 @@ gnutls_ia_free_client_credentials
(gnutls_ia_client_credentials_t sc)
}
/**
- * gnutls_ia_set_client_avp_function - Used to set a AVP callback
+ * gnutls_ia_set_client_avp_function:
* @cred: is a #gnutls_ia_client_credentials_t structure.
* @avp_func: is the callback function
*
@@ -734,7 +734,7 @@ gnutls_ia_set_client_avp_function
(gnutls_ia_client_credentials_t cred,
}
/**
- * gnutls_ia_set_client_avp_ptr - Sets a pointer to be sent to TLS/IA callback
+ * gnutls_ia_set_client_avp_ptr:
* @cred: is a #gnutls_ia_client_credentials_t structure.
* @ptr: is the pointer
*
@@ -748,7 +748,7 @@ gnutls_ia_set_client_avp_ptr
(gnutls_ia_client_credentials_t cred, void *ptr)
}
/**
- * gnutls_ia_get_client_avp_ptr - Returns the pointer which is sent to TLS/IA
callback
+ * gnutls_ia_get_client_avp_ptr:
* @cred: is a #gnutls_ia_client_credentials_t structure.
*
* Returns the pointer that will be provided to the TLS/IA callback
@@ -763,7 +763,7 @@ gnutls_ia_get_client_avp_ptr
(gnutls_ia_client_credentials_t cred)
}
/**
- * gnutls_ia_allocate_server_credentials - Used to allocate an
gnutls_ia_server_credentials_t structure
+ * gnutls_ia_allocate_server_credentials:
* @sc: is a pointer to a #gnutls_ia_server_credentials_t structure.
*
* This structure is complex enough to manipulate directly thus this
@@ -789,7 +789,7 @@ gnutls_ia_allocate_server_credentials
(gnutls_ia_server_credentials_t * sc)
}
/**
- * gnutls_ia_free_server_credentials - Used to free an allocated
#gnutls_ia_server_credentials_t structure
+ * gnutls_ia_free_server_credentials:
* @sc: is a #gnutls_ia_server_credentials_t structure.
*
* This structure is complex enough to manipulate directly thus this
@@ -803,7 +803,7 @@ gnutls_ia_free_server_credentials
(gnutls_ia_server_credentials_t sc)
}
/**
- * gnutls_ia_set_server_credentials_function - Used to set a AVP callback
+ * gnutls_ia_set_server_credentials_function:
* @cred: is a #gnutls_ia_server_credentials_t structure.
* @func: is the callback function
*
@@ -851,7 +851,7 @@ gnutls_ia_set_server_avp_function
(gnutls_ia_server_credentials_t cred,
}
/**
- * gnutls_ia_set_server_avp_ptr - Sets a pointer to be sent to TLS/IA callback
+ * gnutls_ia_set_server_avp_ptr:
* @cred: is a #gnutls_ia_client_credentials_t structure.
* @ptr: is the pointer
*
@@ -865,7 +865,7 @@ gnutls_ia_set_server_avp_ptr
(gnutls_ia_server_credentials_t cred, void *ptr)
}
/**
- * gnutls_ia_get_server_avp_ptr - Returns the pointer which is sent to TLS/IA
callback
+ * gnutls_ia_get_server_avp_ptr:
* @cred: is a #gnutls_ia_client_credentials_t structure.
*
* Returns the pointer that will be provided to the TLS/IA callback
@@ -880,7 +880,7 @@ gnutls_ia_get_server_avp_ptr
(gnutls_ia_server_credentials_t cred)
}
/**
- * gnutls_ia_enable - Indicate willingness for TLS/IA application phases
+ * gnutls_ia_enable:
* @session: is a #gnutls_session_t structure.
* @allow_skip_on_resume: non-zero if local party allows to skip the
* TLS/IA application phases for a resumed session.
diff --git a/libextra/openssl_compat.c b/libextra/openssl_compat.c
index 0c73a5c..ec4287c 100644
--- a/libextra/openssl_compat.c
+++ b/libextra/openssl_compat.c
@@ -36,7 +36,7 @@
#include <openssl_compat.h>
/*-
- * gnutls_x509_extract_dn - This function parses an RDN sequence
+ * gnutls_x509_extract_dn:
* @idn: should contain a DER encoded RDN sequence
* @rdn: a pointer to a structure to hold the name
*
@@ -105,7 +105,7 @@ gnutls_x509_extract_dn (const gnutls_datum_t * idn,
gnutls_x509_dn * rdn)
}
/*-
- * gnutls_x509_extract_certificate_dn - This function returns the
certificate's distinguished name
+ * gnutls_x509_extract_certificate_dn:
* @cert: should contain an X.509 DER encoded certificate
* @ret: a pointer to a structure to hold the peer's name
*
@@ -169,7 +169,7 @@ gnutls_x509_extract_certificate_dn (const gnutls_datum_t *
cert,
}
/*-
- * gnutls_x509_extract_certificate_issuer_dn - This function returns the
certificate's issuer distinguished name
+ * gnutls_x509_extract_certificate_issuer_dn:
* @cert: should contain an X.509 DER encoded certificate
* @ret: a pointer to a structure to hold the issuer's name
*
@@ -240,7 +240,7 @@ gnutls_x509_extract_certificate_issuer_dn (const
gnutls_datum_t * cert,
/*-
- * gnutls_x509_extract_certificate_subject_alt_name - This function returns
the certificate's alternative name, if any
+ * gnutls_x509_extract_certificate_subject_alt_name:
* @cert: should contain an X.509 DER encoded certificate
* @seq: specifies the sequence number of the alt name (0 for the first one, 1
for the second etc.)
* @ret: is the place where the alternative name will be copied to
@@ -289,7 +289,7 @@ gnutls_x509_extract_certificate_subject_alt_name (const
gnutls_datum_t *
}
/*-
- * gnutls_x509_extract_certificate_ca_status - This function returns the
certificate CA status
+ * gnutls_x509_extract_certificate_ca_status:
* @cert: should contain an X.509 DER encoded certificate
*
* This function will return certificates CA status, by reading the
@@ -326,7 +326,7 @@ gnutls_x509_extract_certificate_ca_status (const
gnutls_datum_t * cert)
}
/*-
- * gnutls_x509_extract_certificate_activation_time - This function returns the
peer's certificate activation time
+ * gnutls_x509_extract_certificate_activation_time:
* @cert: should contain an X.509 DER encoded certificate
*
* This function will return the certificate's activation time in UNIX time
@@ -358,7 +358,7 @@ gnutls_x509_extract_certificate_activation_time (const
gnutls_datum_t * cert)
}
/*-
- * gnutls_x509_extract_certificate_expiration_time - This function returns the
certificate's expiration time
+ * gnutls_x509_extract_certificate_expiration_time:
* @cert: should contain an X.509 DER encoded certificate
*
* This function will return the certificate's expiration time in UNIX time
@@ -390,7 +390,7 @@ gnutls_x509_extract_certificate_expiration_time (const
gnutls_datum_t * cert)
}
/*-
- * gnutls_x509_extract_certificate_version - This function returns the
certificate's version
+ * gnutls_x509_extract_certificate_version:
* @cert: is an X.509 DER encoded certificate
*
* This function will return the X.509 certificate's version (1, 2, 3). This
is obtained by the X509 Certificate
@@ -422,7 +422,7 @@ gnutls_x509_extract_certificate_version (const
gnutls_datum_t * cert)
}
/*-
- * gnutls_x509_extract_certificate_serial - This function returns the
certificate's serial number
+ * gnutls_x509_extract_certificate_serial:
* @cert: is an X.509 DER encoded certificate
* @result: The place where the serial number will be copied
* @result_size: Holds the size of the result field.
@@ -464,7 +464,7 @@ gnutls_x509_extract_certificate_serial (const
gnutls_datum_t * cert,
/*-
- * gnutls_x509_extract_certificate_pk_algorithm - This function returns the
certificate's PublicKey algorithm
+ * gnutls_x509_extract_certificate_pk_algorithm:
* @cert: is a DER encoded X.509 certificate
* @bits: if bits is non null it will hold the size of the parameters' in bits
*
@@ -506,7 +506,7 @@ gnutls_x509_extract_certificate_pk_algorithm (const
gnutls_datum_t *
/*-
- * gnutls_x509_extract_certificate_dn_string - This function returns the
certificate's distinguished name
+ * gnutls_x509_extract_certificate_dn_string:
* @cert: should contain an X.509 DER encoded certificate
* @buf: a pointer to a structure to hold the peer's name
* @sizeof_buf: holds the size of 'buf'
@@ -552,7 +552,7 @@ gnutls_x509_extract_certificate_dn_string (char *buf,
}
/*-
- * gnutls_x509_verify_certificate - This function verifies given certificate
list
+ * gnutls_x509_verify_certificate:
* @cert_list: is the certificate list to be verified
* @cert_list_length: holds the number of certificate in cert_list
* @CA_list: is the CA list which will be used in verification
@@ -752,7 +752,7 @@ cleanup:
}
/*-
- * gnutls_x509_extract_key_pk_algorithm - This function returns the keys's
PublicKey algorithm
+ * gnutls_x509_extract_key_pk_algorithm:
* @cert: is a DER encoded private key
*
* This function will return the public key algorithm of a DER encoded private
@@ -790,7 +790,7 @@ gnutls_x509_extract_key_pk_algorithm (const gnutls_datum_t
* key)
#ifdef ENABLE_PKI
/*-
- * gnutls_x509_pkcs7_extract_certificate - This function returns a certificate
in a PKCS7 certificate set
+ * gnutls_x509_pkcs7_extract_certificate:
* @pkcs7_struct: should contain a PKCS7 DER formatted structure
* @indx: contains the index of the certificate to extract
* @certificate: the contents of the certificate will be copied there
hooks/post-receive
--
GNU gnutls
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [SCM] GNU gnutls branch, master, updated. gnutls_2_9_9-109-gc1953c3,
Simon Josefsson <=