Merge pull request #103 from specklesystems/jrm/update-docs

Updated SpeckleReceiver.cs
specklesystems · Sep 26, 2023 · 999e6ae · 999e6ae
2 parents 6aa92d4 + 8df96ee
commit 999e6ae
Showing 1 changed file with 15 additions and 15 deletions.
diff --git a/Packages/systems.speckle.speckle-unity/Runtime/Components/SpeckleReceiver.cs b/Packages/systems.speckle.speckle-unity/Runtime/Components/SpeckleReceiver.cs
@@ -77,20 +77,13 @@ public bool Cancel()
             return true;
         }
 
-        /// <summary>
-        /// Receive the selected <see cref="Commit"/> object, and converts ToNative as children of <paramref name="parent"/>
-        /// This function is designed to be run as a coroutine
-        /// </summary>
-        /// <example><c>
-        /// StartCoroutine(mySpeckleReceiver.ReceiveAndConvert_Routine(null);
-        /// </c></example
-        /// <param name="parent">Optional parent <see cref="Transform"/> for the created root <see cref="GameObject"/>s</param>
-        /// <param name="predicate">A filter function to allow for selectively excluding certain objects from being converted</param>
-        /// <remarks>function does not throw, instead calls <see cref="OnErrorAction"/>, and calls <see cref="OnComplete"/> upon completion</remarks>
-        /// <seealso cref="ReceiveAsync(System.Threading.CancellationToken)"/>
-        /// <seealso cref="RecursiveConverter.RecursivelyConvertToNative_Enumerable"/>
+        /// <inheritdoc cref="ReceiveAndConvert_Async"/>
+        /// <example>
+        /// This function is designed to run as a coroutine i.e.
+        /// <c>StartCoroutine(mySpeckleReceiver.ReceiveAndConvert_Routine());</c>
+        /// </example>
         public IEnumerator ReceiveAndConvert_Routine(
-            Transform? parent,
+            Transform? parent = null,
             Predicate<TraversalContext>? predicate = null
         )
         {
@@ -134,9 +127,16 @@ public IEnumerator ReceiveAndConvert_Routine(
             FinishOperation();
         }
 
-        /// <inheritdoc cref="ReceiveAndConvert_Routine"/>
+        /// <summary>
+        /// Receive the selected <see cref="Commit"/> object, and converts ToNative as children of <paramref name="parent"/>
+        /// </summary>
+        /// <param name="parent">Optional parent <see cref="Transform"/> for the created root <see cref="GameObject"/>s</param>
+        /// <param name="predicate">A filter function to allow for selectively excluding certain objects from being converted</param>
+        /// <remarks>function does not throw, instead calls <see cref="OnErrorAction"/>, and calls <see cref="OnComplete"/> upon completion</remarks>
+        /// <seealso cref="ReceiveAsync(System.Threading.CancellationToken)"/>
+        /// <seealso cref="RecursiveConverter.RecursivelyConvertToNative_Enumerable"/>
         public async void ReceiveAndConvert_Async(
-            Transform? parent,
+            Transform? parent = null,
             Predicate<TraversalContext>? predicate = null
         )
         {