[Feature Request] Add support to reference additional DLLs when build metadata with C# source files

**Is your feature request related to a problem? Please describe.**

It seems `C# file based` API metadata generation are used by users who use `Unity`.

- https://github.com/dotnet/docfx/issues/9675
- https://github.com/NormandErwan/DocFxForUnity/issues/28

In this case. It needs to reference additional DLLs that are provided by Unity. (e.g. `UnityEngine.dll`)
But It seems currently not possible by `docfx.json` config. 

It can generate API metadata partially. When setting `"allowCompilationErrors": true`. 
But some metadata that depends on external DLLs are not generated.

**Describe the solution you'd like**
Allow additional DLL file references when using C# file based build.

**Additional context**
Currently `CreateCompilationFromCSharpFiles` don't support additional references.
But `CreateCompilationFromCSharpCode` that used test code supports additional DLL references.
https://github.com/dotnet/docfx/blob/841fcdfe3d97b958caeaf78b86c6d183f20f854f/src/Docfx.Dotnet/CompilationHelper.cs#L55-L71


	public static Compilation CreateCompilationFromCSharpFiles(IEnumerable<string> files)
	{
	return CS.CSharpCompilation.Create(
	assemblyName: null,
	options: new CS.CSharpCompilationOptions(OutputKind.DynamicallyLinkedLibrary, xmlReferenceResolver: XmlFileResolver.Default),
	syntaxTrees: files.Select(path => CS.SyntaxFactory.ParseSyntaxTree(File.ReadAllText(path), path: path)),
	references: GetDefaultMetadataReferences("C#"));
	}

	public static Compilation CreateCompilationFromCSharpCode(string code, string name = null, params MetadataReference[] references)
	{
	return CS.CSharpCompilation.Create(
	name,
	options: new CS.CSharpCompilationOptions(OutputKind.DynamicallyLinkedLibrary, xmlReferenceResolver: XmlFileResolver.Default),
	syntaxTrees: new[] { CS.SyntaxFactory.ParseSyntaxTree(code) },
	references: GetDefaultMetadataReferences("C#").Concat(references));
	}

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[Feature Request] Add support to reference additional DLLs when build metadata with C# source files #9706

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

[Feature Request] Add support to reference additional DLLs when build metadata with C# source files #9706

Description

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions