dotnet / docs-tools

This repo contains GitHub Actions and other tools that are designed to be invoked on DocFx repositories.
Creative Commons Attribution 4.0 International
17 stars 28 forks source link

[PackageIndexer] Include XML files for more packages #391

Closed gewarren closed 2 months ago

gewarren commented 3 months ago

You can use the following PS script to find the assemblies where /// is the source of truth, and when ingesting them for API reference generation, we should include their XML documentation files.

Get-ChildItem -Path "C:\users\gw\runtime\src\libraries" -Recurse -Filter "*.csproj" -File | 
    Where-Object { $_.FullName -notlike "*\ref\*" -and $_.FullName -notlike "*\tests\*" -and $_.FullName -notlike "*\gen\*" -and $_.FullName -notlike "*\shims\*" -and $_.FullName -notlike "*\tools\*" -and $_.FullName -notlike "*\System.Private*\*" -and $_.FullName -notlike "*\Fuzzing\*" } | 
    ForEach-Object {
        $content = Get-Content -Path $_.FullName -Raw
        if ($content -notmatch "UseCompilerGeneratedDocXmlFile") {
            $_.FullName
        }
    }

Modify PackageIndexer to include XML files for any packages that ship the assemblies that show up in the output.


Associated WorkItem - 297408