summaryrefslogtreecommitdiffstats
path: root/win/CS/HandBrakeWPF/Utilities/Input/ChapterImporterTxt.cs
diff options
context:
space:
mode:
Diffstat (limited to 'win/CS/HandBrakeWPF/Utilities/Input/ChapterImporterTxt.cs')
-rw-r--r--win/CS/HandBrakeWPF/Utilities/Input/ChapterImporterTxt.cs12
1 files changed, 12 insertions, 0 deletions
diff --git a/win/CS/HandBrakeWPF/Utilities/Input/ChapterImporterTxt.cs b/win/CS/HandBrakeWPF/Utilities/Input/ChapterImporterTxt.cs
index 678abb20a..55b24b7a1 100644
--- a/win/CS/HandBrakeWPF/Utilities/Input/ChapterImporterTxt.cs
+++ b/win/CS/HandBrakeWPF/Utilities/Input/ChapterImporterTxt.cs
@@ -10,10 +10,22 @@ namespace HandBrakeWPF.Utilities.Input
using HandBrakeWPF.Helpers;
+ /// <summary>
+ /// Imports chapter markers in the ChaptersDb.org TXT format
+ /// More info: http://www.chapterdb.org/docs
+ /// </summary>
public class ChapterImporterTxt
{
+ /// <summary>
+ /// The file filter value for the OpenFileDialog
+ /// </summary>
public static string FileFilter => "Text files (*.txt)|*.txt";
+ /// <summary>
+ /// Imports all chapter information from the given <see cref="filename"/> into the <see cref="chapterMap"/> dictionary.
+ /// </summary>
+ /// <param name="filename">The full path and filename of the chapter marker file to import</param>
+ /// <param name="chapterMap">The dictionary that should be populated with parsed chapter markers</param>
public static void Import(string filename, ref Dictionary<int, Tuple<string, TimeSpan>> chapterMap)
{
using (var file = new StreamReader(filename))