summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNikos Mavrogiannopoulos <nmav@gnutls.org>2017-04-07 22:51:09 +0200
committerNikos Mavrogiannopoulos <nmav@gnutls.org>2017-04-07 23:02:33 +0200
commit83683fde0b5305fcf229b70464b878feff88d101 (patch)
treeb511bb142833a0e056ca0ac4ee1675c87556c4af
parent204502ece42ba5fbbd24f813925c43e7436a74aa (diff)
downloadgnutls-83683fde0b5305fcf229b70464b878feff88d101.tar.gz
doc: fixed documentation for various function parameters
Signed-off-by: Nikos Mavrogiannopoulos <nmav@gnutls.org>
-rw-r--r--doc/doc.mk2
-rw-r--r--lib/anon_cred.c2
-rw-r--r--lib/openpgp/openpgp.c2
-rw-r--r--lib/supplemental.c2
-rw-r--r--lib/x509/crq.c6
-rw-r--r--lib/x509/dn.c5
-rw-r--r--libdane/dane-params.c2
7 files changed, 10 insertions, 11 deletions
diff --git a/doc/doc.mk b/doc/doc.mk
index b0694235e8..89a643c6c6 100644
--- a/doc/doc.mk
+++ b/doc/doc.mk
@@ -29,4 +29,4 @@ HEADER_FILES = $(top_srcdir)/lib/includes/gnutls/gnutls.h.in \
$(top_srcdir)/lib/includes/gnutls/pkcs7.h $(top_srcdir)/lib/includes/gnutls/socket.h
C_SOURCE_FILES = $(top_srcdir)/lib/*/*.c $(top_srcdir)/lib/*.c $(top_srcdir)/libdane/*.c
-C_X509_SOURCE_FILES = $(top_srcdir)/lib/x509/*.c $(top_srcdir)/lib/*.c
+C_X509_SOURCE_FILES = $(top_srcdir)/lib/x509/*.c $(top_srcdir)/lib/*.c $(top_srcdir)/lib/system/cert.c
diff --git a/lib/anon_cred.c b/lib/anon_cred.c
index d97b8c6650..d8f2e846ff 100644
--- a/lib/anon_cred.c
+++ b/lib/anon_cred.c
@@ -125,7 +125,7 @@ gnutls_anon_set_server_dh_params(gnutls_anon_server_credentials_t res,
/**
* gnutls_anon_set_server_known_dh_params:
* @res: is a gnutls_anon_server_credentials_t type
- * @dh_params: The Diffie-Hellman parameters.
+ * @sec_param: is an option of the %gnutls_sec_param_t enumeration
*
* This function will set the Diffie-Hellman parameters for an
* anonymous server to use. These parameters will be used in
diff --git a/lib/openpgp/openpgp.c b/lib/openpgp/openpgp.c
index b70726fb12..fbec7448b5 100644
--- a/lib/openpgp/openpgp.c
+++ b/lib/openpgp/openpgp.c
@@ -207,7 +207,7 @@ gnutls_certificate_get_openpgp_key(gnutls_certificate_credentials_t res,
* @res: is a #gnutls_certificate_credentials_t type.
* @index: The index of the certificate list to obtain.
* @crt_list: Where to store the certificate list.
- * @key: Will hold the number of certificates.
+ * @crt_list_size: Will hold the number of certificates.
*
* Obtains a X.509 certificate list that has been stored in @res with one of
* gnutls_certificate_set_openpgp_key(),
diff --git a/lib/supplemental.c b/lib/supplemental.c
index 3496c16629..3ef29f7c5a 100644
--- a/lib/supplemental.c
+++ b/lib/supplemental.c
@@ -379,7 +379,7 @@ gnutls_supplemental_recv(gnutls_session_t session, unsigned do_recv_supplemental
/**
* gnutls_supplemental_send:
* @session: is a #gnutls_session_t type.
- * @do_recv_supplemental: non-zero in order to expect supplemental data
+ * @do_send_supplemental: non-zero in order to send supplemental data
*
* This function is to be called by an extension handler to
* instruct gnutls to send supplemental data during the handshake process.
diff --git a/lib/x509/crq.c b/lib/x509/crq.c
index 98f2854b23..13978baa40 100644
--- a/lib/x509/crq.c
+++ b/lib/x509/crq.c
@@ -2975,7 +2975,7 @@ gnutls_x509_crq_set_private_key_usage_period(gnutls_x509_crq_t crq,
/**
* gnutls_x509_crq_get_tlsfeatures:
- * @crt: A X.509 certificate request
+ * @crq: An X.509 certificate request
* @features: If the function succeeds, the
* features will be stored in this variable.
* @flags: zero or %GNUTLS_EXT_FLAG_APPEND
@@ -3037,7 +3037,7 @@ int gnutls_x509_crq_get_tlsfeatures(gnutls_x509_crq_t crq,
/**
* gnutls_x509_crq_set_tlsfeatures:
- * @crt: A X.509 certificate request
+ * @crq: An X.509 certificate request
* @features: If the function succeeds, the
* features will be added to the certificate
* request.
@@ -3051,7 +3051,7 @@ int gnutls_x509_crq_get_tlsfeatures(gnutls_x509_crq_t crq,
* Since: 3.5.1
**/
int gnutls_x509_crq_set_tlsfeatures(gnutls_x509_crq_t crq,
- gnutls_x509_tlsfeatures_t features)
+ gnutls_x509_tlsfeatures_t features)
{
int ret;
gnutls_datum_t der;
diff --git a/lib/x509/dn.c b/lib/x509/dn.c
index fa35388485..04ae1825b2 100644
--- a/lib/x509/dn.c
+++ b/lib/x509/dn.c
@@ -816,9 +816,8 @@ gnutls_x509_rdn_get(const gnutls_datum_t * idn,
/**
* gnutls_x509_rdn_get2:
* @idn: should contain a DER encoded RDN sequence
- * @buf: a pointer to a structure to hold the peer's name
- * @buf_size: holds the size of @buf
- * @flags:
+ * @str: a datum that will hold the name
+ * @flags: zero of %GNUTLS_X509_DN_FLAG_COMPAT
*
* This function will return the name of the given RDN sequence. The
* name will be in the form "C=xxxx,O=yyyy,CN=zzzz" as described in
diff --git a/libdane/dane-params.c b/libdane/dane-params.c
index eff3548cb2..00b209f184 100644
--- a/libdane/dane-params.c
+++ b/libdane/dane-params.c
@@ -116,7 +116,7 @@ const char *dane_match_type_name(dane_match_type_t type)
/**
* dane_cert_usage_name:
- * @type: is a DANE match type
+ * @usage: is a DANE certificate usage
*
* Convert a #dane_cert_usage_t value to a string.
*