added doxygen comment for GetNextItem

computablee · Sep 20, 2023 · 4bce611 · 4bce611
1 parent 6c58729
commit 4bce611
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/DotMP/Sections.cs b/DotMP/Sections.cs
@@ -17,6 +17,11 @@ internal class SectionsContainer
         /// </summary>
         private static ConcurrentBag<Action> actions_pv;
 
+        /// <summary>
+        /// Gets the next item from the actions bag.
+        /// </summary>
+        /// <param name="successful">Whether or not fetching from the bag was successful.</param>
+        /// <returns>The action pulled from the bag, if successful. If unsuccessful, undefined.</returns>
         internal Action GetNextItem(out bool successful)
         {
             Action action;