Improve XML docs and formatting in tests and constants

Added and enhanced XML documentation comments across the codebase, including detailed summaries and parameter descriptions for methods, classes, and constants. Documented all MatroskaConstants. Improved test readability with comments and explicit variable declarations. Made minor formatting and consistency fixes in test files. No functional changes. Updated project cache and binary files to reflect documentation improvements.
This commit is contained in:
2026-02-21 15:46:18 -05:00
parent 2dc0129a11
commit e887356385
86 changed files with 385 additions and 255 deletions
@@ -76,6 +76,11 @@ public static class FfProbeKeyframeExtractor
}
}
/// <summary>
/// Parses the keyframe data from the FFProbe stream.
/// </summary>
/// <param name="reader">The stream reader containing FFProbe output.</param>
/// <returns>The parsed keyframe data.</returns>
internal static KeyframeData ParseStream(StreamReader reader)
{
var keyframes = new List<long>();
@@ -9,26 +9,88 @@ namespace Jellyfin.MediaEncoding.Keyframes.Matroska;
/// </summary>
public static class MatroskaConstants
{
/// <summary>
/// The Matroska segment container identifier.
/// </summary>
internal const ulong SegmentContainer = 0x18538067;
/// <summary>
/// The Matroska seek head identifier.
/// </summary>
internal const ulong SeekHead = 0x114D9B74;
/// <summary>
/// The Matroska seek identifier.
/// </summary>
internal const ulong Seek = 0x4DBB;
/// <summary>
/// The Matroska info identifier.
/// </summary>
internal const ulong Info = 0x1549A966;
/// <summary>
/// The Matroska timestamp scale identifier.
/// </summary>
internal const ulong TimestampScale = 0x2AD7B1;
/// <summary>
/// The Matroska duration identifier.
/// </summary>
internal const ulong Duration = 0x4489;
/// <summary>
/// The Matroska tracks identifier.
/// </summary>
internal const ulong Tracks = 0x1654AE6B;
/// <summary>
/// The Matroska track entry identifier.
/// </summary>
internal const ulong TrackEntry = 0xAE;
/// <summary>
/// The Matroska track number identifier.
/// </summary>
internal const ulong TrackNumber = 0xD7;
/// <summary>
/// The Matroska track type identifier.
/// </summary>
internal const ulong TrackType = 0x83;
/// <summary>
/// The Matroska video track type value.
/// </summary>
internal const ulong TrackTypeVideo = 0x1;
/// <summary>
/// The Matroska subtitle track type value.
/// </summary>
internal const ulong TrackTypeSubtitle = 0x11;
/// <summary>
/// The Matroska cues identifier.
/// </summary>
internal const ulong Cues = 0x1C53BB6B;
/// <summary>
/// The Matroska cue time identifier.
/// </summary>
internal const ulong CueTime = 0xB3;
/// <summary>
/// The Matroska cue point identifier.
/// </summary>
internal const ulong CuePoint = 0xBB;
/// <summary>
/// The Matroska cue track positions identifier.
/// </summary>
internal const ulong CueTrackPositions = 0xB7;
/// <summary>
/// The Matroska cue point track number identifier.
/// </summary>
internal const ulong CuePointTrackNumber = 0xF7;
}
@@ -1,6 +1,6 @@
{
"version": 2,
"dgSpecHash": "mTVFQQSIGo8=",
"dgSpecHash": "fWFpFkhudto=",
"success": true,
"projectFilePath": "E:\\Projects\\pgsql-jellyfin\\src\\Jellyfin.MediaEncoding.Keyframes\\Jellyfin.MediaEncoding.Keyframes.csproj",
"expectedPackageFiles": [