- Add XML Documentation

Author: NinjaRocks

src/TurboMapper/IMapper.cs

@@ -1,7 +1,32 @@
 namespace TurboMapper
 {
+    /// <summary>
+    /// Defines methods for mapping objects and validating mappings.
+    /// </summary>
     public interface IMapper
     {
+        /// <summary>
+        /// Maps an object of type TSource to an object of type TTarget.
+        /// </summary>
+        /// <typeparam name="TSource"></typeparam>
+        /// <typeparam name="TTarget"></typeparam>
+        /// <param name="source"></param>
+        /// <returns></returns>
         TTarget Map<TSource, TTarget>(TSource source);
+        /// <summary>
+        /// Maps a collection of objects of type TSource to a collection of objects of type TDestination.
+        /// </summary>
+        /// <typeparam name="TSource"></typeparam>
+        /// <typeparam name="TDestination"></typeparam>
+        /// <param name="source"></param>
+        /// <returns></returns>
+        IEnumerable<TDestination> Map<TSource, TDestination>(IEnumerable<TSource> source);
+        /// <summary>
+        /// Validates the mapping configuration between TSource and TTarget types.
+        /// </summary>
+        /// <typeparam name="TSource"></typeparam>
+        /// <typeparam name="TTarget"></typeparam>
+        /// <returns></returns>
+        ValidationResult ValidateMapping<TSource, TTarget>();
     }
 }

src/TurboMapper/IMappingExpression.cs

@@ -3,8 +3,44 @@
 
 namespace TurboMapper
 {
+    /// <summary>
+    /// Defines a mapping expression for configuring property mappings between source and target types.
+    /// </summary>
+    /// <typeparam name="TSource"></typeparam>
+    /// <typeparam name="TTarget"></typeparam>
     public interface IMappingExpression<TSource, TTarget>
     {
+        /// <summary>
+        /// Configures a mapping for a specific member from the source type to the target type.
+        /// </summary>
+        /// <typeparam name="TValue"></typeparam>
+        /// <param name="targetMember"></param>
+        /// <param name="sourceMember"></param>
+        /// <returns></returns>
         IMappingExpression<TSource, TTarget> ForMember<TValue>(Expression<Func<TTarget, TValue>> targetMember, Expression<Func<TSource, TValue>> sourceMember);
+        /// <summary>
+        /// Ignores a specific member in the target type during the mapping process.
+        /// </summary>
+        /// <typeparam name="TValue"></typeparam>
+        /// <param name="targetMember"></param>
+        /// <returns></returns>
+        IMappingExpression<TSource, TTarget> Ignore<TValue>(Expression<Func<TTarget, TValue>> targetMember);
+        /// <summary>
+        /// Applies a condition to a specific member in the target type, determining whether it should be mapped based on the provided condition function.
+        /// </summary>
+        /// <typeparam name="TValue"></typeparam>
+        /// <param name="targetMember"></param>
+        /// <param name="condition"></param>
+        /// <returns></returns>
+        IMappingExpression<TSource, TTarget> When<TValue>(Expression<Func<TTarget, TValue>> targetMember, Func<TSource, bool> condition);
+        /// <summary>
+        /// Maps a target member using a custom transformation function that takes a source value and produces a target value.
+        /// </summary>
+        /// <typeparam name="TSourceValue"></typeparam>
+        /// <typeparam name="TTargetValue"></typeparam>
+        /// <param name="targetMember"></param>
+        /// <param name="transformFunction"></param>
+        /// <returns></returns>
+        IMappingExpression<TSource, TTarget> MapWith<TSourceValue, TTargetValue>(Expression<Func<TTarget, TTargetValue>> targetMember, Func<TSourceValue, TTargetValue> transformFunction);
     }
 }

src/TurboMapper/IMappingModule.cs

@@ -1,7 +1,14 @@
 namespace TurboMapper
 {
+    /// <summary>
+    /// Defines a module for configuring object mappings.
+    /// </summary>
     internal interface IMappingModule
     {
+        /// <summary>
+        /// Configures mappings using the provided IObjectMap instance.
+        /// </summary>
+        /// <param name="mapper"></param>
         void CreateMap(IObjectMap mapper);
     }
 }

src/TurboMapper/IObjectMap.cs

@@ -2,10 +2,32 @@
 
 namespace TurboMapper
 {
+    /// <summary>
+    /// Defines methods for configuring object mappings.
+    /// </summary>
     internal interface IObjectMap
     {
+        /// <summary>
+        /// Creates a mapping configuration between TSource and TTarget types with optional property mappings.
+        /// </summary>
+        /// <typeparam name="TSource"></typeparam>
+        /// <typeparam name="TTarget"></typeparam>
+        /// <param name="mappings"></param>
         void CreateMap<TSource, TTarget>(List<PropertyMapping> mappings = null);
-
+        /// <summary>
+        /// Creates a mapping configuration between TSource and TTarget types with specified property mappings and an option to enable default mapping for unmapped properties.
+        /// </summary>
+        /// <typeparam name="TSource"></typeparam>
+        /// <typeparam name="TTarget"></typeparam>
+        /// <param name="mappings"></param>
+        /// <param name="enableDefaultMapping"></param>
         void CreateMap<TSource, TTarget>(List<PropertyMapping> mappings, bool enableDefaultMapping);
+        /// <summary>
+        /// Registers a custom converter function to convert from TSource to TDestination types.
+        /// </summary>
+        /// <typeparam name="TSource"></typeparam>
+        /// <typeparam name="TDestination"></typeparam>
+        /// <param name="converter"></param>
+        void RegisterConverter<TSource, TDestination>(Func<TSource, TDestination> converter);
     }
 }