doc: Add more graph documentation.

This commit is contained in:
Emmanuel Lepage Vallee 2016-08-16 01:43:42 -04:00
parent f25621c94c
commit b6421699da
1 changed files with 9 additions and 0 deletions

View File

@ -1,6 +1,15 @@
--------------------------------------------------------------------------- ---------------------------------------------------------------------------
--- A graph widget. --- A graph widget.
-- --
-- The graph goes from left to right. To change this to right to left, use
-- a `wibox.container.mirror` widget. This can also be used to have data
-- shown from top to bottom.
--
-- To add text on top of the graph, use a `wibox.layout.stack` and a
-- `wibox.container.align` widgets.
--
-- To display the graph vertically, use a `wibox.container.rotate` widget.
--
--@DOC_wibox_widget_defaults_graph_EXAMPLE@ --@DOC_wibox_widget_defaults_graph_EXAMPLE@
-- @author Julien Danjou <julien@danjou.info> -- @author Julien Danjou <julien@danjou.info>
-- @copyright 2009 Julien Danjou -- @copyright 2009 Julien Danjou