From a8a7ebe1d4e7d2747cda8cb15dd0020e874c01ce Mon Sep 17 00:00:00 2001
From: Frans de Jonge <fransdejonge@gmail.com>
Date: Tue, 15 Aug 2017 14:18:15 +0200
Subject: [PATCH] [doc] some widget docs

---
 frontend/ui/widget/horizontalgroup.lua |  7 ++++---
 frontend/ui/widget/overlapgroup.lua    |  7 ++++---
 frontend/ui/widget/textwidget.lua      | 23 +++++++++++++++++------
 frontend/ui/widget/verticalgroup.lua   |  7 ++++---
 4 files changed, 29 insertions(+), 15 deletions(-)

diff --git a/frontend/ui/widget/horizontalgroup.lua b/frontend/ui/widget/horizontalgroup.lua
index 84fc0d86c..907428fb0 100644
--- a/frontend/ui/widget/horizontalgroup.lua
+++ b/frontend/ui/widget/horizontalgroup.lua
@@ -1,8 +1,9 @@
+--[[--
+A layout widget that puts objects besides each other.
+--]]
+
 local WidgetContainer = require("ui/widget/container/widgetcontainer")
 
---[[
-A Layout widget that puts objects besides each others
---]]
 local HorizontalGroup = WidgetContainer:new{
     align = "center",
     _size = nil,
diff --git a/frontend/ui/widget/overlapgroup.lua b/frontend/ui/widget/overlapgroup.lua
index bd35362fe..b5076693b 100644
--- a/frontend/ui/widget/overlapgroup.lua
+++ b/frontend/ui/widget/overlapgroup.lua
@@ -1,8 +1,9 @@
+--[[--
+A layout widget that puts objects above each other.
+--]]
+
 local WidgetContainer = require("ui/widget/container/widgetcontainer")
 
---[[
-A Layout widget that puts objects above each other
---]]
 local OverlapGroup = WidgetContainer:new{
     _size = nil,
 }
diff --git a/frontend/ui/widget/textwidget.lua b/frontend/ui/widget/textwidget.lua
index d06b4bbde..000a1ce7a 100644
--- a/frontend/ui/widget/textwidget.lua
+++ b/frontend/ui/widget/textwidget.lua
@@ -1,12 +1,23 @@
+--[[--
+A TextWidget puts a string on a single line.
+
+Example:
+
+    UIManager:show(TextWidget:new{
+        text = "Make it so.",
+        face = Font:getFace("cfont"),
+        bold = true,
+        fgcolor = Blitbuffer.COLOR_GREY,
+    })
+
+--]]
+
+local Blitbuffer = require("ffi/blitbuffer")
+local Geom = require("ui/geometry")
+local RenderText = require("ui/rendertext")
 local Widget = require("ui/widget/widget")
 local Screen = require("device").screen
-local RenderText = require("ui/rendertext")
-local Geom = require("ui/geometry")
-local Blitbuffer = require("ffi/blitbuffer")
 
---[[
-A TextWidget puts a string on a single line
---]]
 local TextWidget = Widget:new{
     text = nil,
     face = nil,
diff --git a/frontend/ui/widget/verticalgroup.lua b/frontend/ui/widget/verticalgroup.lua
index 510c3adea..db0c5f1d4 100644
--- a/frontend/ui/widget/verticalgroup.lua
+++ b/frontend/ui/widget/verticalgroup.lua
@@ -1,8 +1,9 @@
+--[[--
+A layout widget that puts objects under each other.
+--]]
+
 local WidgetContainer = require("ui/widget/container/widgetcontainer")
 
---[[
-A Layout widget that puts objects under each other
---]]
 local VerticalGroup = WidgetContainer:new{
     align = "center",
     _size = nil,