Merge branch '2038-tls-connection-annotations' into 'master'

gtlsconnection: Add missing (nullable) annotations

Closes #2038

See merge request GNOME/glib!1368
This commit is contained in:
Philip Withnall 2020-03-04 14:15:07 +00:00
commit 8f16a89817
2 changed files with 18 additions and 18 deletions

View File

@ -109,7 +109,7 @@ g_dtls_connection_default_init (GDtlsConnectionInterface *iface)
G_PARAM_CONSTRUCT_ONLY | G_PARAM_CONSTRUCT_ONLY |
G_PARAM_STATIC_STRINGS)); G_PARAM_STATIC_STRINGS));
/** /**
* GDtlsConnection:database: * GDtlsConnection:database: (nullable)
* *
* The certificate database to use when verifying this TLS connection. * The certificate database to use when verifying this TLS connection.
* If no certificate database is set, then the default database will be * If no certificate database is set, then the default database will be
@ -125,7 +125,7 @@ g_dtls_connection_default_init (GDtlsConnectionInterface *iface)
G_PARAM_READWRITE | G_PARAM_READWRITE |
G_PARAM_STATIC_STRINGS)); G_PARAM_STATIC_STRINGS));
/** /**
* GDtlsConnection:interaction: * GDtlsConnection:interaction: (nullable)
* *
* A #GTlsInteraction object to be used when the connection or certificate * A #GTlsInteraction object to be used when the connection or certificate
* database need to interact with the user. This will be used to prompt the * database need to interact with the user. This will be used to prompt the
@ -192,7 +192,7 @@ g_dtls_connection_default_init (GDtlsConnectionInterface *iface)
G_PARAM_READWRITE | G_PARAM_READWRITE |
G_PARAM_STATIC_STRINGS)); G_PARAM_STATIC_STRINGS));
/** /**
* GDtlsConnection:peer-certificate: * GDtlsConnection:peer-certificate: (nullable)
* *
* The connection's peer's certificate, after the TLS handshake has * The connection's peer's certificate, after the TLS handshake has
* completed and the certificate has been accepted. Note in * completed and the certificate has been accepted. Note in
@ -232,7 +232,7 @@ g_dtls_connection_default_init (GDtlsConnectionInterface *iface)
G_PARAM_READABLE | G_PARAM_READABLE |
G_PARAM_STATIC_STRINGS)); G_PARAM_STATIC_STRINGS));
/** /**
* GDtlsConnection:advertised-protocols: * GDtlsConnection:advertised-protocols: (nullable)
* *
* The list of application-layer protocols that the connection * The list of application-layer protocols that the connection
* advertises that it is willing to speak. See * advertises that it is willing to speak. See
@ -328,7 +328,7 @@ g_dtls_connection_default_init (GDtlsConnectionInterface *iface)
/** /**
* g_dtls_connection_set_database: * g_dtls_connection_set_database:
* @conn: a #GDtlsConnection * @conn: a #GDtlsConnection
* @database: a #GTlsDatabase * @database: (nullable): a #GTlsDatabase
* *
* Sets the certificate database that is used to verify peer certificates. * Sets the certificate database that is used to verify peer certificates.
* This is set to the default database by default. See * This is set to the default database by default. See
@ -360,7 +360,7 @@ g_dtls_connection_set_database (GDtlsConnection *conn,
* Gets the certificate database that @conn uses to verify * Gets the certificate database that @conn uses to verify
* peer certificates. See g_dtls_connection_set_database(). * peer certificates. See g_dtls_connection_set_database().
* *
* Returns: (transfer none): the certificate database that @conn uses or %NULL * Returns: (transfer none) (nullable): the certificate database that @conn uses or %NULL
* *
* Since: 2.48 * Since: 2.48
*/ */
@ -422,7 +422,7 @@ g_dtls_connection_set_certificate (GDtlsConnection *conn,
* Gets @conn's certificate, as set by * Gets @conn's certificate, as set by
* g_dtls_connection_set_certificate(). * g_dtls_connection_set_certificate().
* *
* Returns: (transfer none): @conn's certificate, or %NULL * Returns: (transfer none) (nullable): @conn's certificate, or %NULL
* *
* Since: 2.48 * Since: 2.48
*/ */
@ -472,7 +472,7 @@ g_dtls_connection_set_interaction (GDtlsConnection *conn,
* for things like prompting the user for passwords. If %NULL is returned, then * for things like prompting the user for passwords. If %NULL is returned, then
* no user interaction will occur for this connection. * no user interaction will occur for this connection.
* *
* Returns: (transfer none): The interaction object. * Returns: (transfer none) (nullable): The interaction object.
* *
* Since: 2.48 * Since: 2.48
*/ */
@ -498,7 +498,7 @@ g_dtls_connection_get_interaction (GDtlsConnection *conn)
* (It is not set during the emission of * (It is not set during the emission of
* #GDtlsConnection::accept-certificate.) * #GDtlsConnection::accept-certificate.)
* *
* Returns: (transfer none): @conn's peer's certificate, or %NULL * Returns: (transfer none) (nullable): @conn's peer's certificate, or %NULL
* *
* Since: 2.48 * Since: 2.48
*/ */

View File

@ -142,7 +142,7 @@ g_tls_connection_class_init (GTlsConnectionClass *klass)
G_PARAM_STATIC_STRINGS | G_PARAM_STATIC_STRINGS |
G_PARAM_DEPRECATED)); G_PARAM_DEPRECATED));
/** /**
* GTlsConnection:database: * GTlsConnection:database: (nullable)
* *
* The certificate database to use when verifying this TLS connection. * The certificate database to use when verifying this TLS connection.
* If no certificate database is set, then the default database will be * If no certificate database is set, then the default database will be
@ -158,7 +158,7 @@ g_tls_connection_class_init (GTlsConnectionClass *klass)
G_PARAM_READWRITE | G_PARAM_READWRITE |
G_PARAM_STATIC_STRINGS)); G_PARAM_STATIC_STRINGS));
/** /**
* GTlsConnection:interaction: * GTlsConnection:interaction: (nullable)
* *
* A #GTlsInteraction object to be used when the connection or certificate * A #GTlsInteraction object to be used when the connection or certificate
* database need to interact with the user. This will be used to prompt the * database need to interact with the user. This will be used to prompt the
@ -225,7 +225,7 @@ g_tls_connection_class_init (GTlsConnectionClass *klass)
G_PARAM_READWRITE | G_PARAM_READWRITE |
G_PARAM_STATIC_STRINGS)); G_PARAM_STATIC_STRINGS));
/** /**
* GTlsConnection:peer-certificate: * GTlsConnection:peer-certificate: (nullable)
* *
* The connection's peer's certificate, after the TLS handshake has * The connection's peer's certificate, after the TLS handshake has
* completed and the certificate has been accepted. Note in * completed and the certificate has been accepted. Note in
@ -265,7 +265,7 @@ g_tls_connection_class_init (GTlsConnectionClass *klass)
G_PARAM_READABLE | G_PARAM_READABLE |
G_PARAM_STATIC_STRINGS)); G_PARAM_STATIC_STRINGS));
/** /**
* GTlsConnection:advertised-protocols: * GTlsConnection:advertised-protocols: (nullable)
* *
* The list of application-layer protocols that the connection * The list of application-layer protocols that the connection
* advertises that it is willing to speak. See * advertises that it is willing to speak. See
@ -445,7 +445,7 @@ g_tls_connection_get_use_system_certdb (GTlsConnection *conn)
/** /**
* g_tls_connection_set_database: * g_tls_connection_set_database:
* @conn: a #GTlsConnection * @conn: a #GTlsConnection
* @database: a #GTlsDatabase * @database: (nullable): a #GTlsDatabase
* *
* Sets the certificate database that is used to verify peer certificates. * Sets the certificate database that is used to verify peer certificates.
* This is set to the default database by default. See * This is set to the default database by default. See
@ -477,7 +477,7 @@ g_tls_connection_set_database (GTlsConnection *conn,
* Gets the certificate database that @conn uses to verify * Gets the certificate database that @conn uses to verify
* peer certificates. See g_tls_connection_set_database(). * peer certificates. See g_tls_connection_set_database().
* *
* Returns: (transfer none): the certificate database that @conn uses or %NULL * Returns: (transfer none) (nullable): the certificate database that @conn uses or %NULL
* *
* Since: 2.30 * Since: 2.30
*/ */
@ -539,7 +539,7 @@ g_tls_connection_set_certificate (GTlsConnection *conn,
* Gets @conn's certificate, as set by * Gets @conn's certificate, as set by
* g_tls_connection_set_certificate(). * g_tls_connection_set_certificate().
* *
* Returns: (transfer none): @conn's certificate, or %NULL * Returns: (transfer none) (nullable): @conn's certificate, or %NULL
* *
* Since: 2.28 * Since: 2.28
*/ */
@ -589,7 +589,7 @@ g_tls_connection_set_interaction (GTlsConnection *conn,
* for things like prompting the user for passwords. If %NULL is returned, then * for things like prompting the user for passwords. If %NULL is returned, then
* no user interaction will occur for this connection. * no user interaction will occur for this connection.
* *
* Returns: (transfer none): The interaction object. * Returns: (transfer none) (nullable): The interaction object.
* *
* Since: 2.30 * Since: 2.30
*/ */
@ -615,7 +615,7 @@ g_tls_connection_get_interaction (GTlsConnection *conn)
* (It is not set during the emission of * (It is not set during the emission of
* #GTlsConnection::accept-certificate.) * #GTlsConnection::accept-certificate.)
* *
* Returns: (transfer none): @conn's peer's certificate, or %NULL * Returns: (transfer none) (nullable): @conn's peer's certificate, or %NULL
* *
* Since: 2.28 * Since: 2.28
*/ */