From 571cc88a3966f6e845af9babe60b1c8e9373ac9f Mon Sep 17 00:00:00 2001
From: alex6dj <alexeiagueroalba@gmail.com>
Date: Mon, 4 Oct 2021 13:05:44 -0400
Subject: [PATCH] Document PanArgument

---
 FFMpegCore/FFMpeg/Arguments/PanArgument.cs | 18 +++++++++++++++++-
 1 file changed, 17 insertions(+), 1 deletion(-)

diff --git a/FFMpegCore/FFMpeg/Arguments/PanArgument.cs b/FFMpegCore/FFMpeg/Arguments/PanArgument.cs
index 74d5699..013fbf6 100644
--- a/FFMpegCore/FFMpeg/Arguments/PanArgument.cs
+++ b/FFMpegCore/FFMpeg/Arguments/PanArgument.cs
@@ -4,13 +4,22 @@
 namespace FFMpegCore.Arguments
 {
     /// <summary>
-    /// Represents scale parameter
+    ///     Mix channels with specific gain levels.
     /// </summary>
     public class PanArgument : IAudioFilterArgument
     {
         public readonly string ChannelLayout;
         private readonly string[] _outputDefinitions;
 
+        /// <summary>
+        ///     Mix channels with specific gain levels <see href="https://ffmpeg.org/ffmpeg-filters.html#toc-pan-1"/>
+        /// </summary>
+        /// <param name="channelLayout">
+        ///     Represent the output channel layout. Like "stereo", "mono", "2.1", "5.1"
+        /// </param>
+        /// <param name="outputDefinitions">
+        ///     Output channel specification, of the form: "out_name=[gain*]in_name[(+-)[gain*]in_name...]"
+        /// </param>
         public PanArgument(string channelLayout, params string[] outputDefinitions)
         {
             if (string.IsNullOrWhiteSpace(channelLayout))
@@ -23,6 +32,13 @@ public PanArgument(string channelLayout, params string[] outputDefinitions)
             _outputDefinitions = outputDefinitions;
         }
 
+        /// <summary>
+        ///     Mix channels with specific gain levels <see href="https://ffmpeg.org/ffmpeg-filters.html#toc-pan-1"/>
+        /// </summary>
+        /// <param name="channels">Number of channels in output file</param>
+        /// <param name="outputDefinitions">
+        ///     Output channel specification, of the form: "out_name=[gain*]in_name[(+-)[gain*]in_name...]"
+        /// </param>
         public PanArgument(int channels, params string[] outputDefinitions)
         {
             if (channels <= 0) throw new ArgumentOutOfRangeException(nameof(channels));