From 90c4c60d2ab5d13f96320631b9b9252e452788f8 Mon Sep 17 00:00:00 2001 From: Emmanuel Lepage Vallee Date: Mon, 29 Mar 2021 00:39:46 -0700 Subject: [PATCH] Add more @supermodule and @hidden --- lib/awful/popup.lua | 1 + lib/awful/tooltip.lua | 1 + lib/awful/wibar.lua | 1 + lib/naughty/layout/box.lua | 1 + lib/wibox/layout/ratio.lua | 1 + lib/wibox/widget/imagebox.lua | 3 +++ 6 files changed, 8 insertions(+) diff --git a/lib/awful/popup.lua b/lib/awful/popup.lua index 3309fca8..22d8d76e 100644 --- a/lib/awful/popup.lua +++ b/lib/awful/popup.lua @@ -19,6 +19,7 @@ -- @author Emmanuel Lepage Vallee -- @copyright 2016 Emmanuel Lepage Vallee -- @popupmod awful.popup +-- @supermodule wibox --------------------------------------------------------------------------- local wibox = require( "wibox" ) local gtable = require( "gears.table" ) diff --git a/lib/awful/tooltip.lua b/lib/awful/tooltip.lua index 6dd7ed2e..d025fa8a 100644 --- a/lib/awful/tooltip.lua +++ b/lib/awful/tooltip.lua @@ -40,6 +40,7 @@ -- @author Sébastien Gross <seb•ɱɩɲʋʃ•awesome•ɑƬ•chezwam•ɖɵʈ•org> -- @copyright 2009 Sébastien Gross -- @popupmod awful.tooltip +-- @supermodule wibox ------------------------------------------------------------------------- local timer = require("gears.timer") diff --git a/lib/awful/wibar.lua b/lib/awful/wibar.lua index 2fea047c..6371a7a1 100644 --- a/lib/awful/wibar.lua +++ b/lib/awful/wibar.lua @@ -11,6 +11,7 @@ -- @author Emmanuel Lepage Vallee <elv1313@gmail.com> -- @copyright 2016 Emmanuel Lepage Vallee -- @popupmod awful.wibar +-- @supermodule awful.popup --------------------------------------------------------------------------- -- Grab environment we need diff --git a/lib/naughty/layout/box.lua b/lib/naughty/layout/box.lua index 7b02b276..642ac850 100644 --- a/lib/naughty/layout/box.lua +++ b/lib/naughty/layout/box.lua @@ -8,6 +8,7 @@ -- @author Emmanuel Lepage Vallee <elv1313@gmail.com> -- @copyright 2017 Emmanuel Lepage Vallee -- @popupmod naughty.layout.box +-- @supermodule awful.popup ---------------------------------------------------------------------------- local capi = {screen=screen} diff --git a/lib/wibox/layout/ratio.lua b/lib/wibox/layout/ratio.lua index 3386a90b..ba73b4b2 100644 --- a/lib/wibox/layout/ratio.lua +++ b/lib/wibox/layout/ratio.lua @@ -8,6 +8,7 @@ -- @copyright 2016 Emmanuel Lepage Vallee -- @layoutmod wibox.layout.ratio -- @supermodule wibox.layout.flex +-- @see 03-declarative-layout.md --------------------------------------------------------------------------- local base = require("wibox.widget.base" ) diff --git a/lib/wibox/widget/imagebox.lua b/lib/wibox/widget/imagebox.lua index 4ff46849..3ab42a48 100644 --- a/lib/wibox/widget/imagebox.lua +++ b/lib/wibox/widget/imagebox.lua @@ -162,6 +162,7 @@ end -- The image can be a file, a cairo image surface, or an rsvg handle object -- (see the [image property](#image)). -- @method set_image +-- @hidden -- @tparam image image The image to render. -- @treturn boolean `true` on success, `false` if the image cannot be used. -- @usage my_imagebox:set_image(beautiful.awesome_icon) @@ -225,6 +226,7 @@ end -- -- @tparam function|gears.shape clip_shape A `gears_shape` compatible shape function. -- @method set_clip_shape +-- @hidden -- @see gears.shape -- @see clip_shape function imagebox:set_clip_shape(clip_shape, ...) @@ -244,6 +246,7 @@ end -- @tparam boolean allowed If `false`, the image will be clipped, else it will -- be resized to fit into the available space. -- @method set_resize +-- @hidden function imagebox:set_resize(allowed) self._private.resize_forbidden = not allowed self:emit_signal("widget::redraw_needed")