more docs for launcher (#2935)

Co-Authored-By: Aire-One <Aire-One@users.noreply.github.com>

lib/awful/widget/launcher.lua

@@ -1,4 +1,13 @@
 ---------------------------------------------------------------------------
+--  A button widget which hosts a menu or starts a command.
+--
+--  Implementation of `awful.widget.button` with the ability to host an
+--  `awful.menu` or a command to execute on user click.
+--
+-- This example is the default launcher.
+--
+--@DOC_awful_widget_launcher_default_EXAMPLE@
+--
 -- @author Julien Danjou <julien@danjou.info>
 -- @copyright 2008-2009 Julien Danjou
 -- @widgetmod awful.widget.launcher
@@ -12,10 +21,17 @@ local button = require("awful.button")
 local launcher = { mt = {} }
 
 --- Create a button widget which will launch a command.
--- @param args Standard widget table arguments, plus image for the image path
--- and command for the command to run on click, or either menu to create menu.
--- @return A launcher widget.
+---
+-- **NOTE**: You need either command or menu argument for widget to create
+-- successfully
+-- @tparam table args
+-- @tparam image args.image The image to display on the launcher button (refer to `wibox.widget.imagebox`).
+-- @tparam[opt] string args.command Command to run on user click.
+-- @tparam[opt] table args.menu Table of items to create a menu based on `awful.menu`.
+-- @treturn awful.widget.launcher A launcher widget.
 -- @constructorfct awful.widget.launcher
+-- @see wibox.widget.imagebox
+-- @see awful.menu
 function launcher.new(args)
     if not args.command and not args.menu then return end
     local w = wbutton(args)

tests/examples/awful/widget/launcher/default.lua

@@ -0,0 +1,58 @@
+--DOC_NO_USAGE --DOC_GEN_IMAGE
+local awful     = require("awful") --DOC_HIDE
+local wibox     = require("wibox") --DOC_HIDE
+local beautiful     = require("beautiful") --DOC_HIDE
+
+screen[1]._resize {width = 480, height = 100} --DOC_HIDE
+
+local wb = awful.wibar { position = "top", } --DOC_HIDE
+
+--DOC_HIDE Create the same number of tags as the default config
+awful.tag({ "1", "2", "3", "4", "5", "6", "7", "8", "9" }, screen[1], awful.layout.layouts[1]) --DOC_HIDE
+
+--DOC_HIDE Only bother with widgets that are visible by default
+local mykeyboardlayout = awful.widget.keyboardlayout() --DOC_HIDE
+local mytextclock = wibox.widget.textclock() --DOC_HIDE
+local mylayoutbox = awful.widget.layoutbox(screen[1]) --DOC_HIDE
+local mytaglist = awful.widget.taglist(screen[1], awful.widget.taglist.filter.all, {}) --DOC_HIDE
+local mytasklist = awful.widget.tasklist(screen[1], awful.widget.tasklist.filter.currenttags, {}) --DOC_HIDE
+local hotkeys_popup = nil --DOC_HIDE
+
+    myawesomemenu = {
+       { "hotkeys", function() hotkeys_popup.show_help(nil, awful.screen.focused()) end },
+       { "manual", "xterm" .. " -e man awesome" },
+       { "restart", awesome.restart },
+       { "quit", function() awesome.quit() end }
+    }
+
+    --DOC_NEWLINE
+
+    mymainmenu = awful.menu({ items = { { "awesome", myawesomemenu, beautiful.awesome_icon },
+                                        { "open terminal", "xterm"}
+                                      }
+                            })
+
+    --DOC_NEWLINE
+
+    mylauncher = awful.widget.launcher({ image = beautiful.awesome_icon,
+                                         menu = mymainmenu })
+
+    --DOC_NEWLINE
+
+    wb:setup {
+        layout = wibox.layout.align.horizontal,
+        { -- Left widgets
+            mylauncher,
+            mytaglist,
+            layout = wibox.layout.fixed.horizontal,
+        },
+        mytasklist, -- Middle widget
+        { -- Right widgets
+            layout = wibox.layout.fixed.horizontal,
+            mykeyboardlayout,
+            mytextclock,
+            mylayoutbox,
+        },
+    }
+
+--DOC_HIDE vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80