starred/obs-studio
1
0
Fork 0
mirror of https://github.com/obsproject/obs-studio.git synced 2026-09-28 02:06:12 -04:00
Code Issues Packages Projects Releases Wiki Activity

docs/sphinx: Fix documentation for addref/release functions

Browse Source 
Incorrectly implied that both addref and release calls were deprecated;
only addref calls are deprecated.
This commit is contained in:
jp9000
2022-01-25 06:22:13 -08:00
parent 0377b962b5
commit c1905f4e53
5 changed files with 39 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/sphinx/reference-sources.rst
+8 -3
View File
@@ -732,10 +732,8 @@ General Source Functions
---------------------
.. function:: void obs_source_addref(obs_source_t *source)
void obs_source_release(obs_source_t *source)
Adds/releases a reference to a source. When the last reference is
released, the source is destroyed.
Adds a reference to a source.
.. deprecated:: 27.2.0
Use :c:func:`obs_source_get_ref()` instead.
@@ -749,6 +747,13 @@ General Source Functions
---------------------
.. function:: void obs_source_release(obs_source_t *source)
Releases a reference to a source. When the last reference is
released, the source is destroyed.
---------------------
.. function:: obs_weak_source_t *obs_source_get_weak_source(obs_source_t *source)
obs_source_t *obs_weak_source_get_source(obs_weak_source_t *weak)