Add what color formats are acceptable in places it is missing in Geyser ldoc comments (#5471)

demonnic · web-flow · commit f36f27f992da · 2021-10-06T16:24:12.000-04:00
diff --git a/src/mudlet-lua/lua/geyser/GeyserGauge.lua b/src/mudlet-lua/lua/geyser/GeyserGauge.lua
@@ -142,7 +142,7 @@ function Geyser.Gauge:setAlignment(alignment)
 end
 
 --- Sets the color of the text on the gauge
--- @param color the color you want the text to be
+-- @param color the color you want the text to be. Can use color names such as "red", decho codes such as "<255,0,0>" and hex codes such as "#ff0000"
 function Geyser.Gauge:setFgColor(color)
   self.text:setFgColor(color)
 end
diff --git a/src/mudlet-lua/lua/geyser/GeyserLabel.lua b/src/mudlet-lua/lua/geyser/GeyserLabel.lua
@@ -21,7 +21,7 @@ Geyser.Label.scrollH = {}
 --- Prints a message to the window.  All parameters are optional and if not
 -- specified will use the last set value.
 -- @param message The message to print. Can contain html formatting.
--- @param color The color to use. If no color formatting is needed it is possible to use 'nocolor' which allows color formatting by using :setStyleSheet
+-- @param color The color to use. Accepts color names like "red", decho codes like "<255,0,0>", and hex codes like "#ff0000". If no color formatting is needed it is possible to use 'nocolor' which allows color formatting by using :setStyleSheet
 -- @param format A format list to use. 'c' - center, 'l' - left, 'r' - right,  'b' - bold, 'i' - italics, 'u' - underline, 's' - strikethrough,  '##' - font size.  For example, "cb18" specifies center bold 18pt font be used.  Order doesn't matter.
 function Geyser.Label:echo(message, color, format)
   message = message or self.message
@@ -71,6 +71,8 @@ function Geyser.Label:rawEcho(message)
   echo(self.name, message)
 end
 
+--- sets the color of the text on the label
+-- @param color the color you want the text to be. Can use color names such as "red", decho codes such as "<255,0,0>" and hex codes such as "#ff0000"
 function Geyser.Label:setFgColor(color)
   self:echo(nil, color, nil)
 end
diff --git a/src/mudlet-lua/lua/geyser/GeyserWindow.lua b/src/mudlet-lua/lua/geyser/GeyserWindow.lua
@@ -68,7 +68,7 @@ end
 
 --- Sets the background color of this window primitive.  If this primitive
 -- was using a shared color, then it creates a new, personal color.
--- @param r The red value, or a quoted color name, like "green".
+-- @param r The red value, or a quoted color name, like "green", or a decho color like "<0,255,0>", or hex color like "#00ff00"
 -- @param g The green value, or nil if using a name.
 -- @param b The blue value, or nil if using a name.
 function Geyser.Window:setBgColor (r, g, b)
@@ -77,7 +77,7 @@ end
 
 --- Sets the foreground color of this window primitive.  If this primitive
 -- was using a shared color, then it creates a new, personal color.
--- @param r The red value, or a quoted color name, like "green".
+-- @param r The red value, or a quoted color name, like "green", or a decho color like "<0,255,0>", or hex color like "#00ff00"
 -- @param g The green value, or nil if using a name.
 -- @param b The blue value, or nil if using a name.
 function Geyser.Window:setFgColor (r, g, b)
@@ -86,7 +86,7 @@ end
 
 --- Sets the background color and alpha.  If this primitive
 -- was using a shared color, then it creates a new, personal color.
--- @param r The red component of the color, or a named color like "green".
+-- @param r The red component of the color, or a named color like "green", or a decho color like "<0,255,0>", or hex color like "#00ff00"
 -- @param g The green component, or nil if using named colors.
 -- @param b The blue component, or nil if using named colors.
 -- @param a The alpha component. If nil, uses current alpha value.
