Browse Source

docs: Clarify weak source releasing

CodeYan01 2 years ago
parent
commit
7605883303
1 changed files with 4 additions and 3 deletions
  1. 4 3
      docs/sphinx/reference-sources.rst

+ 4 - 3
docs/sphinx/reference-sources.rst

@@ -789,10 +789,11 @@ General Source Functions
 .. 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)
 
-   These functions are used to get a weak reference from a strong source
-   reference, or a strong source reference from a weak reference.  If
+   These functions are used to get an incremented weak reference from a strong source
+   reference, or an incremented strong source reference from a weak reference. If
    the source is destroyed, *obs_weak_source_get_source* will return
-   *NULL*.
+   *NULL*. Release with :c:func:`obs_weak_source_release()` or
+   :c:func:`obs_source_release()`, respectively.
 
 ---------------------