docs: link to component lifecycle docs in descriptions of relevant me…

…thods
feathersui · Jan 13, 2025 · 006fb0c · 006fb0c
1 parent 7d15e74
commit 006fb0c
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 10 deletions.
diff --git a/src/feathers/core/FeathersControl.hx b/src/feathers/core/FeathersControl.hx
@@ -794,6 +794,7 @@ class FeathersControl extends MeasureSprite implements IUIControl implements IVa
 
 	/**
 		@see `feathers.core.IUIControl.initializeNow`
+		@see [The Feathers UI Component Lifecycle](https://feathersui.com/learn/haxe-openfl/ui-component-lifecycle/)
 	**/
 	public function initializeNow():Void {
 		if (this._initialized || this._initializing) {
@@ -838,6 +839,7 @@ class FeathersControl extends MeasureSprite implements IUIControl implements IVa
 
 	/**
 		@see `feathers.core.IUIControl.dispose`
+		@see [The Feathers UI Component Lifecycle](https://feathersui.com/learn/haxe-openfl/ui-component-lifecycle/)
 	**/
 	public function dispose():Void {
 		this.clearStyles();
@@ -866,6 +868,7 @@ class FeathersControl extends MeasureSprite implements IUIControl implements IVa
 
 		@since 1.0.0
 
+		@see [The Feathers UI Component Lifecycle](https://feathersui.com/learn/haxe-openfl/ui-component-lifecycle/)
 		@see `feathers.events.FeathersEvent.INITIALIZE`
 	**/
 	@:dox(show)

diff --git a/src/feathers/core/IUIControl.hx b/src/feathers/core/IUIControl.hx
@@ -69,6 +69,9 @@ interface IUIControl extends IDisplayObject {
 		and validate immediately, call `validateNow()` instead.
 
 		@since 1.0.0
+
+		@see `feathers.core.FeathersControl.initialize()`
+		@see [The Feathers UI Component Lifecycle](https://feathersui.com/learn/haxe-openfl/ui-component-lifecycle/)
 	**/
 	public function initializeNow():Void;
 
@@ -81,6 +84,8 @@ interface IUIControl extends IDisplayObject {
 		use cases where some extra cleanup may benefit memory usage.
 
 		@since 1.3.0
+
+		@see [The Feathers UI Component Lifecycle](https://feathersui.com/learn/haxe-openfl/ui-component-lifecycle/)
 	**/
 	public function dispose():Void;
 }
diff --git a/src/feathers/core/IValidating.hx b/src/feathers/core/IValidating.hx
@@ -34,6 +34,8 @@ interface IValidating {
 		time without requiring a full update every time.
 
 		@since 1.0.0
+
+		@see [The Feathers UI Component Lifecycle](https://feathersui.com/learn/haxe-openfl/ui-component-lifecycle/)
 	**/
 	public function validateNow():Void;
 }
diff --git a/src/feathers/core/ValidatingSprite.hx b/src/feathers/core/ValidatingSprite.hx
@@ -72,14 +72,7 @@ import openfl.events.Event;
 @:event(openfl.events.TouchEvent.TOUCH_ROLL_OVER)
 @:event(openfl.events.TouchEvent.TOUCH_TAP)
 #if air
-@:event(openfl.events.MouseEvent.CONTEXT_MENU)
-@:event(openfl.events.TouchEvent.PROXIMITY_BEGIN)
-@:event(openfl.events.TouchEvent.PROXIMITY_END)
-@:event(openfl.events.TouchEvent.PROXIMITY_MOVE)
-@:event(openfl.events.TouchEvent.PROXIMITY_OUT)
-@:event(openfl.events.TouchEvent.PROXIMITY_OVER)
-@:event(openfl.events.TouchEvent.PROXIMITY_ROLL_OUT)
-@:event(openfl.events.TouchEvent.PROXIMITY_ROLL_OVER)
+@:event(openfl.events.MouseEvent.CONTEXT_MENU) @:event(openfl.events.TouchEvent.PROXIMITY_BEGIN) @:event(openfl.events.TouchEvent.PROXIMITY_END) @:event(openfl.events.TouchEvent.PROXIMITY_MOVE) @:event(openfl.events.TouchEvent.PROXIMITY_OUT) @:event(openfl.events.TouchEvent.PROXIMITY_OVER) @:event(openfl.events.TouchEvent.PROXIMITY_ROLL_OUT) @:event(openfl.events.TouchEvent.PROXIMITY_ROLL_OVER)
 #end
 class ValidatingSprite extends Sprite implements IValidating {
 	private function new() {
@@ -134,6 +127,8 @@ class ValidatingSprite extends Sprite implements IValidating {
 		```
 
 		@since 1.0.0
+
+		@see [The Feathers UI Component Lifecycle](https://feathersui.com/learn/haxe-openfl/ui-component-lifecycle/)
 	**/
 	public function isInvalid(?flag:InvalidationFlag):Bool {
 		if (this._allInvalid) {
@@ -205,6 +200,8 @@ class ValidatingSprite extends Sprite implements IValidating {
 		```
 
 		@since 1.0.0
+
+		@see [The Feathers UI Component Lifecycle](https://feathersui.com/learn/haxe-openfl/ui-component-lifecycle/)
 	**/
 	public function setInvalid(?flag:InvalidationFlag):Void {
 		if (this._ignoreInvalidationFlags) {
@@ -273,6 +270,8 @@ class ValidatingSprite extends Sprite implements IValidating {
 
 	/**
 		@see `feathers.core.IValidating.validateNow`
+		@see `ValidatingSprite.update`
+		@see [The Feathers UI Component Lifecycle](https://feathersui.com/learn/haxe-openfl/ui-component-lifecycle/)
 	**/
 	public function validateNow():Void {
 		// if we're not actually invalid, there's nothing to do here, so
@@ -303,9 +302,10 @@ class ValidatingSprite extends Sprite implements IValidating {
 		this function during `draw()` to manipulate the flags that
 		its superclass sees.
 
-		@see `ValidatingSprite.setInvalid()`
-
 		@since 1.0.0
+
+		@see `ValidatingSprite.setInvalid()`
+		@see [The Feathers UI Component Lifecycle](https://feathersui.com/learn/haxe-openfl/ui-component-lifecycle/)
 	**/
 	@:dox(show)
 	private function setInvalidationFlag(flag:InvalidationFlag):Void {
@@ -333,6 +333,8 @@ class ValidatingSprite extends Sprite implements IValidating {
 		```
 
 		@since 1.0.0
+
+		@see [The Feathers UI Component Lifecycle](https://feathersui.com/learn/haxe-openfl/ui-component-lifecycle/)
 	**/
 	@:dox(show)
 	private function update():Void {}