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

doc(lib: gears: surface): more verbose docstring 

Closes https://github.com/awesomeWM/awesome/pull/436.
This commit is contained in:
actionless 2015-09-05 21:12:09 +02:00 committed by Daniel Hahler
parent 32a4a0e261
commit 7ae58b3208
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
lib/gears/surface.lua
View File

@ -71,7 +71,14 @@ function surface.get_size(surf)
end end
--- Get the duplicate of a cairo surface --- Create a copy of a cairo surface.
-- The surfaces returned by `surface.load` are cached and must not be
-- modified to avoid unintended side-effects. This function allows to create
-- a copy of a cairo surface. This copy can then be freely modified.
-- The surface returned will be as compatible as possible to the input
-- surface. For example, it will likely be of the same surface type as the
-- input. The details are explained in the `create_similar` function on a cairo
-- surface.
-- @param s Source surface. -- @param s Source surface.
-- @return The surface's duplicate. -- @return The surface's duplicate.
function surface.duplicate_surface(s) function surface.duplicate_surface(s)