From 4188d1df1e7075b32c5db800b32ed93c9792ae4d Mon Sep 17 00:00:00 2001
From: Aire-One <erwan.maugere@gmail.com>
Date: Sun, 20 Jun 2021 20:02:51 +0200
Subject: [PATCH] doc: Move inline usage to example files

---
 lib/awful/key.lua                             | 30 ++-----------------
 .../awful/key/constructor/declarative.lua     | 16 ++++++++++
 .../text/awful/key/constructor/default.lua    |  9 ++++++
 .../text/awful/key/constructor/keygroup.lua   | 21 +++++++++++++
 4 files changed, 49 insertions(+), 27 deletions(-)
 create mode 100644 tests/examples/text/awful/key/constructor/declarative.lua
 create mode 100644 tests/examples/text/awful/key/constructor/default.lua
 create mode 100644 tests/examples/text/awful/key/constructor/keygroup.lua

diff --git a/lib/awful/key.lua b/lib/awful/key.lua
index 0e0b9ff1..a5d49f38 100644
--- a/lib/awful/key.lua
+++ b/lib/awful/key.lua
@@ -9,42 +9,18 @@
 --
 -- This example shows how to define a basic key object:
 --
---    awful.key({ "Mod4", "Shift" }, 'a',
---      function () print("The `Mod4` + `Shift` + `a` combo is pressed") end,
---      function () print("The `Mod4` + `Shift` + `a` combo is released") end)
+-- @DOC_text_awful_key_constructor_default_EXAMPLE@
 --
 -- This example shows how to define the same basic key object with the
 -- declarative pattern:
 --
---    awful.key {
---      modifiers = { "Mod4", "Shift" },
---      key = 'a',
---      on_press = function ()
---         print("The `Mod4` + `Shift` + `a` combo is pressed")
---      end,
---      on_release = function ()
---         print("The `Mod4` + `Shift` + `a` combo is released")
---      end
---    }
+-- @DOC_text_awful_key_constructor_declarative_EXAMPLE@
 --
 -- This second example of a key definition uses the numrow keygroup. In this
 -- example, we define a key object, that select the tag to show according to
 -- the key index from the numrow.
 --
---    local show_tag_by_numrow_index = awful.key {
---      modifiers = { "Mod4" },
---      keygroup = awful.key.keygroup.NUMROW,
---      description = "only view tag",
---      group = "tag",
---      on_press = function (index)
---         local screen = awful.screen.focused()
---         local tag = screen.tags[index]
---
---         if tag then
---             tag:view_only()
---         end
---      end
---    }
+-- @DOC_text_awful_key_constructor_keygroup_EXAMPLE@
 --
 -- @author Julien Danjou &lt;julien@danjou.info&gt;
 -- @author Emmanuel Lepage Vallee &lt;elv1313@gmail.com&gt;
diff --git a/tests/examples/text/awful/key/constructor/declarative.lua b/tests/examples/text/awful/key/constructor/declarative.lua
new file mode 100644
index 00000000..9ad5e20d
--- /dev/null
+++ b/tests/examples/text/awful/key/constructor/declarative.lua
@@ -0,0 +1,16 @@
+--DOC_NO_USAGE
+
+local awful = require("awful") --DOC_HIDE
+
+    awful.key {
+        modifiers = { "Mod4", "Shift" },
+        key = 'a',
+        on_press = function ()
+            print("The `Mod4` + `Shift` + `a` combo is pressed")
+        end,
+        on_release = function ()
+            print("The `Mod4` + `Shift` + `a` combo is released")
+        end
+    }
+
+--DOC_HIDE vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80
diff --git a/tests/examples/text/awful/key/constructor/default.lua b/tests/examples/text/awful/key/constructor/default.lua
new file mode 100644
index 00000000..aafc5bc8
--- /dev/null
+++ b/tests/examples/text/awful/key/constructor/default.lua
@@ -0,0 +1,9 @@
+--DOC_NO_USAGE
+
+local awful = require("awful") --DOC_HIDE
+
+    awful.key({ "Mod4", "Shift" }, "a",
+        function () print("The `Mod4` + `Shift` + `a` combo is pressed") end,
+        function () print("The `Mod4` + `Shift` + `a` combo is released") end)
+
+--DOC_HIDE vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80
diff --git a/tests/examples/text/awful/key/constructor/keygroup.lua b/tests/examples/text/awful/key/constructor/keygroup.lua
new file mode 100644
index 00000000..0adce39c
--- /dev/null
+++ b/tests/examples/text/awful/key/constructor/keygroup.lua
@@ -0,0 +1,21 @@
+--DOC_NO_USAGE
+
+local awful = require("awful") --DOC_HIDE
+
+-- luacheck: ignore unused variable show_tag_by_numrow_index --DOC_HIDE
+    local show_tag_by_numrow_index = awful.key {
+        modifiers = { "Mod4" },
+        keygroup = awful.key.keygroup.NUMROW,
+        description = "only view tag",
+        group = "tag",
+        on_press = function (index)
+            local screen = awful.screen.focused()
+            local tag = screen.tags[index]
+
+            if tag then
+                tag:view_only()
+            end
+        end
+    }
+
+--DOC_HIDE vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80