Commit graph

6 commits

Author SHA1 Message Date
CodeYan01 d3eba18718 docs: Clarify signal_handler_connect()
Notes that it does nothing if the combination of `signal`,
`callback`, and `data` is already connected to the handler.
Adds missing param `signal` description.
Typo fix
2022-12-03 15:19:06 -08:00
CodeYan01 bdf6809f45 docs: Add clarifications
Adds links to release functions for "new/incremented reference".
Extra info on signal handler.
Parameter description on `obs_property_list_add_*` functions, since
their parameter `name` can be confusing and it is unclear which value
is stored in obs_data_t.
Adds clarifications on calldata_ptr.
2022-11-05 16:12:13 -07:00
CodeYan01 81233c6dd4 docs: Add links to python functions 2022-10-01 16:09:29 -07:00
Matt Gajownik ff555dd2b0 CI: Update docs to Sphinx v3, fix warnings
Sphinx 3 adds a number of C and C++ friendly directives, making
documenting our code much easier.
2022-07-30 11:09:01 +10:00
jp9000 3a05cf6ab0 libobs/callback: Add signal reference counting
Adds a simple signal reference counting function
(signal_handler_connect_ref) that makes it so that signals keep the
handler around until the all the signal itself is disconnected.  This
prevents potential crashes where a signal might try to disconnect after
a handler has already been destroyed (typically in C++ with
OBSSignalHandler helper objects, where destruction isn't guaranteed to
be predictable).

This also modifies OBSSignalHandler to use the reference-counting
connections.
2018-06-03 15:04:03 -07:00
jp9000 d51e2a019b docs/sphinx: Add sphinx documentation 2017-11-27 03:02:04 -08:00