From: Jarl Gullberg <jarl.gullberg@gmail.com>
Date: Tue, 13 Jun 2017 20:49:49 +0000 (+0200)
Subject: Added more method and class comments.
X-Git-Tag: v3.0.0~96^2~9
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=cb42feef20b3c8c5299f4b7b115fc156825ae9af;p=platform%2Fcore%2Fcsapi%2Fopentk.git

Added more method and class comments.
---

diff --git a/src/OpenTK.GLWidget/OSX/OSXWindowInfoInitializer.cs b/src/OpenTK.GLWidget/OSX/OSXWindowInfoInitializer.cs
index fcf27bd..1eaec2d 100644
--- a/src/OpenTK.GLWidget/OSX/OSXWindowInfoInitializer.cs
+++ b/src/OpenTK.GLWidget/OSX/OSXWindowInfoInitializer.cs
@@ -32,6 +32,10 @@ using OpenTK.Platform;
 
 namespace OpenTK.OSX
 {
+    /// <summary>
+    /// Handler class for initializing <see cref="IWindowInfo"/> objects under the OSX platform for both GTK2 and
+    /// GTK3.
+    /// </summary>
 	public static class OSXWindowInfoInitializer
 	{
 #if GTK3
@@ -40,6 +44,10 @@ namespace OpenTK.OSX
         const string OSXLibGdkName = "libgdk-quartz-2.0.0.dylib";
 #endif
 
+	    /// <summary>
+	    /// Initializes an <see cref="IWindowInfo"/> under the OSX platform.
+	    /// </summary>
+	    /// <param name="gdkWindowHandle"></param>
 		public static IWindowInfo Initialize(IntPtr gdkWindowHandle)
 		{
 			IntPtr windowHandle = gdk_quartz_window_get_nswindow(gdkWindowHandle);
diff --git a/src/OpenTK.GLWidget/Win/WinWindowsInfoInitializer.cs b/src/OpenTK.GLWidget/Win/WinWindowsInfoInitializer.cs
index d1da1cb..1c80d79 100644
--- a/src/OpenTK.GLWidget/Win/WinWindowsInfoInitializer.cs
+++ b/src/OpenTK.GLWidget/Win/WinWindowsInfoInitializer.cs
@@ -32,6 +32,10 @@ using OpenTK.Platform;
 
 namespace OpenTK.Win
 {
+    /// <summary>
+    /// Handler class for initializing <see cref="IWindowInfo"/> objects under the Windows platform for both GTK2 and
+    /// GTK3.
+    /// </summary>
 	public static class WinWindowsInfoInitializer
 	{
 #if GTK3
@@ -39,6 +43,11 @@ namespace OpenTK.Win
 #else
         private const string WinLibGDKName = "libgdk-win32-2.0-0.dll";
 #endif
+
+	    /// <summary>
+	    /// Initializes an <see cref="IWindowInfo"/> under the Windows platform.
+	    /// </summary>
+	    /// <param name="gdkWindowHandle"></param>
 		public static IWindowInfo Initialize(IntPtr gdkWindowHandle)
 		{
 #if GTK3
diff --git a/src/OpenTK.GLWidget/X11/XWindowInfoInitializer.cs b/src/OpenTK.GLWidget/X11/XWindowInfoInitializer.cs
index c37bad1..21bd395 100644
--- a/src/OpenTK.GLWidget/X11/XWindowInfoInitializer.cs
+++ b/src/OpenTK.GLWidget/X11/XWindowInfoInitializer.cs
@@ -34,6 +34,9 @@ using OpenTK.Platform;
 
 namespace OpenTK.X11
 {
+    /// <summary>
+    /// Handler class for initializing <see cref="IWindowInfo"/> objects under the X11 platform for both GTK2 and GTK3.
+    /// </summary>
 	public static class XWindowInfoInitializer
 	{
 
@@ -45,6 +48,15 @@ namespace OpenTK.X11
 		private const string UnixLibX11Name = "libX11.so.6";
 		private const string UnixLibGLName = "libGL.so.1";
 
+	    /// <summary>
+	    /// Initializes an <see cref="IWindowInfo"/> under the X11 platform.
+	    /// </summary>
+	    /// <param name="mode"></param>
+	    /// <param name="displayHandle"></param>
+	    /// <param name="screenNumber"></param>
+	    /// <param name="gdkWindowHandle"></param>
+	    /// <param name="gdkRootWindowHandle"></param>
+	    /// <returns></returns>
 		public static IWindowInfo Initialize(GraphicsMode mode, IntPtr displayHandle, int screenNumber, IntPtr gdkWindowHandle, IntPtr gdkRootWindowHandle)
 		{
 			IntPtr display = gdk_x11_display_get_xdisplay(displayHandle);