Document the world (#304)

Author: kblok

lib/PuppeteerSharp/BoundingBox.cs

@@ -3,6 +3,9 @@
 
 namespace PuppeteerSharp
 {
+    /// <summary>
+    /// Bounding box data returned by <see cref="ElementHandle.BoundingBoxAsync"/>.
+    /// </summary>
     public class BoundingBox
     {
         /// <summary>
@@ -26,6 +29,13 @@ public class BoundingBox
         /// <value>The height.</value>
         public decimal Height { get; set; }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="BoundingBox"/> class.
+        /// </summary>
+        /// <param name="x">The x coordinate.</param>
+        /// <param name="y">The y coordinate.</param>
+        /// <param name="width">Width.</param>
+        /// <param name="height">Height.</param>
         public BoundingBox(decimal x, decimal y, decimal width, decimal height)
         {
             X = x;
@@ -45,6 +55,7 @@ internal Clip ToClip()
             };
         }
 
+        /// <inheritdoc/>
         public override bool Equals(object obj)
         {
             if (obj == null && GetType() != obj.GetType())
@@ -60,6 +71,7 @@ public override bool Equals(object obj)
                boundingBox.Width == Width;
         }
 
+        /// <inheritdoc/>
         public override int GetHashCode()
             => X.GetHashCode() * 397
                 ^ Y.GetHashCode() * 397

lib/PuppeteerSharp/Browser.cs

@@ -3,6 +3,7 @@
 using System.Diagnostics;
 using System.Linq;
 using System.Threading.Tasks;
+using Microsoft.Extensions.Logging;
 using PuppeteerSharp.Helpers;
 
 namespace PuppeteerSharp
@@ -87,13 +88,13 @@ public Browser(Connection connection, IBrowserOptions options, Process process,
         /// <summary>
         /// Raised when a target is destroyed, for example when a page is closed
         /// </summary>
-        public event EventHandler<TargetChangedArgs> TargetDestroyed;        
+        public event EventHandler<TargetChangedArgs> TargetDestroyed;
 
         /// <summary>
         /// Gets the Browser websocket url
         /// </summary>
         /// <remarks>
-        /// Browser websocket endpoint which can be used as an argument to <see cref="Puppeteer.ConnectAsync(ConnectOptions)"/>.
+        /// Browser websocket endpoint which can be used as an argument to <see cref="Puppeteer.ConnectAsync(ConnectOptions, ILoggerFactory)"/>.
         /// The format is <c>ws://${host}:${port}/devtools/browser/[id]</c>
         /// You can find the <c>webSocketDebuggerUrl</c> from <c>http://${host}:${port}/json/version</c>.
         /// Learn more about the devtools protocol <see href="https://chromedevtools.github.io/devtools-protocol"/> 
@@ -102,7 +103,7 @@ public Browser(Connection connection, IBrowserOptions options, Process process,
         public string WebSocketEndpoint => Connection.Url;
 
         /// <summary>
-        /// Gets the spawned browser process. Returns <c>null</c> if the browser instance was created with <see cref="Puppeteer.ConnectAsync(ConnectOptions)"/> method.
+        /// Gets the spawned browser process. Returns <c>null</c> if the browser instance was created with <see cref="Puppeteer.ConnectAsync(ConnectOptions, ILoggerFactory)"/> method.
         /// </summary>
         public Process Process { get; }
 
@@ -155,7 +156,7 @@ public async Task<Page> NewPageAsync()
         /// <returns>Task which resolves to an array of all open pages.</returns>
         public async Task<Page[]> PagesAsync()
             => (await Task.WhenAll(Targets().Select(target => target.PageAsync()))).Where(x => x != null).ToArray();
-        
+
         /// <summary>
         /// Gets the browser's version
         /// </summary>

lib/PuppeteerSharp/CDPSession.cs

@@ -76,7 +76,7 @@ internal CDPSession(Connection connection, string targetId, string sessionId)
         /// </summary>
         public event EventHandler<TracingCompleteEventArgs> TracingComplete;
         /// <summary>
-        /// Gets or sets a value indicating whether this <see cref="T:PuppeteerSharp.CDPSession"/> is closed.
+        /// Gets or sets a value indicating whether this <see cref="CDPSession"/> is closed.
         /// </summary>
         /// <value><c>true</c> if is closed; otherwise, <c>false</c>.</value>
         public bool IsClosed { get; internal set; }
@@ -151,14 +151,14 @@ public Task DetachAsync()
         #region Private Methods
 
         /// <summary>
-        /// Releases all resource used by the <see cref="T:PuppeteerSharp.CDPSession"/> object by sending a ""Target.closeTarget"
+        /// Releases all resource used by the <see cref="CDPSession"/> object by sending a ""Target.closeTarget"
         /// using the <see cref="Connection.SendAsync(string, dynamic)"/> method.
         /// </summary>
-        /// <remarks>Call <see cref="Dispose"/> when you are finished using the <see cref="PuppeteerSharp.CDPSession"/>. The
-        /// <see cref="Dispose"/> method leaves the <see cref="PuppeteerSharp.CDPSession"/> in an unusable state.
+        /// <remarks>Call <see cref="Dispose"/> when you are finished using the <see cref="CDPSession"/>. The
+        /// <see cref="Dispose"/> method leaves the <see cref="CDPSession"/> in an unusable state.
         /// After calling <see cref="Dispose"/>, you must release all references to the
-        /// <see cref="PuppeteerSharp.CDPSession"/> so the garbage collector can reclaim the memory that the
-        /// <see cref="PuppeteerSharp.CDPSession"/> was occupying.</remarks>
+        /// <see cref="CDPSession"/> so the garbage collector can reclaim the memory that the
+        /// <see cref="CDPSession"/> was occupying.</remarks>
         public void Dispose()
         {
             Connection.SendAsync("Target.closeTarget", new Dictionary<string, object>

lib/PuppeteerSharp/ChromeProcessException.cs

@@ -2,15 +2,26 @@
 
 namespace PuppeteerSharp
 {
+    /// <summary>
+    /// Chrome process exception thrown by <see cref="Launcher"/>.
+    /// </summary>
     public class ChromeProcessException : PuppeteerException
     {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="ChromeProcessException"/> class.
+        /// </summary>
+        /// <param name="message">Message.</param>
         public ChromeProcessException(string message) : base(message)
         {
         }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="ChromeProcessException"/> class.
+        /// </summary>
+        /// <param name="message">Message.</param>
+        /// <param name="innerException">Inner exception.</param>
         public ChromeProcessException(string message, Exception innerException) : base(message, innerException)
         {
-
         }
     }
 }

lib/PuppeteerSharp/Connection.cs

@@ -73,7 +73,7 @@ internal Connection(string url, int delay, ClientWebSocket ws, ILoggerFactory lo
         /// </summary>
         public event EventHandler<MessageEventArgs> MessageReceived;
         /// <summary>
-        /// Gets or sets a value indicating whether this <see cref="PuppeteerSharp.Connection"/> is closed.
+        /// Gets or sets a value indicating whether this <see cref="Connection"/> is closed.
         /// </summary>
         /// <value><c>true</c> if is closed; otherwise, <c>false</c>.</value>
         public bool IsClosed { get; internal set; }
@@ -278,14 +278,14 @@ internal static async Task<Connection> Create(string url, int delay = 0, int kee
         }
 
         /// <summary>
-        /// Releases all resource used by the <see cref="PuppeteerSharp.Connection"/> object.
+        /// Releases all resource used by the <see cref="Connection"/> object.
         /// It will raise the <see cref="Closed"/> event and call <see cref="WebSocket.CloseAsync(WebSocketCloseStatus, string, CancellationToken)"/>.
         /// </summary>
-        /// <remarks>Call <see cref="Dispose"/> when you are finished using the <see cref="PuppeteerSharp.Connection"/>. The
-        /// <see cref="Dispose"/> method leaves the <see cref="T:PuppeteerSharp.Connection"/> in an unusable state.
+        /// <remarks>Call <see cref="Dispose"/> when you are finished using the <see cref="Connection"/>. The
+        /// <see cref="Dispose"/> method leaves the <see cref="Connection"/> in an unusable state.
         /// After calling <see cref="Dispose"/>, you must release all references to the
-        /// <see cref="PuppeteerSharp.Connection"/> so the garbage collector can reclaim the memory that the
-        /// <see cref="PuppeteerSharp.Connection"/> was occupying.</remarks>
+        /// <see cref="Connection"/> so the garbage collector can reclaim the memory that the
+        /// <see cref="Connection"/> was occupying.</remarks>
         public void Dispose()
         {
             OnClose();

lib/PuppeteerSharp/ConsoleEventArgs.cs

@@ -2,10 +2,21 @@
 
 namespace PuppeteerSharp
 {
+    /// <summary>
+    /// <see cref="Page.Console"/> data.
+    /// </summary>
     public class ConsoleEventArgs : EventArgs
     {
+        /// <summary>
+        /// Gets the message.
+        /// </summary>
+        /// <value>The message.</value>
         public ConsoleMessage Message { get; }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="ConsoleEventArgs"/> class.
+        /// </summary>
+        /// <param name="message">Message.</param>
         public ConsoleEventArgs(ConsoleMessage message) => Message = message;
     }
 }

lib/PuppeteerSharp/ConsoleMessage.cs

@@ -2,12 +2,33 @@
 
 namespace PuppeteerSharp
 {
+    /// <summary>
+    /// ConsoleMessage is part of <see cref="ConsoleEventArgs"/> used by <see cref="Page.Console"/>
+    /// </summary>
     public class ConsoleMessage
     {
+        /// <summary>
+        /// Gets the ConsoleMessage type.
+        /// </summary>
+        /// <value>ConsoleMessageType.</value>
         public ConsoleType Type { get; }
+        /// <summary>
+        /// Gets the console text.
+        /// </summary>
+        /// <value>The text.</value>
         public string Text { get; }
+        /// <summary>
+        /// Gets the arguments.
+        /// </summary>
+        /// <value>The arguments.</value>
         public IList<JSHandle> Args { get; }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="ConsoleMessage"/> class.
+        /// </summary>
+        /// <param name="type">Type.</param>
+        /// <param name="text">Text.</param>
+        /// <param name="args">Arguments.</param>
         public ConsoleMessage(ConsoleType type, string text, IList<JSHandle> args)
         {
             Type = type;

lib/PuppeteerSharp/ConsoleType.cs

@@ -1,24 +1,81 @@
 namespace PuppeteerSharp
 {
+    /// <summary>
+    /// Console type used on <see cref="ConsoleMessage"/>.
+    /// </summary>
     public enum ConsoleType
     {
+        /// <summary>
+        /// Log.
+        /// </summary>
         Log,
+        /// <summary>
+        /// Debug.
+        /// </summary>
         Debug,
+        /// <summary>
+        /// Info.
+        /// </summary>
         Info,
+        /// <summary>
+        /// Error.
+        /// </summary>
         Error,
+        /// <summary>
+        /// Warning.
+        /// </summary>
         Warning,
+        /// <summary>
+        /// Dir.
+        /// </summary>
         Dir,
+        /// <summary>
+        /// Dirxml.
+        /// </summary>
         Dirxml,
+        /// <summary>
+        /// Table.
+        /// </summary>
         Table,
+        /// <summary>
+        /// Trace.
+        /// </summary>
         Trace,
+        /// <summary>
+        /// Clear.
+        /// </summary>
         Clear,
+        /// <summary>
+        /// StartGroup.
+        /// </summary>
         StartGroup,
+        /// <summary>
+        /// StartGroupCollapsed.
+        /// </summary>
         StartGroupCollapsed,
+        /// <summary>
+        /// EndGroup.
+        /// </summary>
         EndGroup,
+        /// <summary>
+        /// Assert.
+        /// </summary>
         Assert,
+        /// <summary>
+        /// Profile.
+        /// </summary>
         Profile,
+        /// <summary>
+        /// ProfileEnd.
+        /// </summary>
         ProfileEnd,
+        /// <summary>
+        /// Count.
+        /// </summary>
         Count,
+        /// <summary>
+        /// TimeEnd.
+        /// </summary>
         TimeEnd,
     }
 }

lib/PuppeteerSharp/ContextPayload.cs

@@ -1,15 +1,14 @@
 namespace PuppeteerSharp
 {
-    public class ContextPayload
+    internal class ContextPayload
     {
-        public ContextPayload(dynamic context)
+        internal ContextPayload(dynamic context)
         {
             Id = context.id;
             AuxData = context.auxData.ToObject<ContextPayloadAuxData>();
         }
 
-        public int Id { get; internal set; }
-
-        public ContextPayloadAuxData AuxData { get; internal set; }
+        internal int Id { get; }
+        internal ContextPayloadAuxData AuxData { get; }
     }
 }

lib/PuppeteerSharp/ContextPayloadAuxData.cs

@@ -1,8 +1,12 @@
+using Newtonsoft.Json;
+
 namespace PuppeteerSharp
 {
-    public struct ContextPayloadAuxData
+    internal struct ContextPayloadAuxData
     {
-        public string FrameId { get; set; }
-        public bool IsDefault { get; set; }
+        [JsonProperty("frameId")]
+        internal string FrameId { get; set; }
+        [JsonProperty("isDefault")]
+        internal bool IsDefault { get; set; }
     }
 }