From bb2e8b439264b8d271d0efeef678ed20c94b1105 Mon Sep 17 00:00:00 2001 From: Simon Laux Date: Sat, 18 Jul 2020 02:54:54 +0200 Subject: [PATCH] improve documentation a bit --- deltachat-ffi/deltachat.h | 9 +++++---- src/config.rs | 8 +++++--- 2 files changed, 10 insertions(+), 7 deletions(-) diff --git a/deltachat-ffi/deltachat.h b/deltachat-ffi/deltachat.h index 883f720b4..c996eb3ce 100644 --- a/deltachat-ffi/deltachat.h +++ b/deltachat-ffi/deltachat.h @@ -318,10 +318,11 @@ char* dc_get_blobdir (const dc_context_t* context); * The library uses the `media_quality` setting to use different defaults * for recoding images sent with type DC_MSG_IMAGE. * If needed, recoding other file types is up to the UI. - * - `basic_web_rtc_instance` = address and token to webrtc signaling server (https://github.com/cracker0dks/basicwebrtc) - * that should be used for calls - * Format: https://example.com/subdir?token=TOKEN - * The other properties that are needed for a call such as the roomname will be set in the anchor part of the url. + * - `basic_web_rtc_instance` = address to webrtc signaling server (https://github.com/cracker0dks/basicwebrtc) + * that should be used for opening video hangouts. + * This property is only used in the UIs not by the core itself. + * Format: https://example.com/subdir + * The other properties that are needed for a call such as the roomname will be set by the client in the anchor part of the url. * * If you want to retrieve a value, use dc_get_config(). * diff --git a/src/config.rs b/src/config.rs index e67144dc5..31067a27f 100644 --- a/src/config.rs +++ b/src/config.rs @@ -123,9 +123,11 @@ pub enum Config { /// because we do not want to send a second warning) NotifyAboutWrongPw, - /// webrtc signaling server (https://github.com/cracker0dks/basicwebrtc) that should be used for calls - /// Format: https://example.com/subdir?token=TOKEN - /// The other properties that are needed for a call such as the roomname will be set in the anchor part of the url. + /// address to webrtc signaling server (https://github.com/cracker0dks/basicwebrtc) + /// that should be used for opening video hangouts. + /// This property is only used in the UIs not by the core itself. + /// Format: https://example.com/subdir + /// The other properties that are needed for a call such as the roomname will be set by the client in the anchor part of the url. BasicWebRTCInstance, }