Support XML documentation comments?

[codelovercc]

Hi, Mapster is a very nice Mapper. Support XML documentation comments will be nicer, this will make happier and easier when coding with Mapster.

[andrerav]

Hi @codelovercc, Good suggestion. Pull requests are very welcome on this one :) I know there are large parts of the API that are not covered by appropriate comments.

[stormaref]

@andrerav I think you did not understand what he means by that, from my point of view he is trying to say that we should include XML comments in the destination model and you are talking about the Mapster source code @codelovercc can you explain more?

[codelovercc]

You are right :), XML comments in the destination model and also in the Mapster source code.

[stormaref]

Can you give me an example with a source and destination model?

[codelovercc]

Documentation comments https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/xmldoc/

[andrerav]

@codelovercc Can you explain exactly what it is you are missing in Mapster? I still don't understand.

[codelovercc]

Here is an example. file: https://github.com/MapsterMapper/Mapster/blob/master/src/Mapster/Interfaces/IMapper.cs

Adding XML documentation comments for IMapper

using System;
using Mapster;

// ReSharper disable once CheckNamespace
namespace MapsterMapper
{
    /// <summary>
    /// Provide basic mapping methods
    /// </summary>
    public interface IMapper
    {
        /// <summary>
        /// GET TYPE ADAPTER CONFIG
        /// </summary>
        TypeAdapterConfig Config { get; }

        /// <summary>
        /// Create a <see cref="TypeAdapterBuilder"/> from TSource type
        /// </summary>
        /// <param name="source"></param>
        /// <typeparam name="TSource"></typeparam>
        /// <returns></returns>
        TypeAdapterBuilder<TSource> From<TSource>(TSource source);

        /// <summary>
        /// Map a object to <see cref="TDestination"/>
        /// </summary>
        /// <param name="source">the object</param>
        /// <typeparam name="TDestination">Destination type</typeparam>
        /// <returns></returns>
        TDestination Map<TDestination>(object source);

        /// <summary>
        /// Map from <see cref="TSource"/> to <see cref="TDestination"/>
        /// </summary>
        /// <param name="source">The source object</param>
        /// <typeparam name="TSource">The type of source</typeparam>
        /// <typeparam name="TDestination">The type of destination</typeparam>
        /// <returns>return a instance of <see cref="TDestination"/></returns>
        TDestination Map<TSource, TDestination>(TSource source);

        TDestination Map<TSource, TDestination>(TSource source, TDestination destination);
        object Map(object source, Type sourceType, Type destinationType);
        object Map(object source, object destination, Type sourceType, Type destinationType);
    }
}

I was trying to say that the sources should have XML documentation comments.

Sorry to bother you :)