dotnet / dotnet/docfx

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

Open
#10,489 1 comment 0 reactions 0 assignees View on GitHub
dotnet
Dominant language
C#
Stars
4.4k
Forks
890
Avg merge
2h 11m
Merged PRs (30d)
10

Description

I have a Class with comment like this:
```csharp
namespace ClassLibrary1
{
///
/// This is a test class
///
///
public class Class1
{
///
/// This is a test summary
///
///
/// is test
///
public string TestStringProperty { get; set; }

}
}
```

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

```xml


ClassLibrary1




This is a test class





This is a test summary


is test


```

**Expected behavior**

all the content should be rendered in generated markdown page.

but, the property value is not rendered correctly:
![Image](https://github.com/user-attachments/assets/df8f7145-004f-4974-b372-da7a6c8624d7)

**Context (please complete the following information):**
- OS: Windows
- Docfx version: 2.78.2
- .NET version: .NET 8.0

- `docfx.json` config

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

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.