Skip to content

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

@ci-vamp

Description

@ci-vamp

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:

  • a system type (string, bool etc)
    • single or an enumerable
  • a custom type (a class i define) if it is a list / enumerable type
  • only for enumerable

comments that do not appear as description in schema:

  • a custom type (a class i define) if it is a singular property

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions