0cf97e007d
docs.common.wibox.ldoc: Update the property documentation.
2022-08-29 22:49:46 -07:00
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
4bd90f0f35
doc: Add documentation linting and fix all issues it found.
2022-08-29 22:48:54 -07:00
3c26ccc424
doc: Port the `wibox` module to the new doc format.
2019-12-21 13:25:25 -08:00
Aire-One
185ad15140
Add inheritance tags to `docs/common/wibox.ldoc`.
2019-11-27 01:44:23 -05:00
90a29f92eb
doc: Fix all the property, theme and field types.
2019-06-08 18:14:14 -04:00
63ca0f0d8f
doc: Use an explicit @method stereotype for all methods.
...
ldoc has a magical `@classmod` module type which tries to detect
what is a method and what is a static function. It fails about as
often as it works. This commit makes everything explicit to remove
such issues.
Fixes #2640
Ref #1373
2019-06-08 18:13:42 -04:00
4e54aea6a9
wibox: Add an input_passthrough property.
...
Allows, for example, to have semi translucent wibars on top of
the fullscreens clients without having issues with inputs.
2017-11-27 00:20:42 -05:00
f24e957c17
doc: Fix wibar documentation
...
I got it wrong in the PR that introduced the beautiful variables.
Too much find&replace...
2017-02-27 16:12:37 -05:00
47d69e7824
Update docs for shape_input
...
I grepped for shape_clip and edited places that needed editing.
Signed-off-by: Uli Schlachter <psychon@znc.in>
2017-01-26 11:15:28 +01:00
40d1d5c9c7
doc: Remove wibox prefixes
...
This produced the wrong output in awful.wibar documentation
2016-05-19 01:27:05 -04:00
77380eb121
wibox: Move the documentation to a shared file
...
To be re-used by wibars, tooltips and menus
2016-05-15 17:17:12 -04:00
Emmanuel Lepage Vallee
Aire-One
Uli Schlachter