awesomewm-mirrors
/
awesome
mirror of https://github.com/awesomeWM/awesome.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

doc: Add some @see to the shape doc. 

The `transform` function was unclear.
This commit is contained in:
Emmanuel Lepage Vallee 2021-12-13 13:55:17 -08:00
parent 69ab73aa23
commit f8f11a23f5
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
lib/gears/shape.lua
View File

@ -820,6 +820,12 @@ end
-- @param shape A shape function -- @param shape A shape function
-- @return A transformation handle, also act as a shape function -- @return A transformation handle, also act as a shape function
-- @staticfct gears.shape.transform -- @staticfct gears.shape.transform
-- @see gears.matrix.translate
-- @see gears.matrix.scale
-- @see gears.matrix.rotate
-- @see gears.matrix.rotate_at
-- @see gears.matrix.multiply
-- @see gears.matrix.invert
function module.transform(shape) function module.transform(shape)
-- Apply the transformation matrix and apply the shape, then restore -- Apply the transformation matrix and apply the shape, then restore