Browse Source

Adding documentation to enums.

af/merge-core
Olivia 10 years ago
parent
commit
6748909a86
  1. 2
      src/ImageSharp/Formats/Jpg/Components/MutableSpan.cs
  2. 18
      src/ImageSharp/Formats/Jpg/Components/YCbCrImage.cs
  3. 7
      src/ImageSharp/Formats/Jpg/JpegDecoderCore.cs

2
src/ImageSharp/Formats/Jpg/Components/MutableSpan.cs

@ -14,7 +14,7 @@ namespace ImageSharp.Formats
/// <see> /// <see>
/// <cref>https://github.com/dotnet/corefxlab/blob/master/src/System.Slices/System/Span.cs</cref> /// <cref>https://github.com/dotnet/corefxlab/blob/master/src/System.Slices/System/Span.cs</cref>
/// </see> /// </see>
/// <typeparam name="T"></typeparam> /// <typeparam name="T">The type of the data in the span</typeparam>
internal struct MutableSpan<T> internal struct MutableSpan<T>
{ {
/// <summary> /// <summary>

18
src/ImageSharp/Formats/Jpg/Components/YCbCrImage.cs

@ -44,16 +44,34 @@ namespace ImageSharp.Formats
/// </summary> /// </summary>
public enum YCbCrSubsampleRatio public enum YCbCrSubsampleRatio
{ {
/// <summary>
/// YCbCrSubsampleRatio444
/// </summary>
YCbCrSubsampleRatio444, YCbCrSubsampleRatio444,
/// <summary>
/// YCbCrSubsampleRatio422
/// </summary>
YCbCrSubsampleRatio422, YCbCrSubsampleRatio422,
/// <summary>
/// YCbCrSubsampleRatio420
/// </summary>
YCbCrSubsampleRatio420, YCbCrSubsampleRatio420,
/// <summary>
/// YCbCrSubsampleRatio440
/// </summary>
YCbCrSubsampleRatio440, YCbCrSubsampleRatio440,
/// <summary>
/// YCbCrSubsampleRatio411
/// </summary>
YCbCrSubsampleRatio411, YCbCrSubsampleRatio411,
/// <summary>
/// YCbCrSubsampleRatio410
/// </summary>
YCbCrSubsampleRatio410, YCbCrSubsampleRatio410,
} }

7
src/ImageSharp/Formats/Jpg/JpegDecoderCore.cs

@ -224,7 +224,14 @@ namespace ImageSharp.Formats
/// </summary> /// </summary>
internal enum ErrorCodes internal enum ErrorCodes
{ {
/// <summary>
/// NoError
/// </summary>
NoError, NoError,
/// <summary>
/// MissingFF00
/// </summary>
MissingFF00 MissingFF00
} }

Loading…
Cancel
Save