doc(w.w.textbox): Make alignment property descriptions consistent

Signed-off-by: Lucas Schwiderski <lucas@lschwiderski.de>
This commit is contained in:
Lucas Schwiderski 2021-12-14 19:09:42 +01:00
parent 70524e72fa
commit 869e63fcdc
No known key found for this signature in database
GPG Key ID: AA12679AAA6DF4D8
1 changed files with 16 additions and 12 deletions

View File

@ -301,19 +301,21 @@ function textbox:set_wrap(mode)
end end
end end
--- The textbox' vertical alignment. --- The vertical text alignment.
--
-- This aligns the text within the widget's bounds. In some situations this may
-- differ from aligning the widget with `wibox.container.place`.
-- --
-- Valid values are: -- Valid values are:
-- --
-- * **top** -- * `"top"`
-- * **center** -- * `"center"`
-- * **bottom** -- * `"bottom"`
-- --
--@DOC_wibox_widget_textbox_valign1_EXAMPLE@ --@DOC_wibox_widget_textbox_valign1_EXAMPLE@
-- --
-- @property valign -- @property valign
-- @tparam[opt="center"] string mode Where should the textbox be drawn? "top", "center" or -- @tparam[opt="center"] string mode The vertical alignment
-- "bottom".
-- @propemits true false -- @propemits true false
function textbox:set_valign(mode) function textbox:set_valign(mode)
@ -329,19 +331,21 @@ function textbox:set_valign(mode)
end end
end end
--- Set a textbox horizontal alignment. --- The horizontal text alignment.
--
-- This aligns the text within the widget's bounds. In some situations this may
-- differ from aligning the widget with `wibox.container.place`.
-- --
-- Valid values are: -- Valid values are:
-- --
-- * **left** -- * `"left"`
-- * **center** -- * `"center"`
-- * **right** -- * `"right"`
-- --
--@DOC_wibox_widget_textbox_align1_EXAMPLE@ --@DOC_wibox_widget_textbox_align1_EXAMPLE@
-- --
-- @property align -- @property align
-- @tparam[opt="left"] string mode Where should the textbox be drawn? "left", "center" or -- @tparam[opt="left"] string mode The horizontal alignment
-- "right".
-- @propemits true false -- @propemits true false
function textbox:set_align(mode) function textbox:set_align(mode)