Add matrix_http_api_new() to the documentation

This commit is contained in:
Gergely Polonkai 2015-12-14 16:18:48 +01:00
parent 6c5f932dd8
commit 2215f7c5b3
3 changed files with 11 additions and 0 deletions

View File

@ -53,6 +53,7 @@ matrix_api_get_type
<SECTION>
<FILE>matrix-http-api</FILE>
matrix_http_api_new
matrix_http_api_get_validate_certificate
matrix_http_api_set_validate_certificate
<SUBSECTION Standard>

View File

@ -255,6 +255,15 @@ matrix_http_api_init(MatrixHTTPAPI *api)
NULL);
}
/**
* matrix_http_api_new:
* @base_url: the URL to use as the API endpoint
* @token: (allow-none): an authorization token to use. If %NULL,
* requests that need authentication will fail
*
* Create a new #MatrixHTTPAPI object with the specified base URL, and
* an optional authorization token
*/
MatrixHTTPAPI *
matrix_http_api_new(const gchar *base_url, const gchar *token)
{

View File

@ -49,6 +49,7 @@ void matrix_http_api_set_validate_certificate(MatrixHTTPAPI *api,
gboolean validate_certificate);
gboolean matrix_http_api_get_validate_certificate(MatrixHTTPAPI *api);
MatrixHTTPAPI *matrix_http_api_new(const gchar *base_url, const gchar *token);
G_END_DECLS
#endif /* __MATRIX_HTTP_API_H__ */