From 280973c9cb78cdeee66c760480dd48ed9bfdd36c Mon Sep 17 00:00:00 2001
From: Emmanuel Lepage Vallee <elv1313@gmail.com>
Date: Sun, 14 Aug 2016 01:34:43 -0400
Subject: [PATCH] doc: Document all client layout theme properties.

---
 lib/awful/layout/suit/corner.lua    | 20 ++++++++++++++++++++
 lib/awful/layout/suit/fair.lua      | 10 ++++++++++
 lib/awful/layout/suit/floating.lua  |  5 +++++
 lib/awful/layout/suit/magnifier.lua |  5 +++++
 lib/awful/layout/suit/max.lua       | 10 ++++++++++
 lib/awful/layout/suit/spiral.lua    | 10 ++++++++++
 lib/awful/layout/suit/tile.lua      | 20 ++++++++++++++++++++
 7 files changed, 80 insertions(+)

diff --git a/lib/awful/layout/suit/corner.lua b/lib/awful/layout/suit/corner.lua
index 2327186ae..ea1a86036 100644
--- a/lib/awful/layout/suit/corner.lua
+++ b/lib/awful/layout/suit/corner.lua
@@ -14,6 +14,26 @@ local math = math
 local capi = {screen = screen}
 local tag = require("awful.tag")
 
+--- The cornernw layout layoutbox icon.
+-- @beautiful beautiful.layout_cornernw
+-- @param surface
+-- @see gears.surface
+
+--- The cornerne layout layoutbox icon.
+-- @beautiful beautiful.layout_cornerne
+-- @param surface
+-- @see gears.surface
+
+--- The cornersw layout layoutbox icon.
+-- @beautiful beautiful.layout_cornersw
+-- @param surface
+-- @see gears.surface
+
+--- The cornerse layout layoutbox icon.
+-- @beautiful beautiful.layout_cornerse
+-- @param surface
+-- @see gears.surface
+
 --- Actually arrange clients of p.clients for corner layout
 -- @param p Mandatory table containing required informations for layouts
 -- (clients to arrange, workarea geometry, etc.)
diff --git a/lib/awful/layout/suit/fair.lua b/lib/awful/layout/suit/fair.lua
index 3291530c3..e3f9b0e42 100644
--- a/lib/awful/layout/suit/fair.lua
+++ b/lib/awful/layout/suit/fair.lua
@@ -11,6 +11,16 @@
 local ipairs = ipairs
 local math = math
 
+--- The fairh layout layoutbox icon.
+-- @beautiful beautiful.layout_fairh
+-- @param surface
+-- @see gears.surface
+
+--- The fairv layout layoutbox icon.
+-- @beautiful beautiful.layout_fairv
+-- @param surface
+-- @see gears.surface
+
 local fair = {}
 
 local function do_fair(p, orientation)
diff --git a/lib/awful/layout/suit/floating.lua b/lib/awful/layout/suit/floating.lua
index 7f18f5280..3ba649ae6 100644
--- a/lib/awful/layout/suit/floating.lua
+++ b/lib/awful/layout/suit/floating.lua
@@ -15,6 +15,11 @@ local capi =
     mousegrabber = mousegrabber
 }
 
+--- The floating layout layoutbox icon.
+-- @beautiful beautiful.layout_floating
+-- @param surface
+-- @see gears.surface
+
 local floating = {}
 
 --- Jump mouse cursor to the client's corner when resizing it.
diff --git a/lib/awful/layout/suit/magnifier.lua b/lib/awful/layout/suit/magnifier.lua
index 02226658b..a7edf35d2 100644
--- a/lib/awful/layout/suit/magnifier.lua
+++ b/lib/awful/layout/suit/magnifier.lua
@@ -18,6 +18,11 @@ local capi =
     mousegrabber = mousegrabber
 }
 
+--- The magnifier layout layoutbox icon.
+-- @beautiful beautiful.layout_magnifier
+-- @param surface
+-- @see gears.surface
+
 local magnifier = {}
 
 function magnifier.mouse_resize_handler(c, corner, x, y)
diff --git a/lib/awful/layout/suit/max.lua b/lib/awful/layout/suit/max.lua
index 73603ab5d..6b662351e 100644
--- a/lib/awful/layout/suit/max.lua
+++ b/lib/awful/layout/suit/max.lua
@@ -12,6 +12,16 @@ local pairs = pairs
 
 local max = {}
 
+--- The max layout layoutbox icon.
+-- @beautiful beautiful.layout_max
+-- @param surface
+-- @see gears.surface
+
+--- The fullscreen layout layoutbox icon.
+-- @beautiful beautiful.layout_fullscreen
+-- @param surface
+-- @see gears.surface
+
 local function fmax(p, fs)
     -- Fullscreen?
     local area
diff --git a/lib/awful/layout/suit/spiral.lua b/lib/awful/layout/suit/spiral.lua
index c04a145ac..3e142952a 100644
--- a/lib/awful/layout/suit/spiral.lua
+++ b/lib/awful/layout/suit/spiral.lua
@@ -13,6 +13,16 @@
 local ipairs = ipairs
 local math = math
 
+--- The spiral layout layoutbox icon.
+-- @beautiful beautiful.layout_spiral
+-- @param surface
+-- @see gears.surface
+
+--- The dwindle layout layoutbox icon.
+-- @beautiful beautiful.layout_dwindle
+-- @param surface
+-- @see gears.surface
+
 local spiral = {}
 
 local function do_spiral(p, _spiral)
diff --git a/lib/awful/layout/suit/tile.lua b/lib/awful/layout/suit/tile.lua
index 3215b033f..fb62f6d1b 100644
--- a/lib/awful/layout/suit/tile.lua
+++ b/lib/awful/layout/suit/tile.lua
@@ -23,6 +23,26 @@ local capi =
 
 local tile = {}
 
+--- The tile layout layoutbox icon.
+-- @beautiful beautiful.layout_tile
+-- @param surface
+-- @see gears.surface
+
+--- The tile top layout layoutbox icon.
+-- @beautiful beautiful.layout_tiletop
+-- @param surface
+-- @see gears.surface
+
+--- The tile bottom layout layoutbox icon.
+-- @beautiful beautiful.layout_tilebottom
+-- @param surface
+-- @see gears.surface
+
+--- The tile left layout layoutbox icon.
+-- @beautiful beautiful.layout_tileleft
+-- @param surface
+-- @see gears.surface
+
 --- Jump mouse cursor to the client's corner when resizing it.
 tile.resize_jump_to_corner = true