From 7b5ef8a15c8b1585e9ed1f26fb4cfdeee171a606 Mon Sep 17 00:00:00 2001 From: yankejustin Date: Tue, 5 May 2015 12:17:08 -0400 Subject: [PATCH] Added documentation for IconInjector Added documentation for most of the Server's IconInjector. --- Server/Core/Build/IconInjector.cs | 32 +++++++++++++++++++++++-------- 1 file changed, 24 insertions(+), 8 deletions(-) diff --git a/Server/Core/Build/IconInjector.cs b/Server/Core/Build/IconInjector.cs index 66d22c0f..5f1f3a76 100644 --- a/Server/Core/Build/IconInjector.cs +++ b/Server/Core/Build/IconInjector.cs @@ -48,21 +48,37 @@ private struct ICONDIR [StructLayout(LayoutKind.Sequential)] private struct ICONDIRENTRY { - // Width, in pixels, of the image + /// + /// The width, in pixels, of the image. + /// public byte Width; - // Height, in pixels, of the image + /// + /// The height, in pixels, of the image. + /// public byte Height; - // Number of colors in image (0 if >=8bpp) + /// + /// The number of colors in the image; (0 if >= 8bpp) + /// public byte ColorCount; - // Reserved ( must be 0) + /// + /// Reserved (must be 0). + /// public byte Reserved; - // Color Planes + /// + /// Color planes. + /// public ushort Planes; - // Bits per pixel + /// + /// Bits per pixel. + /// public ushort BitCount; - // Length in bytes of the pixel data + /// + /// The length, in bytes, of the pixel data. + /// public int BytesInRes; - // Offset in the file where the pixel data starts. + /// + /// The offset in the file where the pixel data starts. + /// public int ImageOffset; }