Skip to content

Commit c223d93

Browse files
authored
Adds XML header docs indicating usage of options on NuCacheSerializerType (#19555)
Adds XML header docs indicating usage of options on NuCacheSerializerType.
1 parent c432f5a commit c223d93

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

src/Umbraco.Core/Configuration/Models/NuCacheSerializerType.cs

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,23 @@
44
namespace Umbraco.Cms.Core.Configuration.Models;
55

66
/// <summary>
7-
/// The serializer type that nucache uses to persist documents in the database.
7+
/// The serializer type that the published content cache uses to persist documents in the database.
88
/// </summary>
99
public enum NuCacheSerializerType
1010
{
11-
MessagePack = 1, // Default
11+
/// <summary>
12+
/// The default serializer type, which uses MessagePack for serialization.
13+
/// </summary>
14+
MessagePack = 1,
15+
16+
/// <summary>
17+
/// The legacy JSON serializer type, which uses JSON for serialization.
18+
/// </summary>
19+
/// <remarks>
20+
/// This option was provided for backward compatibility for the Umbraco cache implementation used from Umbraco 8 to 14 (NuCache).
21+
/// It is no longer supported with the cache implementation from Umbraco 15 based on .NET's Hybrid cache.
22+
/// Use the faster and more compact <see cref="MessagePack"/> instead.
23+
/// The option is kept available only for a more readable format suitable for testing purposes.
24+
/// </remarks>
1225
JSON = 2,
1326
}

0 commit comments

Comments
 (0)