doc: Update to the newer doc conventions.
This commit is contained in:
parent
90396f33e7
commit
1b4d667b67
|
@ -6,7 +6,7 @@
|
|||
--
|
||||
-- @author Emmanuel Lepage Vallee <elv1313@gmail.com>
|
||||
-- @copyright 2019 Emmanuel Lepage Vallee
|
||||
-- @classmod naughty.action
|
||||
-- @coreclassmod naughty.action
|
||||
---------------------------------------------------------------------------
|
||||
local gtable = require("gears.table" )
|
||||
local gobject = require("gears.object")
|
||||
|
@ -101,6 +101,10 @@ for _, prop in ipairs { "name", "icon", "notification", "icon_only" } do
|
|||
end
|
||||
|
||||
--- Execute this action.
|
||||
--
|
||||
-- This only emits the `invoked` signal.
|
||||
--
|
||||
-- @method invoke
|
||||
function action:invoke()
|
||||
assert(self._private.notification,
|
||||
"Cannot invoke an action without a notification")
|
||||
|
|
|
@ -199,11 +199,11 @@ local notification = {}
|
|||
--@DOC_naughty_shape_EXAMPLE@
|
||||
--
|
||||
-- @property shape
|
||||
-- @param gears.shape
|
||||
-- @tparam gears.shape shape
|
||||
|
||||
--- Widget opacity.
|
||||
-- @property opacity
|
||||
-- @param number From 0 to 1
|
||||
-- @tparam number opacity Between 0 to 1.
|
||||
|
||||
--- Widget margin.
|
||||
--
|
||||
|
|
Loading…
Reference in New Issue