awesomewm-mirrors
/
awesome
mirror of https://github.com/awesomeWM/awesome.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
awesome/docs/common/cobject.ldoc

29 lines
702 B
Plaintext
Raw Normal View History

doc: Add missing C-object documentation and fix some papercuts. Ref: https://github.com/awesomeWM/awesome/issues/1373
2017-10-21 01:54:36 +02:00
*/
/** Disconnect from a signal.
doc: Add a mandatory `@noreturn` for functions and methods. The goal is to catch cases where the return value exists, but is forgotten. There was a large enough number of them to turn this into a real check. Initially, I just wanted to implement it to fix the problems, then delete the code. But since this is so common, I think it is worth the annoyance.
2022-07-05 10:37:14 +02:00
*
doc: Add missing C-object documentation and fix some papercuts. Ref: https://github.com/awesomeWM/awesome/issues/1373
2017-10-21 01:54:36 +02:00
* @tparam string name The name of the signal.
* @tparam function func The callback that should be disconnected.
doc: Use an explicit tag for all static functions. This way their name doesn't get mangle by the broken magic. It will also eventually allow to `error()` in the template when the implicit `@function` is used. This commit also fixes a large number of issues found while proof-reading everything.
2019-06-08 01:08:05 +02:00
* @staticfct disconnect_signal
doc: Add a mandatory `@noreturn` for functions and methods. The goal is to catch cases where the return value exists, but is forgotten. There was a large enough number of them to turn this into a real check. Initially, I just wanted to implement it to fix the problems, then delete the code. But since this is so common, I think it is worth the annoyance.
2022-07-05 10:37:14 +02:00
* @noreturn
doc: Add missing C-object documentation and fix some papercuts. Ref: https://github.com/awesomeWM/awesome/issues/1373
2017-10-21 01:54:36 +02:00
*/
/** Emit a signal.
*
* @tparam string name The name of the signal.
* @param ... Extra arguments for the callback functions. Each connected
* function receives the object as first argument and then any extra
* arguments that are given to emit_signal().
doc: Use an explicit tag for all static functions. This way their name doesn't get mangle by the broken magic. It will also eventually allow to `error()` in the template when the implicit `@function` is used. This commit also fixes a large number of issues found while proof-reading everything.
2019-06-08 01:08:05 +02:00
* @staticfct emit_signal
doc: Add a mandatory `@noreturn` for functions and methods. The goal is to catch cases where the return value exists, but is forgotten. There was a large enough number of them to turn this into a real check. Initially, I just wanted to implement it to fix the problems, then delete the code. But since this is so common, I think it is worth the annoyance.
2022-07-05 10:37:14 +02:00
* @noreturn
doc: Add missing C-object documentation and fix some papercuts. Ref: https://github.com/awesomeWM/awesome/issues/1373
2017-10-21 01:54:36 +02:00
*/
/** Connect to a signal.
* @tparam string name The name of the signal.
* @tparam function func The callback to call when the signal is emitted.
doc: Use an explicit tag for all static functions. This way their name doesn't get mangle by the broken magic. It will also eventually allow to `error()` in the template when the implicit `@function` is used. This commit also fixes a large number of issues found while proof-reading everything.
2019-06-08 01:08:05 +02:00
* @staticfct connect_signal
doc: Add a mandatory `@noreturn` for functions and methods. The goal is to catch cases where the return value exists, but is forgotten. There was a large enough number of them to turn this into a real check. Initially, I just wanted to implement it to fix the problems, then delete the code. But since this is so common, I think it is worth the annoyance.
2022-07-05 10:37:14 +02:00
* @noreturn
doc: Add missing C-object documentation and fix some papercuts. Ref: https://github.com/awesomeWM/awesome/issues/1373
2017-10-21 01:54:36 +02:00
*/
/*