Transition doc updates.

modules/Noble.Transition/Dip.lua

@@ -12,16 +12,14 @@ transition._type = Noble.Transition.Type.COVER
 
 ---
 -- @table Noble.Transition.Dip.defaultProperties
--- @number[opt=0] holdTime
--- @tparam[opt=Ease.outInQuad] Ease ease
--- @tparam[opt=Graphics.image.kDitherTypeBayer4x4] Graphics.image.kDither dither
+-- @number[opt=0.25] holdTime
 -- @tparam Graphics.image panelImage
+-- @tparam[opt=Graphics.image.kDitherTypeBayer4x4] Graphics.image.kDither dither
+-- @tparam[opt=Ease.outInQuad] Ease ease
 -- @number[opt=0] x
 -- @number[opt=0] y
--- @see Noble.transition
--- @see Noble.Transition.setDefaultProperties
 transition.defaultProperties = {
-	holdTime = 0,
+	holdTime = 0.25,
 	ease = Ease.outInQuad,
 	dither = Graphics.image.kDitherTypeBayer4x4,
 	panelImage = nil,

modules/Noble.Transition/Imagetable.lua

@@ -12,9 +12,24 @@ transition._type = Noble.Transition.Type.COVER
 transition.easeEnter = Ease.linear
 transition.easeExit = Ease.linear
 
---- Transition properties.
--- @see Noble.transition
--- @see Noble.Transition.setDefaultProperties
+---
+-- @table Noble.Transition.Imagetable.defaultProperties
+-- @number[opt=0] holdTime
+-- @tparam Graphics.imagetable imagetable
+-- @bool[opt=false] reverse
+-- @bool[opt=false] flipX
+-- @bool[opt=false] flipY
+-- @bool[opt=false] rotate
+-- @tparam Graphics.imagetable imagetableEnter
+-- @bool[opt=nil] reverseEnter
+-- @bool[opt=nil] flipXEnter
+-- @bool[opt=nil] flipYEnter
+-- @bool[opt=nil] rotateEnter
+-- @tparam Graphics.imagetable imagetableExit
+-- @bool[opt=nil] reverseExit
+-- @bool[opt=nil] flipXExit
+-- @bool[opt=nil] flipYExit
+-- @bool[opt=nil] rotateExit
 transition.defaultProperties = {
 	holdTime = 0,
 	imagetable = nil,

modules/Noble.Transition/ImagetableMask.lua

@@ -11,9 +11,24 @@ transition._type = Noble.Transition.Type.MIX
 -- Overrides
 transition.ease = Ease.linear
 
---- Transition properties.
--- @see Noble.transition
--- @see Noble.Transition.setDefaultProperties
+---
+-- @table Noble.Transition.ImagetableMask.defaultProperties
+-- @number[opt=0] holdTime
+-- @tparam Graphics.imagetable imagetable
+-- @bool[opt=false] reverse
+-- @bool[opt=false] flipX
+-- @bool[opt=false] flipY
+-- @bool[opt=false] rotate
+-- @tparam Graphics.imagetable imagetableEnter
+-- @bool[opt=nil] reverseEnter
+-- @bool[opt=nil] flipXEnter
+-- @bool[opt=nil] flipYEnter
+-- @bool[opt=nil] rotateEnter
+-- @tparam Graphics.imagetable imagetableExit
+-- @bool[opt=nil] reverseExit
+-- @bool[opt=nil] flipXExit
+-- @bool[opt=nil] flipYExit
+-- @bool[opt=nil] rotateExit
 transition.defaultProperties = {
 	imagetable = Graphics.imagetable.new("libraries/noble/assets/images/BoltTransitionEnter"),
 	reverse = false,

modules/Noble.Transition/SlideOff.lua

@@ -8,9 +8,12 @@ transition.name = "Slide Off"
 -- Type
 transition._type = Noble.Transition.Type.MIX
 
---- Transition properties.
--- @see Noble.transition
--- @see Noble.Transition.setDefaultProperties
+---
+-- @table Noble.Transition.SlideOff.defaultProperties
+-- @tparam[opt=Ease.outInQuad] Ease ease
+-- @number[opt=0] x
+-- @number[opt=0] y
+-- @number[opt=0] rotation
 transition.defaultProperties = {
 	ease = Ease.inQuart,
 	x = 0,

modules/Noble.Transition/SlideOn.lua

@@ -13,9 +13,12 @@ transition._sequenceStartValue = 1
 transition._sequenceCompleteValue = 0
 transition._captureScreenshotsDuringTransition = true
 
---- Transition properties.
--- @see Noble.transition
--- @see Noble.Transition.setDefaultProperties
+---
+-- @table Noble.Transition.SlideOn.defaultProperties
+-- @tparam[opt=Ease.outInQuad] Ease ease
+-- @number[opt=0] x
+-- @number[opt=0] y
+-- @number[opt=0] rotation
 transition.defaultProperties = {
 	ease = Ease.outQuart,
 	x = 0,

modules/Noble.Transition/Spotlight.lua

@@ -9,23 +9,43 @@ transition.name = "Spotlight"
 -- Type
 transition._type = Noble.Transition.Type.COVER
 
---- Transition properties.
--- @see Noble.transition
--- @see Noble.Transition.setDefaultProperties
+---
+-- @table Noble.Transition.Spotlight.defaultProperties
+-- @number[opt=0.25] holdTime
+-- @tparam Graphics.image panelImage
+-- @tparam[opt=Graphics.image.kDitherTypeBayer4x4] Graphics.image.kDither dither
+-- @tparam[opt=Ease.outInQuad] Ease ease
+-- @number[opt=200] x
+-- @number[opt=120] y
+-- @tparam[opt=nil] Ease easeEnter
+-- @number[opt=nil] xEnter
+-- @number[opt=nil] yEnter
+-- @number[opt=nil] xEnterStart
+-- @number[opt=nil] yEnterStart
+-- @number[opt=nil] xEnterEnd
+-- @number[opt=nil] yEnterEnd
+-- @tparam[opt=nil] Ease easeEnter
+-- @number[opt=nil] xExit
+-- @number[opt=nil] yExit
+-- @number[opt=nil] xExitStart
+-- @number[opt=nil] yExitStart
+-- @number[opt=nil] xExitEnd
+-- @number[opt=nil] yExitEnd
 transition.defaultProperties = {
 	holdTime = 0.25,
-	easeEnter = Ease.outQuad,
-	easeExit = Ease.inQuad,
-	panelImage = nil, -- Defined as a local var below
+	panelImage = nil,
 	dither = Graphics.image.kDitherTypeBayer4x4,
+	ease = Ease.outInQuad,
 	x = 200,
 	y = 120,
+	easeEnter = nil,
 	xEnter = nil,
 	yEnter = nil,
 	xEnterStart = nil,
 	yEnterStart = nil,
 	xEnterEnd = nil,
 	yEnterEnd = nil,
+	easeExit = nil,
 	xExit = nil,
 	yExit = nil,
 	xExitStart = nil,

modules/Noble.Transition/SpotlightMask.lua

@@ -9,13 +9,18 @@ transition.name = "Spotlight Mask"
 -- Type
 transition._type = Noble.Transition.Type.MIX
 
---- Transition properties.
--- @see Noble.transition
--- @see Noble.Transition.setDefaultProperties
+---
+-- @table Noble.Transition.SpotlightMask.defaultProperties
+-- @tparam[opt=Ease.outQuad] Ease ease
+-- @number[opt=200] x
+-- @number[opt=120] y
+-- @number[opt=nil] xStart
+-- @number[opt=nil] yStart
+-- @number[opt=nil] xEnd
+-- @number[opt=nil] yEnd
+-- @bool[opt=false] invert
 transition.defaultProperties = {
 	ease = Ease.outQuad,
-	panelImage = nil, -- Defined as a local var below
-	dither = Graphics.image.kDitherTypeBayer4x4,
 	x = 200,
 	y = 120,
 	xStart = nil,