Make DirectObjectFinder public

UglyToad · Jun 11, 2024 · d96ec7a · d96ec7a
1 parent 531e00e
commit d96ec7a
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 1 deletion.
diff --git a/src/UglyToad.PdfPig.Tests/PublicApiScannerTests.cs b/src/UglyToad.PdfPig.Tests/PublicApiScannerTests.cs
@@ -250,6 +250,7 @@ public void OnlyExposedApiIsPublic()
                 "UglyToad.PdfPig.Outline.Destinations.NamedDestinations",
                 "UglyToad.PdfPig.ParsingOptions",
                 "UglyToad.PdfPig.Parser.IPageContentParser",
+                "UglyToad.PdfPig.Parser.Parts.DirectObjectFinder",
                 "UglyToad.PdfPig.PdfDocument",
                 "UglyToad.PdfPig.PdfExtensions",
                 "UglyToad.PdfPig.Rendering.IPageImageRenderer",

diff --git a/src/UglyToad.PdfPig/Parser/Parts/DirectObjectFinder.cs b/src/UglyToad.PdfPig/Parser/Parts/DirectObjectFinder.cs
@@ -5,8 +5,14 @@
     using Tokenization.Scanner;
     using Tokens;
 
-    internal static class DirectObjectFinder
+    /// <summary>
+    /// Direct object finder.
+    /// </summary>
+    public static class DirectObjectFinder
     {
+        /// <summary>
+        /// Try and get the token value, using the <see cref="IPdfTokenScanner"/> if it is a <see cref="IndirectReferenceToken"/>.
+        /// </summary>
         public static bool TryGet<T>(IToken? token, IPdfTokenScanner scanner, [NotNullWhen(true)] out T? tokenResult) 
             where T : class, IToken
         {
@@ -45,6 +51,9 @@ public static bool TryGet<T>(IToken? token, IPdfTokenScanner scanner, [NotNullWh
             return false;
         }
 
+        /// <summary>
+        /// Get the token value.
+        /// </summary>
         public static T? Get<T>(IndirectReference reference, IPdfTokenScanner scanner) 
             where T : class, IToken
         {
@@ -83,6 +92,9 @@ public static bool TryGet<T>(IToken? token, IPdfTokenScanner scanner, [NotNullWh
         }
 
 #nullable disable
+        /// <summary>
+        /// Get the token value, using the <see cref="IPdfTokenScanner"/> if it is a <see cref="IndirectReferenceToken"/>.
+        /// </summary>
         public static T Get<T>(IToken token, IPdfTokenScanner scanner) where T : class, IToken
         {
             if (token is T result)