doc: fix unintentional rendering as code due to indent

This commit is contained in:
Daniel Hahler 2015-10-14 00:21:29 +02:00
parent 22f90752f7
commit 4bffa7e47e
17 changed files with 50 additions and 49 deletions

View File

@ -23,8 +23,7 @@ local object = require("gears.object")
-- value. Note that a started timer will not be garbage collected. Call `:stop` -- value. Note that a started timer will not be garbage collected. Call `:stop`
-- to enable garbage collection. -- to enable garbage collection.
-- @tfield number timeout Interval in seconds to emit the timeout signal. -- @tfield number timeout Interval in seconds to emit the timeout signal.
-- Can be any value, including floating point ones -- Can be any value, including floating point ones (e.g. 1.5 seconds).
-- (e.g. 1.5 seconds).
-- @tfield boolean started Read-only boolean field indicating if the timer has been -- @tfield boolean started Read-only boolean field indicating if the timer has been
-- started. -- started.
-- @table timer -- @table timer

View File

@ -192,17 +192,19 @@ function align:fit(context, orig_width, orig_height)
end end
--- Set the expand mode which determines how sub widgets expand to take up --- Set the expand mode which determines how sub widgets expand to take up
-- unused space. Options are: -- unused space.
-- "inside" - Default option. Size of outside widgets is determined using their --
-- fit function. Second, middle, or center widget expands to fill -- @tparam[opt=inside] string mode How to use unused space.
--
-- * "inside" - Default option. Size of outside widgets is determined using
-- their fit function. Second, middle, or center widget expands to fill
-- remaining space. -- remaining space.
-- "outside" - Center widget is sized using its fit function and placed in the -- * "outside" - Center widget is sized using its fit function and placed in
-- center of the allowed space. Outside widgets expand (or contract) -- the center of the allowed space. Outside widgets expand (or contract) to
-- to fill remaining space on their side. -- fill remaining space on their side.
-- "none" - All widgets are sized using their fit function, drawn to only the -- * "none" - All widgets are sized using their fit function, drawn to only the
-- returned space, or remaining space, whichever is smaller. Center -- returned space, or remaining space, whichever is smaller. Center widget
-- widget gets priority. -- gets priority.
-- @param mode How to use unused space. "inside" (default) "outside" or "none"
function align:set_expand(mode) function align:set_expand(mode)
if mode == "none" or mode == "outside" then if mode == "none" or mode == "outside" then
self._expand = mode self._expand = mode