a7fd2e2278
naughty.notification: Update the property documentation.
2022-08-29 22:49:47 -07:00
e4d88e5566
naughty.list.notifications: Update the property documentation.
2022-08-29 22:49:47 -07:00
51a1d387e5
naughty.list.actions: Update the property documentation.
2022-08-29 22:49:47 -07:00
eb21c24acb
naughty.layout.box: Update the property documentation.
2022-08-29 22:49:47 -07:00
c3a73cab53
naughty.core: Update the property documentation.
2022-08-29 22:49:47 -07:00
85eb759bd8
naughty.container.background: Update the property documentation.
2022-08-29 22:49:47 -07:00
6b382148a8
naughty.action: Update the property documentation.
2022-08-29 22:49:47 -07:00
05ecb513c5
menubar.init: Update the property documentation.
2022-08-29 22:49:47 -07:00
11ce8fd77c
gears.timer: Update the property documentation.
2022-08-29 22:49:47 -07:00
52c481babc
gears.color: Update the property documentation.
2022-08-29 22:49:47 -07:00
8f1a29b15f
awful.widget.watch: Update the property documentation.
2022-08-29 22:49:47 -07:00
d45bd3a9d9
awful.widget.tasklist: Update the property documentation.
2022-08-29 22:49:47 -07:00
a96ad1b766
awful.widget.taglist: Update the property documentation.
2022-08-29 22:49:47 -07:00
60b52ab4c3
awful.widget.only_on_screen: Update the property documentation.
2022-08-29 22:49:47 -07:00
4c4d833a69
awful.widget.layoutlist: Update the property documentation.
2022-08-29 22:49:47 -07:00
0e5a62950e
awful.widget.layoutbox: Update the property documentation.
2022-08-29 22:49:47 -07:00
72041d63a4
awful.widget.keyboardlayout: Update the property documentation.
2022-08-29 22:49:47 -07:00
176526a8d2
awful.widget.clienticon: Update the property documentation.
2022-08-29 22:49:47 -07:00
bd07d49197
awful.wibar: Update the property documentation.
2022-08-29 22:49:47 -07:00
b5a9250a58
awful.wallpaper: Update the property documentation.
2022-08-29 22:49:47 -07:00
9d04ba72f9
awful.tooltip: Update the property documentation.
2022-08-29 22:49:47 -07:00
91de268703
awful.tag: Update the property documentation.
2022-08-29 22:49:47 -07:00
6d31e783df
awful.screen: Update the property documentation.
2022-08-29 22:49:47 -07:00
5909d2f155
awful.popup: Update the property documentation.
2022-08-29 22:49:47 -07:00
e8a505273a
awful.mouse.init: Update the property documentation.
2022-08-29 22:49:46 -07:00
deaeb4dab8
awful.keygrabber: Update the property documentation.
2022-08-29 22:49:46 -07:00
530055f024
awful.key: Update the property documentation.
2022-08-29 22:49:46 -07:00
0b902c1d69
awful.hotkeys_popup.widget: Update the property documentation.
2022-08-29 22:49:46 -07:00
418bf92858
awful.client: Update the property documentation.
2022-08-29 22:49:46 -07:00
6e546bcb6a
awful.button: Update the property documentation.
2022-08-29 22:49:46 -07:00
f6370c45c3
docs.common.widget.ldoc: Update the property documentation.
2022-08-29 22:49:46 -07:00
0cf97e007d
docs.common.wibox.ldoc: Update the property documentation.
2022-08-29 22:49:46 -07:00
50c98059b8
doc: Fix a rendering problem.
...
Beause the HTML was indented with more than 3 spaces, it was converted
to mardown when using the fallback (not discount) markdown rendered.
2022-08-29 22:49:46 -07:00
0f948c145f
tests: Fix a missing --DOC_HIDE in the notification examples.
2022-08-29 22:49:46 -07:00
7091b2720c
test: Enforce the maximum size for the `wibox` test example templte.
...
So far, it worked fine if both `w`/`h` were enforced or neither.
If one was, then there was a chance one axis would end up 9999
pixel wide or tall. This worked fine when the `.svg` was inserted
using `<img>`, but now that it's using `<object>`, it now scales
down to zero.
2022-08-29 22:49:46 -07:00
a722a67679
doc: Fix a CSS regression from a recent commit.
2022-08-29 22:49:46 -07:00
9c6ac7ec35
doc: Enforce a strict schema for all @property entries.
...
It now requires some extra tags to be added. With the new constraints,
the rendering is much more detailed.
2022-08-29 22:49:46 -07:00
27f329a229
doc: Add a standard way to add metadata to the property documentation.
2022-08-29 22:49:46 -07:00
a698d20e81
doc: Add more property warnings.
...
The goal is to fix these issues so the new rendering can become
stable.
2022-08-29 22:49:46 -07:00
19e586f969
doc: Replace the rendering for the @property default values.
2022-08-29 22:49:46 -07:00
31061cb2e6
doc: Add @range_stop, @range_start, @property_value and @property_unit.
...
This will be used in the next commit to describe properties in a more
consistent way.
2022-08-29 22:49:46 -07:00
4fa957b75d
doc: Force all properties to document their default value.
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
3510d96d6c
doc: Find and post-process untracked SVG files.
...
Right now the UML template write many files which were not tracked
by CMake. This caused them to be missing from the doc since the
post-processing was added.
2022-08-29 22:49:03 -07:00
4bd90f0f35
doc: Add documentation linting and fix all issues it found.
2022-08-29 22:48:54 -07:00
b4c989bcf8
doc: Fix some regression introduced when fixing the shims behavior.
...
Previously, clients were displayed even when they were not tagged
or minimized. This was fixed in the shims. However, some examples
never created tags, so the client were never tagged, thus no longer
displayed.
2022-08-29 22:48:54 -07:00
f3987f43b6
doc: More proof reading fixes.
2022-08-29 22:48:54 -07:00
4a6385cf40
doc: Replace the function argument rendering.
...
This is an attempt at solving several problems reported by novice
users. The old rendering was very compact and quite fine once you
got used to its, ..., "conventions". But it was also sometime rather
hard to read.
First of all, it abused bold and italic. It also "merged" optional
parameters and parameters with default content. It got worst when
the documentation was spread over mutiple lines.
For property types and constructors with large number of parameters,
it was also quite unreadable.
The new representation, while far from perfect, is less dense and
more explicit. It has a separate column for "optional" using the
new "metadata chip" documentation concept. It is also an aligned
table and correctly renders multi-line documentation.
Finally, it adds a "note" message when the named parameter convention
is used. This way the users looking at the examples will be less
confused.
2022-08-29 22:48:54 -07:00
f26642f037
doc: Fix mnor rendering issues.
...
The module name wasn't present when it should have been. Same for
the function params.
2022-08-29 22:48:54 -07:00
292b657aea
doc: Disable the ldoc optional function parameter mangling.
...
It no longer does `foo(bar[,bar=42])` and will rather do `(foo, bar)`.
This is easier to read and some new user are no familiar with the
optional parameter convention. They copy/paste the mangled value in
their config and end up with invalid Lua.
2022-08-29 22:48:54 -07:00
Emmanuel Lepage Vallee