4aiman/obs-studio
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

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:21:32 -08:00
commit c1905f4e53
5 changed files with 39 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

11
docs/sphinx/reference-services.rst
View file

@ -180,10 +180,8 @@ General Service Functions
---------------------
.. function:: void obs_service_addref(obs_service_t *service)
void obs_service_release(obs_service_t *service)
Adds/releases a reference to a service. When the last reference is
released, the service is destroyed.
Adds a reference to a service.
.. deprecated:: 27.2.0
Use :c:func:`obs_service_get_ref()` instead.
@ -197,6 +195,13 @@ General Service Functions
---------------------
.. function:: void obs_service_release(obs_service_t *service)
Releases a reference to a service. When the last reference is
released, the service is destroyed.
---------------------
.. function:: obs_weak_service_t *obs_service_get_weak_service(obs_service_t *service)
obs_service_t *obs_weak_service_get_service(obs_weak_service_t *weak)