improve documentation a bit

This commit is contained in:
Simon Laux
2020-07-18 02:54:54 +02:00
committed by holger krekel
parent 8895dc36c7
commit bb2e8b4392
2 changed files with 10 additions and 7 deletions

View File

@@ -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().
*

View File

@@ -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,
}