Docs: awful.layouts fixup

Signed-off-by: Ignas Anikevicius (gns_ank) <anikevicius@gmail.com>
This commit is contained in:
Ignas Anikevicius (gns_ank) 2014-05-20 11:44:21 +01:00 committed by Daniel Hahler
parent 9f8e2b1336
commit de10f5e4f0
8 changed files with 28 additions and 15 deletions

View file

@ -1,7 +1,10 @@
---------------------------------------------------------------------------
--- Layout module for awful
--
-- @author Julien Danjou &lt;julien@danjou.info&gt;
-- @copyright 2008 Julien Danjou
-- @release @AWESOME_VERSION@
-- @module awful.layout
---------------------------------------------------------------------------
-- Grab environment we need
@ -18,9 +21,11 @@ local capi = {
local client = require("awful.client")
local timer = require("gears.timer")
--- Layout module for awful
-- awful.layout
local layout = {}
--- Default predefined layouts
--
-- @fixme Add documentation on available layouts as all of them are hidden
layout.suit = require("awful.layout.suit")
-- The default list of layouts

View file

@ -1,15 +1,16 @@
---------------------------------------------------------------------------
--- Fair layouts module for awful
--
-- @author Josh Komoroske
-- @copyright 2012 Josh Komoroske
-- @release @AWESOME_VERSION@
-- @module awful.layout.suit.fair
---------------------------------------------------------------------------
-- Grab environment we need
local ipairs = ipairs
local math = math
--- Fair layouts module for awful
-- awful.layout.suit.fair
local fair = {}
local function do_fair(p, orientation)

View file

@ -1,10 +1,12 @@
---------------------------------------------------------------------------
--- Dummy function for floating layout
--
-- @author Gregor Best
-- @copyright 2008 Gregor Best
-- @release @AWESOME_VERSION@
-- @module awful.layout.suit.floating
---------------------------------------------------------------------------
--- Dummy function for floating layout
-- Grab environment we need
local math = math
local ipairs = ipairs
@ -14,7 +16,6 @@ local capi =
mousegrabber = mousegrabber
}
-- awful.layout.suit.floating
local floating = {}
function floating.mouse_resize_handler(c, corner, x, y)

View file

@ -1,11 +1,11 @@
---------------------------------------------------------------------------
--- Suits for awful
-- @author Julien Danjou &lt;julien@danjou.info&gt;
-- @copyright 2008 Julien Danjou
-- @release @AWESOME_VERSION@
-- @module awful.layout.suit
---------------------------------------------------------------------------
--- Suits for awful
return
{
max = require("awful.layout.suit.max");

View file

@ -1,7 +1,10 @@
---------------------------------------------------------------------------
--- Magnifier layout module for awful
--
-- @author Julien Danjou &lt;julien@danjou.info&gt;
-- @copyright 2008 Julien Danjou
-- @release @AWESOME_VERSION@
-- @module awful.layout.suit.magnifier
---------------------------------------------------------------------------
-- Grab environment we need
@ -17,8 +20,6 @@ local capi =
}
local client = require("awful.client")
--- Magnifier layout module for awful
-- awful.layout.suit.magnifier
local magnifier = {}
function magnifier.mouse_resize_handler(c, corner, x, y)

View file

@ -1,15 +1,16 @@
---------------------------------------------------------------------------
--- Maximized and fullscreen layouts module for awful
--
-- @author Julien Danjou &lt;julien@danjou.info&gt;
-- @copyright 2008 Julien Danjou
-- @release @AWESOME_VERSION@
-- @module awful.layout.suit.max
---------------------------------------------------------------------------
-- Grab environment we need
local pairs = pairs
local client = require("awful.client")
--- Maximized and fullscreen layouts module for awful
-- awful.layout.suit.max
local max = {}
local function fmax(p, fs)

View file

@ -1,15 +1,18 @@
---------------------------------------------------------------------------
--- Dwindle and spiral layouts
--
-- @author Uli Schlachter &lt;psychon@znc.in&gt;
-- @copyright 2009 Uli Schlachter
-- @copyright 2008 Julien Danjou
-- @release @AWESOME_VERSION@
--
-- @module awful.layout.suit.spiral
---------------------------------------------------------------------------
-- Grab environment we need
local ipairs = ipairs
local math = math
-- awful.layout.suit.spiral
local spiral = {}
local function do_spiral(p, _spiral)

View file

@ -1,9 +1,12 @@
---------------------------------------------------------------------------
--- Tiled layouts module for awful
--
-- @author Donald Ephraim Curtis &lt;dcurtis@cs.uiowa.edu&gt;
-- @author Julien Danjou &lt;julien@danjou.info&gt;
-- @copyright 2009 Donald Ephraim Curtis
-- @copyright 2008 Julien Danjou
-- @release @AWESOME_VERSION@
-- @module awful.layout.suit.tile
---------------------------------------------------------------------------
-- Grab environment we need
@ -18,8 +21,6 @@ local capi =
mousegrabber = mousegrabber
}
--- Tiled layouts module for awful
-- awful.layout.suit.tile
local tile = {}
local function mouse_resize_handler(c, corner, x, y, orientation)