Skip to content

[Bug] .NET API bug Property Value content not render correctly in generated Markdown #10489

Open
@cary-hu

Description

@cary-hu

I have a Class with comment like this:

namespace ClassLibrary1
{
    /// <summary>
    /// This is a test class
    /// </summary>
    /// <seealso cref="System.Object"/>
    public class Class1
    {
        /// <summary>
        /// This is a test summary
        /// </summary>
        /// <value>
        /// <see langword="string"/> is test
        /// </value>
        public string TestStringProperty { get; set; }

    }
}

After build, I will got two files ClassLibrary1.dll and ClassLibrary1.xml, xml will with this content:

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>ClassLibrary1</name>
    </assembly>
    <members>
        <member name="T:ClassLibrary1.Class1">
            <summary>
            This is a test class
            </summary>
            <seealso cref="T:System.Object"/>
        </member>
        <member name="P:ClassLibrary1.Class1.TestStringProperty">
            <summary>
            This is a test summary
            </summary>
            <value>
            <see langword="string"/> is test
            </value>
        </member>
    </members>
</doc>

Expected behavior

all the content should be rendered in generated markdown page.

but, the property value is not rendered correctly:
Image

Context (please complete the following information):

  • OS: Windows

  • Docfx version: 2.78.2

  • .NET version: .NET 8.0

  • docfx.json config

{
    "metadata": [
        {
            "src": [
                {
                    "files": [
                        "*.dll"
                    ]
                }
            ],
            "dest": "./api",
            "outputFormat": "markdown"
        }
    ]
}

Metadata

Metadata

Assignees

No one assigned

    Labels

    dotnetGenerate .NET API reference docs

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions