dany/clapper
1
0
Fork 0
mirror of https://github.com/Rafostar/clapper.git synced 2025-08-30 07:42:23 +02:00
Code Issues Packages Projects Releases Wiki Activity

clapper: doc: Update enhancer proxy docs

Browse Source
This commit is contained in:
Rafał Dzięgiel
2025-05-23 16:11:46 +02:00
parent c557c11e86
commit 749796a12f
1 changed files with 5 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
src/lib/clapper/clapper-enhancer-proxy.c
View File

@@ -706,7 +706,7 @@ clapper_enhancer_proxy_get_version (ClapperEnhancerProxy *self)
* *
* Get extra data from enhancer plugin info file specified by @key. * Get extra data from enhancer plugin info file specified by @key.
* *
* External data in the plugin info file is prefixed with `X-`. * Extra data in the plugin info file is prefixed with `X-`.
* For example `X-Schemes=https`. * For example `X-Schemes=https`.
* *
* Returns: (nullable): extra data value of the proxied enhancer. * Returns: (nullable): extra data value of the proxied enhancer.
@@ -740,6 +740,10 @@ clapper_enhancer_proxy_get_extra_data (ClapperEnhancerProxy *self, const gchar *
* calling this function with "X-Schemes" as key and "http" as value will * calling this function with "X-Schemes" as key and "http" as value will
* return %TRUE. * return %TRUE.
* *
* It is also safe to call this function when there is no such @key
* in plugin info file. Use [method@Clapper.EnhancerProxy.get_extra_data]
* if you need to know whether key exists.
*
* Returns: whether list named with @key existed and contained @value. * Returns: whether list named with @key existed and contained @value.
* *
* Since: 0.10 * Since: 0.10