Add more @supermodule and @hidden
This commit is contained in:
parent
bc8a5b0230
commit
90c4c60d2a
|
@ -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" )
|
||||
|
|
|
@ -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")
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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}
|
||||
|
|
|
@ -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" )
|
||||
|
|
|
@ -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")
|
||||
|
|
Loading…
Reference in New Issue