dotnet / dotnet/docfx

[Feature Request] <list type="definition"> support

Open
#10,374 7 comments 0 reactions 0 assignees View on GitHub
Dominant language
C#
Stars
4.4k
Forks
890
Avg merge
2h 9m
Merged PRs (30d)
11

Description

The **definition** list type is not a .NET standard, but widely supported since [NDoc](https://ndoc.sourceforge.net/usersguide.html) days, and I was actually surprised it was not working in DocFX.
The content is listed here for reference:
```xml


term
description


term
description

```

For the following documentation:
```csharp
///
/// Gets the numeric identifier of this code list.
///
/// A numerical value representing an ISO identifier of the code list.
///
///
/// By design, the ordinals are specified as follows:
///
///
///
/// Ordinal = 0
/// Represents an undefined or empty enumeration.
///
///
/// Ordinal >= 1
/// Represent the ISO defined enumerations of the code list.
///
///
///
public ushort Ordinal { get; }
```

The definition output is empty:

![Image](https://github.com/user-attachments/assets/04e61a33-a88b-42bd-8fb3-7af53e104657)

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.