Dnspy/dnSpy/Roslyn/dnSpy.Roslyn/Documentation/IRoslynDocumentationProviderFactory.cs

35 lines
1.2 KiB
C#
Raw Permalink Normal View History

2021-09-20 18:20:01 +02:00
/*
Copyright (C) 2014-2019 de4dot@gmail.com
This file is part of dnSpy
dnSpy is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
dnSpy is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with dnSpy. If not, see <http://www.gnu.org/licenses/>.
*/
using Microsoft.CodeAnalysis;
namespace dnSpy.Roslyn.Documentation {
/// <summary>
/// Creates <see cref="DocumentationProvider"/>s
/// </summary>
interface IRoslynDocumentationProviderFactory {
/// <summary>
/// Creates a <see cref="DocumentationProvider"/> or returns null if it wasn't possible to create one
/// </summary>
/// <param name="filename">Filename</param>
/// <returns></returns>
DocumentationProvider? TryCreate(string? filename);
}
}