Add support for displaying ExperimentalAttribute in API documentation #10677
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds support for displaying
ExperimentalAttribute
information in the generated API documentation, similar to how obsolete members are currently handled.Implementation Details
Preview
method inDotnetApiCatalog.ApiPage.cs
already extracted the experimental attribute information but it wasn't being displayed in the Markdown outputApiPageMarkdownTemplate.cs
to display the experimental attribute information in two places:Example Output
When a class or method is decorated with
ExperimentalAttribute
, it will show a note like:The experimental notice includes:
UrlFormat
property (if provided)Testing
Verified with a sample project containing various uses of the
ExperimentalAttribute
that the information is correctly displayed in the generated documentation.Fixes #10552.
Warning
Firewall rules blocked me from connecting to one or more addresses
I tried to connect to the following addresses, but was blocked by firewall rules:
cdn.fwupd.org
/usr/bin/fwupdmgr refresh
(dns block)crl3.digicert.com
dotnet build
(dns block)/home/REDACTED/work/_temp/ghcca-node/node/bin/node /home/REDACTED/work/_temp/copilot-developer-action-main/dist/index.js
(dns block)crl4.digicert.com
dotnet build
(dns block)dotnet.github.io
/usr/lib/dotnet/dotnet exec --runtimeconfig /home/REDACTED/work/docfx/docfx/test/Docfx.Build.Tests/bin/Debug/net8.0/Docfx.Build.Tests.runtimeconfig.json --depsfile /home/REDACTED/work/docfx/docfx/test/Docfx.Build.Tests/bin/Debug/net8.0/Docfx.Build.Tests.deps.json /home/REDACTED/work/docfx/docfx/test/Docfx.Build.Tests/bin/Debug/net8.0/testhost.dll --port 33193 --endpoint 127.0.0.1:033193 --role client --parentprocessid 4180 --telemetryoptedin false
(dns block)ocsp.digicert.com
dotnet build
(dns block)s.symcb.com
dotnet build
(dns block)s.symcd.com
dotnet build
(dns block)ts-crl.ws.symantec.com
dotnet build
(dns block)ts-ocsp.ws.symantec.com
dotnet build
(dns block)www.microsoft.com
dotnet build
(dns block)If you need me to access, download, or install something from one of these locations, you can either:
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.