Fix C documentation

link2xt · link2xt · commit d8ba8fc28f41 · 2024-06-03T21:06:41.000Z
diff --git a/deltachat-ffi/deltachat.h b/deltachat-ffi/deltachat.h
@@ -523,7 +523,9 @@ char*           dc_get_blobdir               (const dc_context_t* context);
  *                    e.g. `ui.desktop.foo`, `ui.desktop.linux.bar`, `ui.android.foo`, `ui.dc40.bar`, `ui.bot.simplebot.baz`.
  *                    These keys go to backups and allow easy per-account settings when using @ref dc_accounts_t,
  *                    however, are not handled by the core otherwise.
- *- `enable_realtime` = Whether the realtime APIs should be enabled. If not enabled, they will behave as noops.
+ * - `webxdc_realtime_enabled` = Whether the realtime APIs should be enabled.
+ *                               0 = WebXDC realtime API is disabled and behaves as noop (default).
+ *                               1 = WebXDC realtime API is enabled.
  *
  * If you want to retrieve a value, use dc_get_config().
  *

Original file line number	Diff line number	Diff line change
`@@ -523,7 +523,9 @@ char* dc_get_blobdir (const dc_context_t* context);`
`523`	`523`	* e.g. `ui.desktop.foo`, `ui.desktop.linux.bar`, `ui.android.foo`, `ui.dc40.bar`, `ui.bot.simplebot.baz`.
`524`	`524`	`* These keys go to backups and allow easy per-account settings when using @ref dc_accounts_t,`
`525`	`525`	`* however, are not handled by the core otherwise.`
`526`		- *- `enable_realtime` = Whether the realtime APIs should be enabled. If not enabled, they will behave as noops.
	`526`	+ * - `webxdc_realtime_enabled` = Whether the realtime APIs should be enabled.
	`527`	`+ * 0 = WebXDC realtime API is disabled and behaves as noop (default).`
	`528`	`+ * 1 = WebXDC realtime API is enabled.`
`527`	`529`	`*`
`528`	`530`	`* If you want to retrieve a value, use dc_get_config().`
`529`	`531`	`*`