Replace TBD XML doc placeholders in Akka.Serialization (#3435) (#8121)

Co-authored-by: Aaron Stannard <aaron@aaronstannard.com>
Co-authored-by: Aaron Stannard <aaron@petabridge.com>

Author: MattKotsenas

src/core/Akka/Serialization/NewtonSoftJsonSerializer.cs

@@ -157,12 +157,12 @@ public class NewtonSoftJsonSerializer : Serializer
 
         private readonly ObjectPool<StringBuilder> _sbPool;
         /// <summary>
-        /// TBD
+        /// The <see cref="JsonSerializerSettings"/> used to configure JSON serialization and deserialization behavior.
         /// </summary>
         public JsonSerializerSettings Settings { get; }
 
         /// <summary>
-        /// TBD
+        /// The underlying <see cref="JsonSerializer"/> instance used to perform JSON conversion.
         /// </summary>
         public object Serializer { get { return _serializer; } }
 
@@ -445,15 +445,16 @@ private static object GetValue(string V)
         }
 
         /// <summary>
-        /// TBD
+        /// A custom <see cref="JsonConverter"/> that handles types implementing <see cref="ISurrogated"/>
+        /// and corrects numeric type conversions (int, float, decimal) during deserialization.
         /// </summary>
         internal class SurrogateConverter : JsonConverter
         {
             private readonly NewtonSoftJsonSerializer _parent;
             /// <summary>
-            /// TBD
+            /// Initializes a new instance of the <see cref="SurrogateConverter"/> class.
             /// </summary>
-            /// <param name="parent">TBD</param>
+            /// <param name="parent">The parent serializer that provides the actor system context for surrogate resolution.</param>
             public SurrogateConverter(NewtonSoftJsonSerializer parent)
             {
                 _parent = parent;

src/core/Akka/Serialization/Serialization.cs

@@ -167,13 +167,15 @@ public static Information GetCurrentTransportInformation()
         }
 
         /// <summary>
-        /// TBD
+        /// Executes <paramref name="action"/> while temporarily setting the
+        /// <see cref="CurrentTransportInformation"/> so that <see cref="IActorRef"/> instances
+        /// are serialized with the correct remote address.
         /// </summary>
-        /// <typeparam name="T">TBD</typeparam>
-        /// <param name="system">TBD</param>
-        /// <param name="address">TBD</param>
-        /// <param name="action">TBD</param>
-        /// <returns>TBD</returns>
+        /// <typeparam name="T">The return type of the <paramref name="action"/> delegate.</typeparam>
+        /// <param name="system">The actor system used for serialization context.</param>
+        /// <param name="address">The remote address to embed in serialized actor references.</param>
+        /// <param name="action">The delegate to execute within the transport context.</param>
+        /// <returns>The value produced by <paramref name="action"/>.</returns>
         [Obsolete("Obsolete. Use the SerializeWithTransport<T>(ExtendedActorSystem) method instead.")]
         public static T WithTransport<T>(ActorSystem system, Address address, Func<T> action)
         {
@@ -466,11 +468,12 @@ public void AddSerializer(string name, SerializerV2 serializer)
         }
 
         /// <summary>
-        /// TBD
+        /// Registers a mapping from <paramref name="type"/> to <paramref name="serializer"/>
+        /// so that instances of that type (and its subtypes) will be handled by the given serializer.
+        /// Logs a warning if an existing mapping for the same type is being overridden.
         /// </summary>
-        /// <param name="type">TBD</param>
-        /// <param name="serializer">TBD</param>
-        /// <returns>TBD</returns>
+        /// <param name="type">The <see cref="Type"/> to associate with the serializer.</param>
+        /// <param name="serializer">The <see cref="Akka.Serialization.Serializer"/> that will handle the type.</param>
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
         public void AddSerializationMap(Type type, Serializer serializer)
         {
@@ -563,9 +566,9 @@ internal SerializedPayloadMetadata Serialize(object o, IBufferWriter<byte> write
         /// <summary>
         /// Deserializes the given array of bytes using the specified serializer id, using the optional type hint to the Serializer.
         /// </summary>
-        /// <param name="bytes">TBD</param>
-        /// <param name="serializerId">TBD</param>
-        /// <param name="type">TBD</param>
+        /// <param name="bytes">The serialized byte array to deserialize.</param>
+        /// <param name="serializerId">The identifier of the serializer that produced <paramref name="bytes"/>.</param>
+        /// <param name="type">An optional type hint passed to the serializer to aid deserialization.</param>
         /// <exception cref="SerializationException">
         /// This exception is thrown if the system cannot find the serializer with the given <paramref name="serializerId"/>.
         /// </exception>
@@ -587,9 +590,9 @@ public object Deserialize(byte[] bytes, int serializerId, Type type)
         /// <summary>
         /// Deserializes the given array of bytes using the specified serializer id, using the optional type hint to the Serializer.
         /// </summary>
-        /// <param name="bytes">TBD</param>
-        /// <param name="serializerId">TBD</param>
-        /// <param name="manifest">TBD</param>
+        /// <param name="bytes">The serialized byte array to deserialize.</param>
+        /// <param name="serializerId">The identifier of the serializer that produced <paramref name="bytes"/>.</param>
+        /// <param name="manifest">A string manifest identifying the type, used by <see cref="SerializerWithStringManifest"/> implementations.</param>
         /// <exception cref="SerializationException">
         /// This exception is thrown if the system cannot find the serializer with the given <paramref name="serializerId"/>
         /// or it couldn't find the given <paramref name="manifest"/> with the given <paramref name="serializerId"/>.
@@ -672,7 +675,7 @@ internal SerializerV2 FindSerializerV2For(object obj, string defaultSerializerNa
         /// ambiguity it is primarily using the most specific configured class,
         /// and secondly the entry configured first.
         /// </summary>
-        /// <param name="objectType">TBD</param>
+        /// <param name="objectType">The <see cref="Type"/> whose serializer should be resolved.</param>
         /// <param name="defaultSerializerName">The config name of the serializer to use when no specific binding config is present</param>
         /// <exception cref="SerializationException">
         /// This exception is thrown if the serializer of the given <paramref name="objectType"/> could not be found.