System.Speech: Use intellisense xml from dotnet-api-docs #111983
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
carlossanlop
added
documentation
|
I think we should consider this as a candidate for backporting, as the documentation exists, but customers are not receiving it in released versions due to this bug. |
3 tasks
gewarren
approved these changes
Jan 30, 2025
ViktorHofer
approved these changes
Jan 30, 2025
grendello
added a commit
to grendello/runtime
that referenced
this pull request
Jan 30, 2025
* main: (31 commits) More native AOT Pri-1 test tree bring up (dotnet#111994) Fix BigInteger outerloop test (dotnet#111841) JIT: Run 3-opt once across all regions (dotnet#111989) JIT: Check for profile consistency throughout JIT backend (dotnet#111684) [JIT] Add legacy extended EVEX encoding and EVEX.ND/NF feature to x64 emitter backend (dotnet#108796) [iOS][globalization] Fix IndexOf on empty strings on iOS to return -1 (dotnet#111898) System.Speech: Use intellisense xml from dotnet-api-docs (dotnet#111983) [mono][mini] Disable inlining if we encounter class initialization failure (dotnet#111754) [main] Update dependencies from dotnet/roslyn (dotnet#111946) Update dependencies from https://github.com/dotnet/arcade build 20250129.2 (dotnet#111996) Try changing the ICustomQueryInterface implementation to always return NotHandled instead of Failed to defer back to the ComWrappers impl. (dotnet#111978) Combined dependency update (dotnet#111852) Replace OPTIMIZE_FOR_SIZE with feature switch (dotnet#111743) Fix failed assertion 'FPbased == FPbased2' (dotnet#111787) Add remark to `ConditionalSelect` (dotnet#111945) JIT: fix try region cloning when try is nested in a handler (dotnet#111975) Use IRootFunctions in Tensor.StdDev (dotnet#110641) Remove zlib dependencies from Docker containers (dotnet#111939) Avoid `Unsafe.As` for `Memory<T>` and `ReadOnlyMemory<T>` conversion (dotnet#111023) Cleanup membarrier portability (dotnet#111943) ...
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fixes #87711
The intellisense file that comes from Microsoft.Private.Intellisense, located in
C:\.tools\.nuget\packages\microsoft.private.intellisense\9.0.0-preview-20241010.1\IntellisenseFiles\net\1033\System.Speech.xml, weighs 317KB.But when building, the xml files under
C:\Users\calope\source\repos\runtime\artifacts\obj\System.Speech\$(Configuration)\all weigh much less than that (varies depending on the OS/platform) and only contain resource strings (no actual docs).This means we are using the xmls from the build, and almost none of the System.Speech have triple slash comments. I was able to confirm this by analyzing the binlog and finding that
UseCompilerGeneratedDocXmlFileis set totrue(the default value) so none of the logic from intellisense.targets is used.The fix is to set this assembly's
UseCompilerGeneratedDocXmlFileto explicitly tofalsein the csproj, exactly as @gewarren found in the original issue.I was able to confirm with a rebuild of the csproj that the xml placed next to the built DLL is now the one coming from dotnet-api-docs: it weighs 317KB and contains all API docs, and can be found in all the target framework folders in the output folder.