gergely/matrix-glib-sdk
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Documentation fix

Browse Source
This commit is contained in:
Gergely Polonkai 2015-12-15 11:10:04 +01:00
parent e15df6ea2e
commit 444161ec1b
1 changed files with 14 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
src/matrix-http-api.c
View File

@ -240,7 +240,8 @@ matrix_http_api_class_init(MatrixHTTPAPIClass *klass)
* MatrixHTTPAPI:token: * MatrixHTTPAPI:token:
* *
* The token to use for authorization. The matrix_http_api_login() * The token to use for authorization. The matrix_http_api_login()
* and matrix_http_api_register() calls set this automatically. * and matrix_http_api_register_account() calls set this
* automatically.
*/ */
obj_properties[PROP_TOKEN] = g_param_spec_string( obj_properties[PROP_TOKEN] = g_param_spec_string(
"token", "Authorization token", "token", "Authorization token",
@ -497,8 +498,8 @@ matrix_http_api_login_or_register(MatrixAPI *api,
/** /**
* matrix_http_api_login: * matrix_http_api_login:
* @api: a #MatrixAPI implementation * @api: a #MatrixAPI implementation
* @callback: (scope async): the function to call when the request is * @callback: (scope async) (allow-none): the function to call when
* finished * the request is finished
* @user_data: user data to pass to the callback function * @user_data: user data to pass to the callback function
* @login_type: the login type to use * @login_type: the login type to use
* @parameters: parameters to send with the login request * @parameters: parameters to send with the login request
@ -564,6 +565,8 @@ matrix_http_api_gen_parameters(const gchar *param1_name, ...)
* matrix_http_api_get_base_url: * matrix_http_api_get_base_url:
* @api: a #MatrixHTTPAPI implementation * @api: a #MatrixHTTPAPI implementation
* *
* Get the base URL set for @api.
*
* Returns: (transfer none): the base URL set for @api * Returns: (transfer none): the base URL set for @api
*/ */
const gchar * const gchar *
@ -577,8 +580,8 @@ matrix_http_api_get_base_url(MatrixHTTPAPI *api)
/** /**
* matrix_http_api_register_account: * matrix_http_api_register_account:
* @api: a #MatrixAPI implementation * @api: a #MatrixAPI implementation
* @callback: (scope async): the function to call when the request is * @callback: (scope async) (allow-none): the function to call when
* finished * the request is finished
* @user_data: user data to pass to the callback function * @user_data: user data to pass to the callback function
* @login_type: the login type to use * @login_type: the login type to use
* @parameters: parameters to send with the registration request * @parameters: parameters to send with the registration request
@ -603,8 +606,8 @@ matrix_http_api_register_account(MatrixAPI *api,
/** /**
* matrix_http_api_initial_sync: * matrix_http_api_initial_sync:
* @api: a #MatrixHTTPAPI object * @api: a #MatrixHTTPAPI object
* @callback: (scope async): the function to call when the request is * @callback: (scope async) (allow-none): the function to call when
* finished * the request is finished
* @user_data: user data to pass to the callback function * @user_data: user data to pass to the callback function
* @limit: maximum number of messages to return for each room * @limit: maximum number of messages to return for each room
* *
@ -642,8 +645,8 @@ matrix_http_api_initial_sync(MatrixAPI *api,
/** /**
* matrix_http_api_create_room: * matrix_http_api_create_room:
* @api: a #MatrixHTTPAPI object * @api: a #MatrixHTTPAPI object
* @callback: (scope async): the function to call when the request is * @callback: (scope async) (allow-none): the function to call when
* finished * the request is finished
* @user_data: user data to pass to the callback function * @user_data: user data to pass to the callback function
* @room_alias: an alias for the room * @room_alias: an alias for the room
* @is_public: set to %TRUE if the room should be publicly visible * @is_public: set to %TRUE if the room should be publicly visible
@ -706,8 +709,8 @@ matrix_http_api_create_room(MatrixAPI *api,
/** /**
* matrix_http_api_join_room: * matrix_http_api_join_room:
* @api: a #MatrixHTTPAPI object * @api: a #MatrixHTTPAPI object
* @callback: (scope async): the function to call when the request is * @callback: (scope async) (allow-none): the function to call when
* finished * the request is finished
* @user_data: user data to pass to the callback function * @user_data: user data to pass to the callback function
* @room_id_or_alias: an alias or the ID of the room * @room_id_or_alias: an alias or the ID of the room
* *