awesome

Commit Graph

Author	SHA1	Message	Date
Emmanuel Lepage Vallee	86d1b1c22c	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-08-29 22:49:45 -07:00
Emmanuel Lepage Vallee	b4ece0f053	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 18:14:13 -04:00
Daniel Hahler	3876b18240	doc: Add missing C-object documentation and fix some papercuts. Ref: https://github.com/awesomeWM/awesome/issues/1373	2018-07-25 18:26:11 -04:00

Author

SHA1

Message

Date

Emmanuel Lepage Vallee

86d1b1c22c

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-08-29 22:49:45 -07:00

Emmanuel Lepage Vallee

b4ece0f053

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 18:14:13 -04:00

Daniel Hahler

3876b18240

doc: Add missing C-object documentation and fix some papercuts.

Ref: https://github.com/awesomeWM/awesome/issues/1373

2018-07-25 18:26:11 -04:00

3 Commits