unchase / Unchase.Swashbuckle.AspNetCore.Extensions

:hammer: A library contains a bunch of extensions (filters) for Swashbuckle.AspNetCore.
https://www.nuget.org/packages/Unchase.Swashbuckle.AspNetCore.Extensions
Apache License 2.0
115 stars 16 forks source link

using IncludeXmlCommentsWithRemarks does not include XML docs for DTO properties #33

Open ci-vamp opened 10 months ago

ci-vamp commented 10 months ago

i have tried debugging this and cant get to the bottom of it.

i have a DTO like this for example:

using Common.Annotations;

namespace API.DTO.Training
{
    public class Example
    {

        /// <summary>
        ///     This documentation is NOT included
        /// </summary>
        public CustomClassType SingleCustomClass { get; set; }

        /// <summary>
        ///     This documentation is included
        /// </summary>
        public List<CustomClassType> EnumerableCustomClass { get; set; }

        /// <summary>
        ///     This documentation is included
        /// </summary>
        public bool SingleSystemType { get; set; }
    }
}

comments that appear as description in the schema:

comments that do not appear as description in schema:

any idea what can be causing this? i tried debugging down to the XmlCommentsWithRemarksSchemaFilter class and these properties never show up when the filter is being applied