Add xml doc and remove unnecessary types

NAPS2.Lib/ImportExport/AutoSaver.cs

@@ -12,13 +12,13 @@ public class AutoSaver
     private readonly DialogHelper _dialogHelper;
     private readonly OperationProgress _operationProgress;
     private readonly ISaveNotify _notify;
-    private readonly IPdfExporter _pdfExporter;
+    private readonly PdfExporter _pdfExporter;
     private readonly IOverwritePrompt _overwritePrompt;
     private readonly Naps2Config _config;
     private readonly ImageContext _imageContext;
 
     public AutoSaver(ErrorOutput errorOutput, DialogHelper dialogHelper,
-        OperationProgress operationProgress, ISaveNotify notify, IPdfExporter pdfExporter,
+        OperationProgress operationProgress, ISaveNotify notify, PdfExporter pdfExporter,
         IOverwritePrompt overwritePrompt, Naps2Config config, ImageContext imageContext)
     {
         _errorOutput = errorOutput;

NAPS2.Lib/Modules/CommonModule.cs

@@ -20,7 +20,6 @@ public class CommonModule : Module
     protected override void Load(ContainerBuilder builder)
     {
         // Export
-        builder.RegisterType<PdfExporter>().As<IPdfExporter>();
         builder.RegisterType<AutofacEmailProviderFactory>().As<IEmailProviderFactory>();
         builder.RegisterType<StubMapiWrapper>().As<IMapiWrapper>();
         builder.RegisterType<OcrRequestQueue>().AsSelf().SingleInstance();

NAPS2.Lib/Pdf/SavePdfOperation.cs

@@ -6,11 +6,11 @@ namespace NAPS2.Pdf;
 
 internal class SavePdfOperation : OperationBase
 {
-    private readonly IPdfExporter _pdfExporter;
+    private readonly PdfExporter _pdfExporter;
     private readonly IOverwritePrompt _overwritePrompt;
     private readonly IEmailProviderFactory? _emailProviderFactory;
 
-    public SavePdfOperation(IPdfExporter pdfExporter, IOverwritePrompt overwritePrompt,
+    public SavePdfOperation(PdfExporter pdfExporter, IOverwritePrompt overwritePrompt,
         IEmailProviderFactory? emailProviderFactory = null)
     {
         _pdfExporter = pdfExporter;

NAPS2.Lib/Scan/Batch/BatchScanPerformer.cs

@@ -12,14 +12,14 @@ namespace NAPS2.Scan.Batch;
 public class BatchScanPerformer : IBatchScanPerformer
 {
     private readonly IScanPerformer _scanPerformer;
-    private readonly IPdfExporter _pdfExporter;
+    private readonly PdfExporter _pdfExporter;
     private readonly IOperationFactory _operationFactory;
     private readonly IFormFactory _formFactory;
     private readonly Naps2Config _config;
     private readonly IProfileManager _profileManager;
     private readonly ThumbnailController _thumbnailController;
 
-    public BatchScanPerformer(IScanPerformer scanPerformer, IPdfExporter pdfExporter,
+    public BatchScanPerformer(IScanPerformer scanPerformer, PdfExporter pdfExporter,
         IOperationFactory operationFactory,
         IFormFactory formFactory, Naps2Config config, IProfileManager profileManager,
         ThumbnailController thumbnailController)
@@ -44,7 +44,7 @@ public class BatchScanPerformer : IBatchScanPerformer
     private class BatchState
     {
         private readonly IScanPerformer _scanPerformer;
-        private readonly IPdfExporter _pdfExporter;
+        private readonly PdfExporter _pdfExporter;
         private readonly IOperationFactory _operationFactory;
         private readonly IFormFactory _formFactory;
         private readonly Naps2Config _config;
@@ -60,7 +60,7 @@ public class BatchScanPerformer : IBatchScanPerformer
         private ScanParams _scanParams;
         private List<List<ProcessedImage>> _scans;
 
-        public BatchState(IScanPerformer scanPerformer, IPdfExporter pdfExporter, IOperationFactory operationFactory,
+        public BatchState(IScanPerformer scanPerformer, PdfExporter pdfExporter, IOperationFactory operationFactory,
             IFormFactory formFactory, Naps2Config config, IProfileManager profileManager,
             ThumbnailController thumbnailController, BatchSettings settings,
             Action<string> progressCallback, CancellationToken cancelToken, IFormBase batchForm,

NAPS2.Sdk/ImportExport/ImportParams.cs

@@ -2,6 +2,9 @@
 
 namespace NAPS2.ImportExport;
 
+/// <summary>
+/// Additional parameters for importing files (e.g. PDF password, barcode detection, thumbnail rendering).
+/// </summary>
 public class ImportParams
 {
     public ImportParams()

NAPS2.Sdk/Ocr/IOcrEngine.cs

@@ -3,6 +3,9 @@ using NAPS2.Scan;
 
 namespace NAPS2.Ocr;
 
+/// <summary>
+/// Interface for OCR (optical character recognition). See TesseractOcrEngine.
+/// </summary>
 public interface IOcrEngine
 {
     Task<OcrResult?> ProcessImage(ScanningContext scanningContext, string imagePath, OcrParams ocrParams,

NAPS2.Sdk/Ocr/OcrMode.cs

@@ -1,5 +1,8 @@
 namespace NAPS2.Ocr;
 
+/// <summary>
+/// The mode of an OCR request (fast/best), if supported by the engine.
+/// </summary>
 public enum OcrMode
 {
     Default,

NAPS2.Sdk/Ocr/TesseractOcrEngine.cs

@@ -7,6 +7,9 @@ using NAPS2.Unmanaged;
 
 namespace NAPS2.Ocr;
 
+/// <summary>
+/// OCR engine using Tesseract (https://github.com/tesseract-ocr/tesseract).
+/// </summary>
 public class TesseractOcrEngine : IOcrEngine
 {
     private readonly string _tesseractPath;

NAPS2.Sdk/Pdf/IPdfExporter.cs

@@ -1,12 +0,0 @@
-using NAPS2.Ocr;
-
-namespace NAPS2.Pdf;
-
-public interface IPdfExporter
-{
-    Task<bool> Export(string path, ICollection<ProcessedImage> images, PdfExportParams? exportParams = null,
-        OcrParams? ocrParams = null, ProgressHandler progress = default);
-
-    Task<bool> Export(Stream stream, ICollection<ProcessedImage> images, PdfExportParams? exportParams = null,
-        OcrParams? ocrParams = null, ProgressHandler progress = default);
-}

NAPS2.Sdk/Pdf/PdfCompat.cs

@@ -1,5 +1,8 @@
 namespace NAPS2.Pdf;
 
+/// <summary>
+/// Compatibility format for generating PDFs, e.g. PDF/A (https://en.wikipedia.org/wiki/PDF/A).
+/// </summary>
 public enum PdfCompat
 {
     Default,

NAPS2.Sdk/Pdf/PdfEncryption.cs

@@ -1,5 +1,8 @@
 namespace NAPS2.Pdf;
 
+/// <summary>
+/// Configuration for PDF encryption (e.g. passwords, permissions).
+/// </summary>
 public record PdfEncryption
 {
     public bool EncryptPdf { get; init; }

NAPS2.Sdk/Pdf/PdfExportParams.cs

@@ -1,5 +1,8 @@
 namespace NAPS2.Pdf;
 
+/// <summary>
+/// Additional parameters for exporting PDFs (metadata, encryption, compatibility).
+/// </summary>
 public record PdfExportParams
 {
     public PdfExportParams()

NAPS2.Sdk/Pdf/PdfExporter.cs

@@ -16,7 +16,10 @@ using PdfPage = PdfSharpCore.Pdf.PdfPage;
 
 namespace NAPS2.Pdf;
 
-public class PdfExporter : IPdfExporter
+/// <summary>
+/// Exports images to a PDF file.
+/// </summary>
+public class PdfExporter
 {
     private readonly ScanningContext _scanningContext;
     private readonly ILogger _logger;

NAPS2.Sdk/Pdf/PdfImportException.cs

@@ -1,14 +0,0 @@
-namespace NAPS2.Pdf;
-
-public class PdfImportException : Exception
-{
-    public PdfImportException(string message)
-        : base(message)
-    {
-    }
-
-    public PdfImportException(string message, Exception innerException)
-        : base(message, innerException)
-    {
-    }
-}

NAPS2.Sdk/Pdf/PdfMetadata.cs

@@ -1,5 +1,8 @@
 namespace NAPS2.Pdf;
 
+/// <summary>
+/// Represents standard PDF metadata (e.g. author, subject, title).
+/// </summary>
 public record PdfMetadata
 {
     public string Author { get; init; } = "";

NAPS2.Sdk/Pdf/PdfiumPdfExporter.cs

@@ -6,7 +6,7 @@ using NAPS2.Scan;
 namespace NAPS2.Pdf;
 
 // TODO: Experimental. Also remember that this is failing with access violations on 32-bit (see tests).
-internal class PdfiumPdfExporter : IPdfExporter
+internal class PdfiumPdfExporter
 {
     private readonly ScanningContext _scanningContext;
     private readonly ILogger _logger;