Tidy up documentation

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

Hide file tree

Showing 2 changed files with 12 additions and 16 deletions.
diff --git a/src/UglyToad.PdfPig/Graphics/Colors/PatternColor.cs b/src/UglyToad.PdfPig/Graphics/Colors/PatternColor.cs
@@ -245,54 +245,54 @@ public bool Equals(ShadingPatternColor? other)
     }
 
     /// <summary>
-    /// TODO
+    /// Pattern types.
     /// </summary>
     public enum PatternType : byte
     {
         /// <summary>
-        /// TODO
+        /// Tiling pattern type.
         /// </summary>
         Tiling = 1,
 
         /// <summary>
-        /// TODO
+        /// Shading pattern type.
         /// </summary>
         Shading = 2
     }
 
     /// <summary>
-    /// TODO
+    /// Pattern paint types.
     /// </summary>
     public enum PatternPaintType : byte
     {
         /// <summary>
-        /// TODO
+        /// Coloured pattern paint type.
         /// </summary>
         Coloured = 1,
 
         /// <summary>
-        /// TODO
+        /// Uncoloured pattern paint type.
         /// </summary>
         Uncoloured = 2
     }
 
     /// <summary>
-    /// TODO
+    /// Pattern tiling types.
     /// </summary>
     public enum PatternTilingType : byte
     {
         /// <summary>
-        /// TODO
+        /// Constant spacing pattern tiling type.
         /// </summary>
         ConstantSpacing = 1,
 
         /// <summary>
-        /// TODO
+        /// No distortion pattern tiling type.
         /// </summary>
         NoDistortion = 2,
 
         /// <summary>
-        /// TODO
+        /// Constant spacing faster tiling pattern tiling type.
         /// </summary>
         ConstantSpacingFasterTiling = 3
     }

diff --git a/src/UglyToad.PdfPig/PdfDocument.cs b/src/UglyToad.PdfPig/PdfDocument.cs
@@ -125,20 +125,16 @@ internal PdfDocument(
         public static PdfDocument Open(Stream stream, ParsingOptions? options = null) => PdfDocumentFactory.Open(stream, options);
 
         /// <summary>
-        /// TODO
+        /// Add a page factory.
         /// </summary>
-        /// <typeparam name="TPage"></typeparam>
-        /// <param name="pageFactory"></param>
         public void AddPageFactory<TPage>(IPageFactory<TPage> pageFactory)
         {
             pages.AddPageFactory(pageFactory);
         }
 
         /// <summary>
-        /// TODO
+        /// Add a page factory.
         /// </summary>
-        /// <typeparam name="TPage"></typeparam>
-        /// <typeparam name="TPageFactory"></typeparam>
 #if NET
         public void AddPageFactory<TPage, [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors)] TPageFactory>() where TPageFactory : IPageFactory<TPage>
 #else