[Modify] Polish it

Add some xml doc comments.
This commit is contained in:
sta 2015-10-24 14:04:07 +09:00
parent da943ed4f3
commit f2ccf9082c

View File

@ -4,7 +4,7 @@
* *
* The MIT License * The MIT License
* *
* Copyright (c) 2012-2014 sta.blockhead * Copyright (c) 2012-2015 sta.blockhead
* *
* Permission is hereby granted, free of charge, to any person obtaining a copy * Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal * of this software and associated documentation files (the "Software"), to deal
@ -30,9 +30,22 @@ using System;
namespace WebSocketSharp namespace WebSocketSharp
{ {
/// <summary>
/// Contains the values used in the RSVs (RSV1, RSV2, and RSV3) of a WebSocket frame.
/// </summary>
/// <remarks>
/// The values of this enumeration are defined in
/// <see href="http://tools.ietf.org/html/rfc6455#section-5.2">Section 5.2</see> of RFC 6455.
/// </remarks>
internal enum Rsv : byte internal enum Rsv : byte
{ {
/// <summary>
/// Equivalent to numeric value 0. Indicates zero.
/// </summary>
Off = 0x0, Off = 0x0,
/// <summary>
/// Equivalent to numeric value 1. Indicates non-zero.
/// </summary>
On = 0x1 On = 0x1
} }
} }