DocComment XML not shipping in Microsoft.NETCore.App.Ref 9.0.100-rc1

[JoeRobich]

This breaks hover support in the VSCode C# extension.

Expected
to see .XML files for each of the libraries like we shipped with 9.0.0-preview.7.

Actual
see no .XML files.

[dotnet-policy-service]

Tagging subscribers to this area: @dotnet/area-infrastructure-libraries
See info in area-owners.md if you want to be subscribed.

[carlossanlop]

Thanks for reporting. We're aware of this. We just got that fixed with #106179

The fix will go into RC1.

Note that there are also many docs that we haven't updated yet, which will get start showing up on RC2.

[ericstj]

@carlossanlop I spot checked https://dev.azure.com/dnceng/public/_artifacts/feed/dotnet9/NuGet/Microsoft.NETCore.App.Ref/overview/9.0.0-rc.1.24421.1
And https://dev.azure.com/dnceng/public/_artifacts/feed/dotnet9/NuGet/Microsoft.NETCore.App.Ref/overview/9.0.0-rc.2.24423.10

DOC XML is still missing. Can you double check that there's not something else broken here?

[ericstj]

I had a look:

runtime/src/installer/pkg/sfx/Microsoft.NETCore.App/Microsoft.NETCore.App.Ref.sfxproj

Line 20 in 5026865

<DocFilesToPackage Include="$(MicrosoftNetCoreAppRefPackRefDir)%(LibrariesRefAssemblies.FileName).xml" Condition="Exists('$(MicrosoftNetCoreAppRefPackRefDir)%(LibrariesRefAssemblies.FileName).xml')"/>

Is trying to grab the files from MicrosoftNetCoreAppRefPackRefDir which is artifacts\bin\microsoft.netcore.app.ref\ref\net9.0

Inspecting this folder the problems files exist with the name System.*.intellisense-package.xml instead of System.*.xml. This was caused by 9477e94. I'll see if I can make a fix.

[ericstj]

Yeah, that change regressed it. I think that was a bad change as the build process doesn't actually rename the file when copying:
https://github.com/dotnet/msbuild/blob/7cf66090a764f0f239671e4877255efe7ba91155/src/Tasks/Microsoft.Common.CurrentVersion.targets#L398
https://github.com/dotnet/msbuild/blob/7cf66090a764f0f239671e4877255efe7ba91155/src/Tasks/Microsoft.Common.CurrentVersion.targets#L4942-L4944
The only reason it's not broken in the output directory is because the FinalDocFile gets set before we redefine DocFileItem.

The phase that copies to the shared framework gets the renamed items and doesn't ever give them the correct name.

runtime/src/libraries/sfx.proj

Lines 63 to 66 in 6e68f92

	<DocumentationFileToCopy Include="@(SharedFrameworkAssembly->WithMetadataValue('IsPrivateAssembly', 'false')->Metadata('DocFileItem'))" />
	</ItemGroup>
	<Copy SourceFiles="@(DocumentationFileToCopy)"

The simpler fix here is to use a sub-directory for the touched file instead of a different filename. #107334 does this.