Free cookie consent management tool by TermsFeed Policy Generator

source: stable/HeuristicLab.ExtLibs/HeuristicLab.NRefactory/5.5.0/NRefactory-5.5.0/Documentation/IDocumentationProvider.cs @ 15724

Last change on this file since 15724 was 11700, checked in by jkarder, 10 years ago

#2077: created branch and added first version

File size: 2.0 KB
Line 
1// Copyright (c) 2010-2013 AlphaSierraPapa for the SharpDevelop Team
2//
3// Permission is hereby granted, free of charge, to any person obtaining a copy of this
4// software and associated documentation files (the "Software"), to deal in the Software
5// without restriction, including without limitation the rights to use, copy, modify, merge,
6// publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
7// to whom the Software is furnished to do so, subject to the following conditions:
8//
9// The above copyright notice and this permission notice shall be included in all copies or
10// substantial portions of the Software.
11//
12// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
13// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
14// PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
15// FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
16// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
17// DEALINGS IN THE SOFTWARE.
18
19using System;
20using System.IO;
21using ICSharpCode.NRefactory.TypeSystem;
22
23namespace ICSharpCode.NRefactory.Documentation
24{
25  /// <summary>
26  /// Provides XML documentation for entities.
27  /// </summary>
28  public interface IDocumentationProvider
29  {
30    /// <summary>
31    /// Gets the XML documentation for the specified entity.
32    /// </summary>
33    DocumentationComment GetDocumentation(IEntity entity);
34  }
35 
36  /// <summary>
37  /// Provides XML documentation for entities.
38  /// </summary>
39  public interface IUnresolvedDocumentationProvider
40  {
41    /// <summary>
42    /// Gets the XML documentation for the specified entity.
43    /// </summary>
44    string GetDocumentation(IUnresolvedEntity entity);
45   
46    /// <summary>
47    /// Gets the XML documentation for the specified entity.
48    /// </summary>
49    DocumentationComment GetDocumentation(IUnresolvedEntity entity, IEntity resolvedEntity);
50  }
51}
Note: See TracBrowser for help on using the repository browser.