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-outputs.rst
+8 -3
View File
@@ -334,10 +334,8 @@ General Output Functions
---------------------
.. function:: void obs_output_addref(obs_output_t *output)
void obs_output_release(obs_output_t *output)
Adds/releases a reference to an output. When the last reference is
released, the output is destroyed.
Adds a reference to an output.
.. deprecated:: 27.2.0
Use :c:func:`obs_output_get_ref()` instead.
@@ -351,6 +349,13 @@ General Output Functions
---------------------
.. function:: void obs_output_release(obs_output_t *output)
Releases a reference to an output. When the last reference is
released, the output is destroyed.
---------------------
.. function:: obs_weak_output_t *obs_output_get_weak_output(obs_output_t *output)
obs_output_t *obs_weak_output_get_output(obs_weak_output_t *weak)