From a0399b361a08c52a443c70c4bfaeafb43e38b6d2 Mon Sep 17 00:00:00 2001
From: Malte Rosenbjerg <rosenbjerg@users.noreply.github.com>
Date: Sun, 14 Nov 2021 01:25:04 +0100
Subject: [PATCH] Add documentation comments to NotifyOn* methods

---
 FFMpegCore/FFMpeg/FFMpegArgumentProcessor.cs | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/FFMpegCore/FFMpeg/FFMpegArgumentProcessor.cs b/FFMpegCore/FFMpeg/FFMpegArgumentProcessor.cs
index 97ea94f..68738be 100644
--- a/FFMpegCore/FFMpeg/FFMpegArgumentProcessor.cs
+++ b/FFMpegCore/FFMpeg/FFMpegArgumentProcessor.cs
@@ -29,17 +29,32 @@ internal FFMpegArgumentProcessor(FFMpegArguments ffMpegArguments)
 
         private event EventHandler<int> CancelEvent = null!; 
 
+        /// <summary>
+        /// Register action that will be invoked during the ffmpeg processing, when a progress time is output and parsed and progress percentage is calculated.
+        /// Total time is needed to calculate the percentage that has been processed of the full file.
+        /// </summary>
+        /// <param name="onPercentageProgress">Action to invoke when progress percentage is updated</param>
+        /// <param name="totalTimeSpan">The total timespan of the mediafile being processed</param>
         public FFMpegArgumentProcessor NotifyOnProgress(Action<double> onPercentageProgress, TimeSpan totalTimeSpan)
         {
             _totalTimespan = totalTimeSpan;
             _onPercentageProgress = onPercentageProgress;
             return this;
         }
+        /// <summary>
+        /// Register action that will be invoked during the ffmpeg processing, when a progress time is output and parsed
+        /// </summary>
+        /// <param name="onTimeProgress">Action that will be invoked with the parsed timestamp as argument</param>
         public FFMpegArgumentProcessor NotifyOnProgress(Action<TimeSpan> onTimeProgress)
         {
             _onTimeProgress = onTimeProgress;
             return this;
         }
+
+        /// <summary>
+        /// Register action that will be invoked during the ffmpeg processing, when a line is output
+        /// </summary>
+        /// <param name="onOutput"></param>
         public FFMpegArgumentProcessor NotifyOnOutput(Action<string, DataType> onOutput)
         {
             _onOutput = onOutput;