awesome/docs/common
Aidin 03285e8589
Comment and documentation improvement (#3943)
* Added that the timer timeout is in seconds

* Contrasted the differences of autostart and call_now

* A minor grammatical change

* Spread comments in multiple lines so lines would be shorter

* Used three dashes instead of one for documentation

* Included available cursor names as an ldoc files, and also added
a new file named 'cursor_c_lua.ldoc' which uses awesome comments
syntax, because the existing 'cursor_c.ldoc' could not be compiled.

* Fixed typo

* Fixed formatting and file names
2024-09-05 16:27:43 +02:00
..
client_theme.ldoc doc: Add documentation linting and fix all issues it found. 2022-08-29 22:48:54 -07:00
cobject.ldoc doc: Add a mandatory `@noreturn` for functions and methods. 2022-08-29 22:49:45 -07:00
cursor.ldoc Comment and documentation improvement (#3943) 2024-09-05 16:27:43 +02:00
cursor_c.ldoc docs(mousegrabber): Prevent Markdown parsing in identifier names 2021-12-21 10:25:05 +01:00
fixed.ldoc doc: Add a mandatory `@noreturn` for functions and methods. 2022-08-29 22:49:45 -07:00
glib_timedate_format.ldoc doc(wibox.widget.textclock): Widget definition. 2021-04-07 01:38:53 -07:00
notification_rules_index.ldoc docs: Fix links in ruled.notifications 2023-06-01 08:51:02 +02:00
object.ldoc doc: Add a mandatory `@noreturn` for functions and methods. 2022-08-29 22:49:45 -07:00
rule.ldoc fix: Docs update to specify rule callback as being run before properties applied 2021-12-23 14:02:24 -08:00
rules_index.ldoc doc: Remove all type aliases. 2020-01-19 20:30:06 -05:00
signals.ldoc doc: Add a mandatory `@noreturn` for functions and methods. 2022-08-29 22:49:45 -07:00
wibox.ldoc docs.common.wibox.ldoc: Update the property documentation. 2022-08-29 22:49:46 -07:00
wibox_constructor.ldoc doc: Mutualize the wibar and wibox constructor documentation. 2017-11-27 00:22:11 -05:00
widget.ldoc doc: Do not document the 16bit max widget size. 2022-08-29 22:54:09 -07:00