Updated DocC examples

maxxfrazer · Apr 12, 2023 · 40ee7fe · 40ee7fe
1 parent ced786a
commit 40ee7fe
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 1 deletion.
diff --git a/Package.swift b/Package.swift
@@ -1,4 +1,4 @@
-// swift-tools-version:5.1
+// swift-tools-version:5.5
 // The swift-tools-version declares the minimum version of Swift required to build this package.
 
 import PackageDescription

diff --git a/...sEntity/Documentation.docc/FocusEntity.md → ...cusEntity/FocusEntity.docc/FocusEntity.md b/...sEntity/Documentation.docc/FocusEntity.md → ...cusEntity/FocusEntity.docc/FocusEntity.md
@@ -9,3 +9,17 @@ FocusEntity lets you see exactly where the centre of the view will sit in the AR
 ```swift
 let focusSquare = FocusEntity(on: <#ARView#>, focus: .classic)
 ```
+
+## Topics
+
+### FocusEntity
+
+- ``FocusEntity/FocusEntity``
+- ``FocusEntityComponent``
+- ``HasFocusEntity``
+
+### Events
+
+Use the ``FocusEntityDelegate`` to catch events such as changing the plane anchor or otherwise a change of state.
+
+- ``FocusEntityDelegate``
diff --git a/Sources/FocusEntity/FocusEntity.swift b/Sources/FocusEntity/FocusEntity.swift
@@ -46,9 +46,13 @@ public extension HasFocusEntity {
 
 public protocol FocusEntityDelegate: AnyObject {
     /// Called when the FocusEntity is now in world space
+    /// *Deprecated*: use ``focusEntity(_:trackingUpdated:oldState:)-4wx6e`` instead.
+    @available(*, deprecated, message: "use focusEntity(_:trackingUpdated:oldState:) instead")
     func toTrackingState()
 
     /// Called when the FocusEntity is tracking the camera
+    /// *Deprecated*: use ``focusEntity(_:trackingUpdated:oldState:)-4wx6e`` instead.
+    @available(*, deprecated, message: "use focusEntity(_:trackingUpdated:oldState:) instead")
     func toInitializingState()
 
     /// When the tracking state of the FocusEntity updates. This will be called every update frame.