From de10f5e4f088252d2d3ee78b75c81026c37d834c Mon Sep 17 00:00:00 2001 From: "Ignas Anikevicius (gns_ank)" Date: Tue, 20 May 2014 11:44:21 +0100 Subject: [PATCH] Docs: awful.layouts fixup Signed-off-by: Ignas Anikevicius (gns_ank) --- lib/awful/layout/init.lua.in | 9 +++++++-- lib/awful/layout/suit/fair.lua.in | 5 +++-- lib/awful/layout/suit/floating.lua.in | 5 +++-- lib/awful/layout/suit/init.lua.in | 4 ++-- lib/awful/layout/suit/magnifier.lua.in | 5 +++-- lib/awful/layout/suit/max.lua.in | 5 +++-- lib/awful/layout/suit/spiral.lua.in | 5 ++++- lib/awful/layout/suit/tile.lua.in | 5 +++-- 8 files changed, 28 insertions(+), 15 deletions(-) diff --git a/lib/awful/layout/init.lua.in b/lib/awful/layout/init.lua.in index f9e4aa4a..1a1369b4 100755 --- a/lib/awful/layout/init.lua.in +++ b/lib/awful/layout/init.lua.in @@ -1,7 +1,10 @@ --------------------------------------------------------------------------- +--- Layout module for awful +-- -- @author Julien Danjou <julien@danjou.info> -- @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 diff --git a/lib/awful/layout/suit/fair.lua.in b/lib/awful/layout/suit/fair.lua.in index 7ff20787..95cb9ccf 100644 --- a/lib/awful/layout/suit/fair.lua.in +++ b/lib/awful/layout/suit/fair.lua.in @@ -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) diff --git a/lib/awful/layout/suit/floating.lua.in b/lib/awful/layout/suit/floating.lua.in index d3f0d92d..937df3a0 100644 --- a/lib/awful/layout/suit/floating.lua.in +++ b/lib/awful/layout/suit/floating.lua.in @@ -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) diff --git a/lib/awful/layout/suit/init.lua.in b/lib/awful/layout/suit/init.lua.in index a940ca09..3c354080 100644 --- a/lib/awful/layout/suit/init.lua.in +++ b/lib/awful/layout/suit/init.lua.in @@ -1,11 +1,11 @@ --------------------------------------------------------------------------- +--- Suits for awful -- @author Julien Danjou <julien@danjou.info> -- @copyright 2008 Julien Danjou -- @release @AWESOME_VERSION@ +-- @module awful.layout.suit --------------------------------------------------------------------------- ---- Suits for awful - return { max = require("awful.layout.suit.max"); diff --git a/lib/awful/layout/suit/magnifier.lua.in b/lib/awful/layout/suit/magnifier.lua.in index 909c7e34..ceddaa24 100644 --- a/lib/awful/layout/suit/magnifier.lua.in +++ b/lib/awful/layout/suit/magnifier.lua.in @@ -1,7 +1,10 @@ --------------------------------------------------------------------------- +--- Magnifier layout module for awful +-- -- @author Julien Danjou <julien@danjou.info> -- @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) diff --git a/lib/awful/layout/suit/max.lua.in b/lib/awful/layout/suit/max.lua.in index d5afd545..14ea9f02 100644 --- a/lib/awful/layout/suit/max.lua.in +++ b/lib/awful/layout/suit/max.lua.in @@ -1,15 +1,16 @@ --------------------------------------------------------------------------- +--- Maximized and fullscreen layouts module for awful +-- -- @author Julien Danjou <julien@danjou.info> -- @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) diff --git a/lib/awful/layout/suit/spiral.lua.in b/lib/awful/layout/suit/spiral.lua.in index 9bdd1473..c04a145a 100644 --- a/lib/awful/layout/suit/spiral.lua.in +++ b/lib/awful/layout/suit/spiral.lua.in @@ -1,15 +1,18 @@ --------------------------------------------------------------------------- +--- Dwindle and spiral layouts +-- -- @author Uli Schlachter <psychon@znc.in> -- @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) diff --git a/lib/awful/layout/suit/tile.lua.in b/lib/awful/layout/suit/tile.lua.in index 2c9447bd..ba0a524e 100644 --- a/lib/awful/layout/suit/tile.lua.in +++ b/lib/awful/layout/suit/tile.lua.in @@ -1,9 +1,12 @@ --------------------------------------------------------------------------- +--- Tiled layouts module for awful +-- -- @author Donald Ephraim Curtis <dcurtis@cs.uiowa.edu> -- @author Julien Danjou <julien@danjou.info> -- @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)