Make AnnotationProvider public

UglyToad · Mar 16, 2024 · bf6c519 · bf6c519
1 parent 8163d9f
commit bf6c519
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 8 deletions.
diff --git a/src/UglyToad.PdfPig.Tests/PublicApiScannerTests.cs b/src/UglyToad.PdfPig.Tests/PublicApiScannerTests.cs
@@ -68,6 +68,7 @@ public void OnlyExposedApiIsPublic()
                 "UglyToad.PdfPig.Annotations.AnnotationFlags",
                 "UglyToad.PdfPig.Annotations.AnnotationType",
                 "UglyToad.PdfPig.Annotations.AppearanceStream",
+                "UglyToad.PdfPig.Annotations.AnnotationProvider",
                 "UglyToad.PdfPig.Annotations.QuadPointsQuadrilateral",
                 "UglyToad.PdfPig.Content.ArtifactMarkedContentElement",
                 "UglyToad.PdfPig.Content.BasePageFactory`1",

diff --git a/src/UglyToad.PdfPig/Annotations/AnnotationProvider.cs b/src/UglyToad.PdfPig/Annotations/AnnotationProvider.cs
@@ -12,16 +12,25 @@
     using Tokens;
     using Util;
 
-    internal class AnnotationProvider
+    /// <summary>
+    /// Annotation provider.
+    /// </summary>
+    public class AnnotationProvider
     {
         private readonly IPdfTokenScanner tokenScanner;
         private readonly DictionaryToken pageDictionary;
         private readonly NamedDestinations namedDestinations;
         private readonly ILog log;
         private readonly TransformationMatrix matrix;
 
-        public AnnotationProvider(IPdfTokenScanner tokenScanner, DictionaryToken pageDictionary,
-            TransformationMatrix matrix, NamedDestinations namedDestinations, ILog log)
+        /// <summary>
+        /// Create a <see cref="AnnotationProvider"/>.
+        /// </summary>
+        public AnnotationProvider(IPdfTokenScanner tokenScanner,
+            DictionaryToken pageDictionary,
+            TransformationMatrix matrix,
+            NamedDestinations namedDestinations,
+            ILog log)
         {
             this.matrix = matrix;
             this.tokenScanner = tokenScanner ?? throw new ArgumentNullException(nameof(tokenScanner));
@@ -30,6 +39,9 @@ public AnnotationProvider(IPdfTokenScanner tokenScanner, DictionaryToken pageDic
             this.log = log;
         }
 
+        /// <summary>
+        /// Get the annotations.
+        /// </summary>
         public IEnumerable<Annotation> GetAnnotations()
         {
             var lookupAnnotations = new Dictionary<IndirectReference, Annotation>();
@@ -43,7 +55,7 @@ public IEnumerable<Annotation> GetAnnotations()
             {
                 if (!DirectObjectFinder.TryGet(token, tokenScanner, out DictionaryToken annotationDictionary))
                 {
-                        continue;
+                    continue;
                 }
 
                 Annotation replyTo = null;
@@ -56,20 +68,23 @@ public IEnumerable<Annotation> GetAnnotations()
                 var type = annotationDictionary.Get<NameToken>(NameToken.Subtype, tokenScanner);
                 var annotationType = type.ToAnnotationType();
                 var action = GetAction(annotationDictionary);
-                var rectangle = matrix.Transform(annotationDictionary.Get<ArrayToken>(NameToken.Rect, tokenScanner).ToRectangle(tokenScanner));
+                var rectangle = matrix.Transform(annotationDictionary.Get<ArrayToken>(NameToken.Rect, tokenScanner)
+                    .ToRectangle(tokenScanner));
                 var contents = GetNamedString(NameToken.Contents, annotationDictionary);
                 var name = GetNamedString(NameToken.Nm, annotationDictionary);
                 // As indicated in PDF reference 8.4.1, the modified date can be anything, but is usually a date formatted according to sec. 3.8.3
                 var modifiedDate = GetNamedString(NameToken.M, annotationDictionary);
 
                 var flags = (AnnotationFlags)0;
-                if (annotationDictionary.TryGet(NameToken.F, out var flagsToken) && DirectObjectFinder.TryGet(flagsToken, tokenScanner, out NumericToken flagsNumericToken))
+                if (annotationDictionary.TryGet(NameToken.F, out var flagsToken) &&
+                    DirectObjectFinder.TryGet(flagsToken, tokenScanner, out NumericToken flagsNumericToken))
                 {
                     flags = (AnnotationFlags)flagsNumericToken.Int;
                 }
 
                 var border = AnnotationBorder.Default;
-                if (annotationDictionary.TryGet(NameToken.Border, out var borderToken) && DirectObjectFinder.TryGet(borderToken, tokenScanner, out ArrayToken borderArray)
+                if (annotationDictionary.TryGet(NameToken.Border, out var borderToken) &&
+                    DirectObjectFinder.TryGet(borderToken, tokenScanner, out ArrayToken borderArray)
                     && borderArray.Length >= 3)
                 {
                     var horizontal = borderArray.GetNumeric(0).Data;
@@ -147,7 +162,7 @@ public IEnumerable<Annotation> GetAnnotations()
                 var annotation = new Annotation(
                     annotationDictionary,
                     annotationType,
-                    rectangle, 
+                    rectangle,
                     contents,
                     name,
                     modifiedDate,