Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
ci-vamp opened this issue Nov 20, 2023 · 0 comments

Comments

@ci-vamp
Copy link

ci-vamp commented Nov 20, 2023

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant