diff --git a/Assets/Scripts/ConfigureNavBar.cs b/Assets/Scripts/ConfigureNavBar.cs
index caa2bbe..49ac50b 100644
--- a/Assets/Scripts/ConfigureNavBar.cs
+++ b/Assets/Scripts/ConfigureNavBar.cs
@@ -9,6 +9,9 @@ public class ConfigureNavBar : MonoBehaviour
private bool isVisible = false;
+ ///
+ /// Toggles the visibility of the address field in the nav bar.
+ ///
public void ToggleVisibilityMethod()
{
List canvases = endpointLoader.GetInstantiatedItems();
diff --git a/Assets/Scripts/ConfigureOrbital.cs b/Assets/Scripts/ConfigureOrbital.cs
index d80686a..38cc421 100644
--- a/Assets/Scripts/ConfigureOrbital.cs
+++ b/Assets/Scripts/ConfigureOrbital.cs
@@ -9,6 +9,9 @@ public class ConfigureOrbital : MonoBehaviour
private bool orbitalEnabled = false;
+ ///
+ /// Toggles the orbital behavior (solver) of the canvases.
+ ///
public void ToggleOrbital()
{
orbitalEnabled = !orbitalEnabled;
@@ -42,6 +45,9 @@ public class ConfigureOrbital : MonoBehaviour
}
}
+ ///
+ /// Rotates the canvases to face the user.
+ ///
public void RotateCanvasToFaceUser()
{
List canvases = endpointLoader.GetInstantiatedItems();
@@ -53,6 +59,9 @@ public class ConfigureOrbital : MonoBehaviour
}
}
+ ///
+ /// Centers the canvases in front of the user.
+ ///
public void CenterCanvasesToUser()
{
List canvases = endpointLoader.GetInstantiatedItems();
diff --git a/Assets/Scripts/ConfigurePointer.cs b/Assets/Scripts/ConfigurePointer.cs
index ed6aecc..c00378a 100644
--- a/Assets/Scripts/ConfigurePointer.cs
+++ b/Assets/Scripts/ConfigurePointer.cs
@@ -5,6 +5,9 @@ public class ConfigurePointer : MonoBehaviour
{
private bool handRayPointerEnabled = true;
+ ///
+ /// Toggles the hand ray pointer on and off.
+ ///
public void ToggleHandRayPointer()
{
if (handRayPointerEnabled)
@@ -19,12 +22,12 @@ public class ConfigurePointer : MonoBehaviour
}
}
- public void EnableHandRayPointer()
+ private void EnableHandRayPointer()
{
PointerUtils.SetHandRayPointerBehavior(PointerBehavior.AlwaysOn);
}
- public void DisableHandRayPointer()
+ private void DisableHandRayPointer()
{
PointerUtils.SetHandRayPointerBehavior(PointerBehavior.AlwaysOff);
}
diff --git a/Assets/Scripts/DialogHandler.cs b/Assets/Scripts/DialogHandler.cs
index 1c981e9..e2e4a21 100644
--- a/Assets/Scripts/DialogHandler.cs
+++ b/Assets/Scripts/DialogHandler.cs
@@ -7,6 +7,12 @@ public class DialogHandler : MonoBehaviour
[SerializeField]
private GameObject dialogPrefab;
+ ///
+ /// Opens a dialog with a title, question, and action.
+ ///
+ ///
+ ///
+ ///
public void OpenDialog(string title, string question, Action action)
{
Dialog dialog = Dialog.Open(
diff --git a/Assets/Scripts/EndpointLoader.cs b/Assets/Scripts/EndpointLoader.cs
index 93f5576..d2c9af6 100644
--- a/Assets/Scripts/EndpointLoader.cs
+++ b/Assets/Scripts/EndpointLoader.cs
@@ -79,6 +79,9 @@ public class EndpointLoader : MonoBehaviour
return cameraTransform.position + cameraTransform.TransformDirection(localOffset);
}
+ ///
+ /// Toggles the visibility of the items spawned by this script.
+ ///
public void ToggleItemsVisibility()
{
areItemsVisible = !areItemsVisible;
@@ -88,6 +91,11 @@ public class EndpointLoader : MonoBehaviour
}
}
+ ///
+ /// Returns the width of the item in world space units.
+ ///
+ ///
+ ///
public float GetItemWidth(GameObject item)
{
RectTransform rectTransform = item.GetComponent();
@@ -99,6 +107,10 @@ public class EndpointLoader : MonoBehaviour
return 0.8f;
}
+ ///
+ /// Spawns a new item with a WebView component and loads the specified URL.
+ ///
+ ///
public void SpawnItem(string url)
{
if (dynamicItem != null)
@@ -130,6 +142,10 @@ public class EndpointLoader : MonoBehaviour
}
}
+ ///
+ /// Returns a list of all items instantiated by this script.
+ ///
+ ///
public List GetInstantiatedItems()
{
return instantiatedItems;
@@ -287,12 +303,18 @@ public class EndpointLoader : MonoBehaviour
);
}
+ ///
+ /// Clears the list of available services.
+ ///
public void ClearServices()
{
availableServices.Clear();
servicesListPopulator.RemoveAllItems();
}
+ ///
+ /// Reloads the list of available services.
+ ///
public void ReloadEndpoints()
{
triedMulticast = false;
diff --git a/Assets/Scripts/MdnsService.cs b/Assets/Scripts/MdnsService.cs
index ff24c1c..c9bf4f5 100644
--- a/Assets/Scripts/MdnsService.cs
+++ b/Assets/Scripts/MdnsService.cs
@@ -5,6 +5,13 @@ public class MdnsService
public string Path { get; }
public string Host { get; }
+ ///
+ /// Represents a service discovered via mDNS.
+ ///
+ ///
+ ///
+ ///
+ ///
public MdnsService(string ipAddress, int port, string path, string host)
{
IpAddress = ipAddress;
diff --git a/Assets/Scripts/ScrollablePagination.cs b/Assets/Scripts/ScrollablePagination.cs
index 445c517..5efa50f 100644
--- a/Assets/Scripts/ScrollablePagination.cs
+++ b/Assets/Scripts/ScrollablePagination.cs
@@ -6,6 +6,10 @@ public class ScrollablePagination : MonoBehaviour
[SerializeField]
private ScrollingObjectCollection scrollView;
+ ///
+ /// Scrolls the collection by a specified amount.
+ ///
+ ///
public void ScrollByTier(int amount)
{
if (scrollView == null)
diff --git a/Assets/Scripts/ServiceDiscovery.cs b/Assets/Scripts/ServiceDiscovery.cs
index 276c8ba..8ad87ce 100644
--- a/Assets/Scripts/ServiceDiscovery.cs
+++ b/Assets/Scripts/ServiceDiscovery.cs
@@ -68,6 +68,10 @@ public class ServiceDiscovery : MonoBehaviour
return localIPs;
}
+ ///
+ /// Starts listening for mDNS service announcements.
+ ///
+ ///
public void StartListening(Action action)
{
try
diff --git a/Assets/Scripts/ServicesListPopulator.cs b/Assets/Scripts/ServicesListPopulator.cs
index a59b690..bdde2b8 100644
--- a/Assets/Scripts/ServicesListPopulator.cs
+++ b/Assets/Scripts/ServicesListPopulator.cs
@@ -20,6 +20,11 @@ public class ServicesListPopulator : MonoBehaviour
private const string apiUrlPrefix = "API URL: ";
private const string hostPrefix = "Host: ";
+ ///
+ /// Adds an item to the table from a service.
+ ///
+ ///
+ ///
public void AddItemFromService(MdnsService service, Action action)
{
GameObject itemInstance = Instantiate(dynamicItem, gridObjectCollection.transform);
@@ -47,6 +52,9 @@ public class ServicesListPopulator : MonoBehaviour
scrollView.UpdateContent();
}
+ ///
+ /// Removes all items from the table.
+ ///
public void RemoveAllItems()
{
foreach (Transform child in gridObjectCollection.transform)
@@ -59,6 +67,10 @@ public class ServicesListPopulator : MonoBehaviour
scrollView.UpdateContent();
}
+ ///
+ /// Removes an item from the table by service.
+ ///
+ ///
public void RemoveItemByService(MdnsService service)
{
string apiUrl = $"{apiUrlPrefix}http://{service.IpAddress}:{service.Port}{service.Path}";
@@ -79,6 +91,9 @@ public class ServicesListPopulator : MonoBehaviour
scrollView.UpdateContent();
}
+ ///
+ /// Toggles the visibility of the table.
+ ///
public void ToggleVisibility()
{
isVisible = !isVisible;
diff --git a/Assets/Scripts/VideoCaptureHandler.cs b/Assets/Scripts/VideoCaptureHandler.cs
index 6b27036..caf3055 100644
--- a/Assets/Scripts/VideoCaptureHandler.cs
+++ b/Assets/Scripts/VideoCaptureHandler.cs
@@ -49,6 +49,9 @@ public class VideoCaptureHandler : MonoBehaviour
}
#endif
+ ///
+ /// Starts recording a video.
+ ///
public void StartRecordingVideo()
{
#if WINDOWS_UWP && !UNITY_EDITOR
@@ -63,12 +66,18 @@ public class VideoCaptureHandler : MonoBehaviour
videoCaptureButtonInteractable.IsToggled = true;
}
+ ///
+ /// Stops recording a video.
+ ///
public void StopRecordingVideo()
{
videoCapture.StopRecordingAsync(OnStoppedRecordingVideo);
videoCaptureButtonInteractable.IsToggled = false;
}
+ ///
+ /// Toggles the recording of a video.
+ ///
public void ToggleRecordingVideo()
{
if (videoCapture == null)