Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: Add solution filter file (.slnf) supports #9513

Merged
merged 1 commit into from
Dec 13, 2023
Merged

feat: Add solution filter file (.slnf) supports #9513

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/docs/dotnet-api-docs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ If [source link](https://learn.microsoft.com/en-us/dotnet/standard/library-guida

## Generate from projects or solutions

When the file extension is `.csproj`, `.vbproj` or `.sln`, docfx uses [`MSBuildWorkspace`](https://gist.github.com/DustinCampbell/32cd69d04ea1c08a16ae5c4cd21dd3a3) to perform a design-time build of the projects before generating API docs.
When the file extension is `.csproj`, `.vbproj`, `.sln` or `slnf`, docfx uses [`MSBuildWorkspace`](https://gist.github.com/DustinCampbell/32cd69d04ea1c08a16ae5c4cd21dd3a3) to perform a design-time build of the projects before generating API docs.

In order to successfully load an MSBuild project, .NET Core SDK must be installed and available globally. The installation must have the necessary workloads and components to support the projects you'll be loading.

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/docfx-cli-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ docfx metadata [<projects>] [--property <n1>=<v1>;<n2>=<v2>]
`<projects>` specifies the projects to have metadata extracted. There are several approaches to extract language metadata.

1. From a supported file or file list
Supported file extensions include `.csproj`, `.vbproj`, `.sln`, `project.json`, `dll` assembly file, `.cs` source file and `.vb` source file.
Supported file extensions include `.csproj`, `.vbproj`, `.sln`, `.slnf`, `exe`, `dll` assembly file, `.cs` source file and `.vb` source file.

Multiple files are separated by whitespace, e.g. `docfx metadata Class1.cs a.csproj`

Expand Down
2 changes: 1 addition & 1 deletion src/Docfx.Dotnet/DotnetApiCatalog.Compile.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ partial class DotnetApiCatalog
{
foreach (var file in unsupportedFiles)
{
Logger.LogWarning($"Skip unsupported file {file}");
Logger.LogWarning($"Skip unsupported file {file.NormalizedPath}");
}
}

Expand Down
1 change: 1 addition & 0 deletions src/Docfx.Dotnet/FileInformation.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ private static FileType GetFileType(string filePath)
switch (extension.ToLowerInvariant())
{
case ".sln":
case ".slnf":
return FileType.Solution;
case ".csproj":
case ".vbproj":
Expand Down