JSON: change "key" to "name" in method parameters

Author: KrzysFR

Doxense.Core/Serialization/JSON/Interfaces/IJsonProxyNode.cs

@@ -94,14 +94,16 @@ public static JsonPath ComputePath(IJsonProxyNode? parent, in JsonPathSegment se
 }
 
 /// <summary>Returns the path to a field of this object, from the root</summary>
-/// <param name="key">Name of a field in this object</param>
-public static JsonPath ComputePath(IJsonProxyNode? parent, in JsonPathSegment segment, ReadOnlyMemory<char> key)
+/// <param name="parent">Parent of this node (or <c>null</c> if this is the top level)</param>
+/// <param name="segment">Name or index of this node in its parent</param>
+/// <param name="name">Name of a field in this object</param>
+public static JsonPath ComputePath(IJsonProxyNode? parent, in JsonPathSegment segment, ReadOnlyMemory<char> name)
 {
-Contract.Debug.Requires(key.Length > 0);
+Contract.Debug.Requires(name.Length > 0);
 
 if (segment.IsEmpty())
 {
-return JsonPath.Create(new JsonPathSegment(key));
+return JsonPath.Create(new JsonPathSegment(name));
 }
 
 Span<char> scratch = stackalloc char[32];
@@ -110,7 +112,7 @@ public static JsonPath ComputePath(IJsonProxyNode? parent, in JsonPathSegment se
 {
 parent?.WritePath(ref writer);
 writer.Append(in segment);
-writer.Append(key);
+writer.Append(name);
 return writer.ToPath();
 }
 finally
@@ -120,7 +122,8 @@ public static JsonPath ComputePath(IJsonProxyNode? parent, in JsonPathSegment se
 }
 
 /// <summary>Returns the path to an item of this array, from the root</summary>
-/// <param name="node"></param>
+/// <param name="parent">Parent of this node (or <c>null</c> if this is the top level)</param>
+/// <param name="segment">Name or index of this node in its parent</param>
 /// <param name="index">Index of the item in this array</param>
 public static JsonPath ComputePath(IJsonProxyNode? parent, in JsonPathSegment segment, Index index)
 {

Doxense.Core/Serialization/JSON/Interfaces/IJsonReadOnlyProxy.cs

@@ -35,14 +35,24 @@ public interface IJsonReadOnlyProxy : IJsonSerializable, IJsonPackable, IEquatab
 /// <remarks>This value can be used to "escape" the type safety of the proxy, while still allowing for tracking of read access.</remarks>
 ObservableJsonValue Get();
 
-ObservableJsonValue Get(string key);
+/// <summary>Returns the value of the field with the specified name</summary>
+/// <remarks>This value can be used to "escape" the type safety of the proxy, while still allowing for tracking of read access.</remarks>
+ObservableJsonValue Get(string name);
 
-ObservableJsonValue Get(ReadOnlyMemory<char> key);
+/// <summary>Returns the value of the field with the specified name</summary>
+/// <remarks>This value can be used to "escape" the type safety of the proxy, while still allowing for tracking of read access.</remarks>
+ObservableJsonValue Get(ReadOnlyMemory<char> name);
 
+/// <summary>Returns the value of the element at the specified location</summary>
+/// <remarks>This value can be used to "escape" the type safety of the proxy, while still allowing for tracking of read access.</remarks>
 ObservableJsonValue Get(int index);
 
+/// <summary>Returns the value of the element at the specified location</summary>
+/// <remarks>This value can be used to "escape" the type safety of the proxy, while still allowing for tracking of read access.</remarks>
 ObservableJsonValue Get(Index index);
 
+/// <summary>Returns the value of the child at the specified path</summary>
+/// <remarks>This value can be used to "escape" the type safety of the proxy, while still allowing for tracking of read access.</remarks>
 ObservableJsonValue Get(JsonPath path);
 
 /// <summary>Returns the proxied JSON Value</summary>

Doxense.Core/Serialization/JSON/Interfaces/IJsonWritableProxy.cs

@@ -36,14 +36,29 @@ public interface IJsonWritableProxy : IJsonSerializable, IJsonPackable
 /// <remarks>This value can be used to "escape" the type safety of the proxy, while still allowing for tracking of mutations.</remarks>
 MutableJsonValue Get();
 
-MutableJsonValue Get(string key);
+/// <summary>Returns the value of the field with the specified name</summary>
+/// <param name="name">Name of the field</param>
+/// <remarks>This value can be used to "escape" the type safety of the proxy, while still allowing for tracking of mutations.</remarks>
+MutableJsonValue Get(string name);
 
-MutableJsonValue Get(ReadOnlyMemory<char> key);
+/// <summary>Returns the value of the field with the specified name</summary>
+/// <param name="name">Name of the field</param>
+/// <remarks>This value can be used to "escape" the type safety of the proxy, while still allowing for tracking of mutations.</remarks>
+MutableJsonValue Get(ReadOnlyMemory<char> name);
 
+/// <summary>Returns the value of the element at the specified location</summary>
+/// <param name="index">Index of the item</param>
+/// <remarks>This value can be used to "escape" the type safety of the proxy, while still allowing for tracking of mutations.</remarks>
 MutableJsonValue Get(int index);
 
+/// <summary>Returns the value of the element at the specified location</summary>
+/// <param name="index">Index of the item</param>
+/// <remarks>This value can be used to "escape" the type safety of the proxy, while still allowing for tracking of mutations.</remarks>
 MutableJsonValue Get(Index index);
 
+/// <summary>Returns the value of the child at the specified path</summary>
+/// <param name="path">Path to the child</param>
+/// <remarks>This value can be used to "escape" the type safety of the proxy, while still allowing for tracking of mutations.</remarks>
 MutableJsonValue Get(JsonPath path);
 
 /// <summary>Returns the proxied JSON Value</summary>