<see langword="null"/> in documentation comments is omitted in tooltips

bjoern · July 17, 2024, 1:20pm

Hey,

I have a documentation comment that looks like this:

/// <param name="Width">The width of the desired page. Use <see langword="null"/> if the original width should be used.</param>

But the resulting tooltip omits the null:

It works for cref.

/// <param name="BackgroundColor">Specifies the background color. Defaults to <see cref="Color4.White"/>.</param>

Tested with 6.6.

Elias · July 18, 2024, 4:36pm

Indeed. Upcoming preview contains a few fixes regarding code documentation. From git commit log:

Adds support for <inheritdoc />
Adds rudimentary support for langword and href attributes in <see /> tag (<see langword="null"/> in documentation comments is omitted in tooltips - bug - Forum)
Fixes missing code documentation for dotnet core classes (regression from 5.0)
Fixes text indentation in tooltip (we see both \n and \n\r)