Updated all documentation

Author: PenguinToast

config.ld

@@ -1,4 +1,4 @@
-file = "./"
+file = {"./", exclude = {"penguingui.lua"}}
 project = "PenguinGUI"
 title = "PenguinGUI Reference"
 merge = true

penguingui.lua

@@ -354,19 +354,19 @@ Binding.valueTable.__index = Binding.valueTable
 
 
 function Binding.valueTable:addValueListener(listener)
-  self:addListener("value", listener)
+  return self:addListener("value", listener)
 end
 
 function Binding.valueTable:removeValueListener(listener)
-  self:removeListener("value", listener)
+  return self:removeListener("value", listener)
 end
 
 function Binding.valueTable:addValueBinding(binding)
-  self:addBinding("value", binding)
+  return self:addBinding("value", binding)
 end
 
 function Binding.valueTable:removeValueBinding(binding)
-  self:removeBinding("value", binding)
+  return self:removeBinding("value", binding)
 end
 
 function Binding.valueTable:unbind()
@@ -476,6 +476,7 @@ function Binding.proxyTable:addListener(key, listener)
     listeners[key] = keyListeners
   end
   table.insert(keyListeners, listener)
+  return listener
 end
 
 function Binding.proxyTable:removeListener(key, listener)
@@ -496,6 +497,7 @@ function Binding.proxyTable:addBinding(key, binding)
   end
   table.insert(keyBindings, binding)
   binding:valueChanged(self[key], self[key])
+  return binding
 end
 
 function Binding.proxyTable:removeBinding(key, binding)
@@ -831,6 +833,7 @@ Binding.THEN = Binding.valueTable.THEN
 -- GUI.lua
 --------------------------------------------------------------------------------
 
+
 GUI = {
   components = {},
   mouseState = {},
@@ -932,11 +935,13 @@ Component.y = 0
 Component.width = 0
 Component.height = 0
 
+
 function Component:_init()
   self.children = {}
   self.offset = Binding.proxy({0, 0})
 end
 
+
 function Component:add(child)
   local children = self.children
   children[#children + 1] = child
@@ -1041,12 +1046,14 @@ end
 
 Panel = class(Component)
 
+
 function Panel:_init(x, y)
   Component._init(self)
   self.x = x
   self.y = y
 end
 
+
 function Panel:add(child)
   Component.add(self, child)
   self:pack()
@@ -1061,10 +1068,12 @@ Frame.borderColor = "black"
 Frame.borderThickness = 1
 Frame.backgroundColor = "#232323"
 
+
 function Frame:_init(x, y)
   Panel._init(self, x, y)
 end
 
+
 function Frame:update(dt)
   if self.dragging then
     if self.hasFocus then
@@ -1208,6 +1217,7 @@ Label.listeners = {
   }
 }
 
+
 function Label:_init(x, y, text, fontSize, fontColor)
   Component._init(self)
   fontSize = fontSize or 10
@@ -1219,6 +1229,7 @@ function Label:_init(x, y, text, fontSize, fontColor)
   self:recalculateBounds()
 end
 
+
 function Label:recalculateBounds()
   self.width = PtUtil.getStringWidth(self.text, self.fontSize)
   self.height = self.fontSize
@@ -1249,6 +1260,7 @@ TextButton.listeners = {
   }
 }
 
+
 function TextButton:_init(x, y, width, height, text, fontColor)
   Button._init(self, x, y, width, height)
   local padding = 2
@@ -1262,11 +1274,13 @@ function TextButton:_init(x, y, width, height, text, fontColor)
   self:repositionLabel()
 end
 
+
 function TextButton:repositionLabel()
   local label = self.label
   label.x = (self.width - label.width) / 2
 end
 
+
 --------------------------------------------------------------------------------
 -- TextField.lua
 --------------------------------------------------------------------------------
@@ -1283,6 +1297,7 @@ TextField.defaultTextHoverColor = "#777777"
 TextField.cursorColor = "white"
 TextField.cursorRate = 1
 
+
 function TextField:_init(x, y, width, height, defaultText)
   Component._init(self)
   self.x = x
@@ -1300,6 +1315,7 @@ function TextField:_init(x, y, width, height, defaultText)
   self.mouseOver = false
 end
 
+
 function TextField:update(dt)
   if self.hasFocus then
     local timer = self.cursorTimer
@@ -1477,12 +1493,14 @@ function TextField:keyEvent(keyCode, pressed)
   end
 end
 
+
 --------------------------------------------------------------------------------
 -- Image.lua
 --------------------------------------------------------------------------------
 
 Image = class(Component)
 
+
 function Image:_init(x, y, image, scale)
   Component._init(self)
   scale = scale or 1
@@ -1496,6 +1514,7 @@ function Image:_init(x, y, image, scale)
   self.scale = scale
 end
 
+
 function Image:draw(dt)
   local startX = self.x + self.offset[1]
   local startY = self.y + self.offset[2]
@@ -1577,9 +1596,6 @@ end
 function CheckBox:clickEvent(position, button, pressed)
   if not pressed and self.pressed then
     self.selected = not self.selected
-    if self.onSelect then
-      self:onSelect(self.selected)
-    end
   end
   self.pressed = pressed
   return true
@@ -1591,6 +1607,9 @@ end
 
 RadioButton = class(CheckBox)
 
+
+
+
 function RadioButton:drawCheck(dt)
   local startX = self.x + self.offset[1]
   local startY = self.y + self.offset[2]
@@ -1619,19 +1638,9 @@ function RadioButton:select()
   end
   if selectedButton then
     selectedButton.selected = false
-    if selectedButton.onSelect then
-      selectedButton:onSelect(false)
-    end
   end
 
-  if not self.selected then
-    self.selected = true
-    if self.onSelect then
-      self:onSelect(self.selected)
-    end
-  else
-    self.selected = true
-  end
+  self.selected = not self.selected
 end
 
 function RadioButton:setParent(parent)

penguingui/Binding.lua

@@ -1,4 +1,4 @@
---- Add listeners or bindings to objects
+--- Adds listeners or bindings to objects.
 -- @module Binding
 -- @usage -- Add a listener to print whenever a value is changed.
 -- local sometable = { a = "somevalue" }
@@ -23,7 +23,7 @@ Binding = setmetatable(
   }
 )
 
--- Proxy metatable to add listeners to a table.
+-- Proxy metatable to add listeners to a table
 Binding.proxyTable = {
   __index = function(t, k)
     local out = t._instance[k]
@@ -115,7 +115,6 @@ Binding.weakMetaTable = {
   __mode = "v"
 }
 
--- Functions available to a binding.
 Binding.valueTable = {}
 
 Binding.valueTable.__index = Binding.valueTable
@@ -125,34 +124,34 @@ Binding.valueTable.__index = Binding.valueTable
 
 --- Adds a listener to the value of this binding.
 -- @function addValueListener
---
 -- @param listener The listener to add.
+-- @return The added listener.
 function Binding.valueTable:addValueListener(listener)
-  self:addListener("value", listener)
+  return self:addListener("value", listener)
 end
 
 --- Removes a listener to the value of this binding.
 -- @function removeValueListener
--- 
 -- @param listener The listener to remove.
+-- @return Whether a listener was removed.
 function Binding.valueTable:removeValueListener(listener)
-  self:removeListener("value", listener)
+  return self:removeListener("value", listener)
 end
 
 --- Convenience method for adding a binding to "value"
 -- @function addValueBinding
---
 -- @param binding The binding to add.
+-- @return The added binding.
 function Binding.valueTable:addValueBinding(binding)
-  self:addBinding("value", binding)
+  return self:addBinding("value", binding)
 end
 
 --- Convenience method for removing a binding from "value"
 -- @function removeValueBinding
--- 
 -- @param binding The binding to remove.
+-- @return Whether a binding was removed.
 function Binding.valueTable:removeValueBinding(binding)
-  self:removeBinding("value", binding)
+  return self:removeBinding("value", binding)
 end
 
 --- Unbinds this binding, as well as anything bound to it.
@@ -258,7 +257,7 @@ function Binding.value(t, k)
   end
 end
 
---- A proxy to allow listeners & bindings to be attached
+--- A proxy to allow listeners & bindings to be attached.
 -- @type Proxy
 
 --- Adds a listener to the specified key that is called when the key's value
@@ -273,6 +272,7 @@ end
 --           old is the old value of the key.
 --           new is the new value of the key.
 --      If the function changes the key's value, it should return the new value.
+-- @return The added listener.
 function Binding.proxyTable:addListener(key, listener)
   local listeners = self.listeners
   if not listeners then
@@ -285,6 +285,7 @@ function Binding.proxyTable:addListener(key, listener)
     listeners[key] = keyListeners
   end
   table.insert(keyListeners, listener)
+  return listener
 end
 
 --- Removes the first instance of the given listener from the given key.
@@ -293,17 +294,18 @@ end
 -- @param key The key the listener is attached to.
 -- @param listener The listener to remove.
 --
--- @return A boolean for whether a listener was removed.
+-- @return Whether a listener was removed.
 function Binding.proxyTable:removeListener(key, listener)
   local keyListeners = self.listeners[key]
   return PtUtil.removeObject(keyListeners, listener) ~= -1
 end
 
 --- Adds a binding to the specified key in this table.
 -- @function addBinding
---
+-- 
 -- @param key The key to bind to.
 -- @param binding The binding to attach.
+-- @return The added binding.
 function Binding.proxyTable:addBinding(key, binding)
   local bindings = self.bindings
   if not bindings then
@@ -317,13 +319,15 @@ function Binding.proxyTable:addBinding(key, binding)
   end
   table.insert(keyBindings, binding)
   binding:valueChanged(self[key], self[key])
+  return binding
 end
 
 --- Removes a binding from a key in this table.
 -- @function removeBinding
---
+-- 
 -- @param key The key to remove a binding from.
 -- @param binding The binding to remove.
+-- @return Whether a binding was removed.
 function Binding.proxyTable:removeBinding(key, binding)
   local keyBindings = self.bindings[key]
   return PtUtil.removeObject(keyBindings, binding) ~= -1

penguingui/CheckBox.lua

@@ -2,12 +2,19 @@
 -- @classmod CheckBox
 -- @usage -- Create a checkbox that prints when it is checked
 -- local checkbox = CheckBox(0, 0, 16)
--- 
+-- checkbox:addListener("selected", function(t, k, old, new)
+--   print("The checkbox was " .. (new and "checked" or "unchecked"))
+-- end
 CheckBox = class(Component)
+--- The color of the border of this checkbox.
 CheckBox.borderColor = "#545454"
+--- The color of the checkbox.
 CheckBox.backgroundColor = "black"
+--- The color of this checkbox when the mouse is over it.
 CheckBox.hoverColor = "#1C1C1C"
+--- The color of the check.
 CheckBox.checkColor = "#C51A0B"
+--- The color of this checkbox when it is pressed.
 CheckBox.pressedColor = "#343434"
 
 --- Constructor
@@ -63,6 +70,7 @@ function CheckBox:draw(dt)
 end
 
 --- Draw the checkbox
+-- @param dt The time elapsed since the last draw.
 function CheckBox:drawCheck(dt)
   local startX = self.x + self.offset[1]
   local startY = self.y + self.offset[2]
@@ -81,9 +89,6 @@ end
 function CheckBox:clickEvent(position, button, pressed)
   if not pressed and self.pressed then
     self.selected = not self.selected
-    if self.onSelect then
-      self:onSelect(self.selected)
-    end
   end
   self.pressed = pressed
   return true