loxsmoke / mddox

Markdown documentation generator tool
MIT License
37 stars 10 forks source link

Missing summary info in markdown #7

Closed luisxkimo closed 4 years ago

luisxkimo commented 4 years ago

Hi,

I'm trying to create md documentation file, but I can't see my summary comment info in the markdown file. Here is an example:

image

image

loxsmoke commented 4 years ago

Is this the only missing summary?

Check if the compiler-generated XML file is next to the assembly you are documenting.

luisxkimo commented 4 years ago

Hi,

I could review, this is the only info that I miss.

Yes, I'm using a DLL that have in the same directory the XML document generated. Here is the content for this example:

 <member name="M:Loc.Infrastructure.Core.ActiveDirectory.UserPrincipalExtensions.ToActiveDirectoryUser(System.DirectoryServices.AccountManagement.UserPrincipal,System.Collections.Generic.IReadOnlyCollection{System.String})">
    <summary>
    Transforms a <see cref="T:System.DirectoryServices.AccountManagement.UserPrincipal"/> into an <see cref="T:Loc.Infrastructure.Core.ActiveDirectory.Model.ActiveDirectoryUser"/> object;
    </summary>
    <param name="principal">The principal to be transformed.</param>
    <param name="relevantProperties">Additional properties to be included.</param>
    <returns>A new instance of <see cref="T:Loc.Infrastructure.Core.ActiveDirectory.Model.ActiveDirectoryUser"/> with the relevant properties of the principal.</returns>
</member>
loxsmoke commented 4 years ago

Could you paste the full signature of the class and the method?

luisxkimo commented 4 years ago

Sure. Here is the signature:

        /// <summary>
        /// Transforms a <see cref="UserPrincipal"/> into an <see cref="ActiveDirectoryUser"/> object;
        /// </summary>
        /// <param name="principal">The principal to be transformed.</param>
        /// <param name="relevantProperties">Additional properties to be included.</param>
        /// <returns>A new instance of <see cref="ActiveDirectoryUser"/> with the relevant properties of the principal.</returns>
        public static ActiveDirectoryUser ToActiveDirectoryUser(this UserPrincipal principal, IReadOnlyCollection<string> relevantProperties)
        {
           //code
        }
loxsmoke commented 4 years ago

Could not reproduce the problem. Must be something environment-related.

luisxkimo commented 4 years ago

Well, we will try to test in other environments, and let you know if we find some details about our problem.

Regards