/NRefactory/ICSharpCode.NRefactory/TypeSystem/IDocumentationProvider.cs
http://github.com/icsharpcode/ILSpy · C# · 34 lines · 9 code · 2 blank · 23 comment · 0 complexity · c90b8ed7b8c6b0c01f750e7e314afbe6 MD5 · raw file
- // Copyright (c) AlphaSierraPapa for the SharpDevelop Team
- //
- // Permission is hereby granted, free of charge, to any person obtaining a copy of this
- // software and associated documentation files (the "Software"), to deal in the Software
- // without restriction, including without limitation the rights to use, copy, modify, merge,
- // publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
- // to whom the Software is furnished to do so, subject to the following conditions:
- //
- // The above copyright notice and this permission notice shall be included in all copies or
- // substantial portions of the Software.
- //
- // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
- // INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
- // PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
- // FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
- // OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
- // DEALINGS IN THE SOFTWARE.
- using System;
- using System.IO;
- namespace ICSharpCode.NRefactory.TypeSystem
- {
- /// <summary>
- /// Provides XML documentation for members.
- /// </summary>
- public interface IDocumentationProvider
- {
- /// <summary>
- /// Gets the XML documentation for the specified entity.
- /// </summary>
- string GetDocumentation(IEntity entity);
- }
- }