Added missing xml comments

Author: synercoder

src/Synercoding.FileFormats.Pdf/PdfInternals/Objects/IPdfObject.cs

@@ -3,9 +3,18 @@
 
 namespace Synercoding.FileFormats.Pdf.PdfInternals.Objects
 {
+    /// <summary>
+    /// Interface representing a pdf object
+    /// </summary>
     public interface IPdfObject : IStreamWriteable, IDisposable
     {
+        /// <summary>
+        /// A pdf reference object that can be used to reference to this object
+        /// </summary>
         PdfReference Reference { get; }
+        /// <summary>
+        /// Indicator to check whether this object has been written to the PDF stream
+        /// </summary>
         bool IsWritten { get; }
     }
 }

src/Synercoding.FileFormats.Pdf/PdfInternals/Objects/Image.cs

@@ -5,6 +5,9 @@
 
 namespace Synercoding.FileFormats.Pdf.PdfInternals.Objects
 {
+    /// <summary>
+    /// A class representing an image
+    /// </summary>
     public class Image : IPdfObject, IDisposable
     {
         private readonly SixLabors.ImageSharp.Image _image;
@@ -16,10 +19,13 @@ internal Image(PdfReference id, SixLabors.ImageSharp.Image image)
             _image = image;
         }
 
+        /// <inheritdoc />
         public PdfReference Reference { get; private set; }
 
+        /// <inheritdoc />
         public bool IsWritten { get; private set; }
 
+        /// <inheritdoc />
         public void Dispose()
         {
             if(!_disposed)
@@ -29,6 +35,7 @@ public void Dispose()
             }
         }
 
+        /// <inheritdoc />
         public uint WriteToStream(Stream stream)
         {
             if(_disposed)

src/Synercoding.FileFormats.Pdf/PdfInternals/PdfReference.cs

@@ -1,18 +1,36 @@
 namespace Synercoding.FileFormats.Pdf.PdfInternals
 {
-    public struct PdfReference
+    /// <summary>
+    /// A struct representing a reference
+    /// </summary>
+    public readonly struct PdfReference
     {
+        /// <summary>
+        /// Constructor for <see cref="PdfReference"/> that uses generation 0
+        /// </summary>
+        /// <param name="objectId">The id of the reference</param>
         public PdfReference(int objectId)
             : this(objectId, 0)
         { }
 
+        /// <summary>
+        /// Constructor for <see cref="PdfReference"/>
+        /// </summary>
+        /// <param name="objectId">The id of the reference</param>
+        /// <param name="generation">The generation of the reference</param>
         public PdfReference(int objectId, int generation)
         {
             ObjectId = objectId;
             Generation = generation;
         }
 
+        /// <summary>
+        /// The object id of this reference
+        /// </summary>
         public int ObjectId { get; }
+        /// <summary>
+        /// The generation of this reference
+        /// </summary>
         public int Generation { get; }
     }
 }