dotnet / dotnet/docfx

Remarks section only contents Description

Open
#5,492 8 comments 0 reactions 0 assignees View on GitHub
dotnet dotnet: xml-comment extensibility
Dominant language
C#
Stars
4.4k
Forks
890
Avg merge
2h 9m
Merged PRs (30d)
11

Description

I have a XML Comments that have custom fields in a table under the remarks section, that Sandcastle and GhostDoc does not have issues with but using DocFx it removes all of the table cells but description.
How do I get DocFx to include these fields?
See XML comment and DocFx produced yml below:
```
///
/// Class ProvisionServers
///
///
/// History:
///
///
/// Developer
/// Date
/// Time
/// Developer Company
/// Developer Phone
/// Developer Email
/// Developer On
/// Description
///
///
/// **Danny McNaught
/// Thursday, January 16, 2020
/// 5:34 PM
/// My Company
/// 1-###-###-###
///
/// mailto:danny.mcnaught@xxx.com
/// mailto:danny.c.mcnaught@xxx.gov
/// mailto:sfcsarge@xxx.com
///
/// 1234567**
/// Created XML Comment
///
///
///
public class ProvisionServers : IEquatable, IComparable
```
The yml file shows that the fields and values are removed.
```
source:
remote:
path: D:/OfficeWorkspaces/XXX/RssImageX64Processor-NetCore31/RssImageX64Processor-NetCore31/ProvisionServers.cs
id: ProvisionServers
path: ProvisionServers.cs
startLine: 53
assemblies:
- RssImageX64Processor-NetCore
namespace: RssImageProcessorX64
summary: "\nClass ProvisionServers\n"
remarks: "\n

History:

\nDescriptionCreated XML Comment\n"
example: []
syntax:
content: 'public class ProvisionServers : IEquatable, IComparable'
```

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.