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

// Copyright (c) 2010-2013 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;
using ICSharpCode.NRefactory.TypeSystem;

namespace ICSharpCode.NRefactory.Documentation
{
  /// <summary>
  /// Provides XML documentation for entities.
  /// </summary>
  public interface IDocumentationProvider
  {
    /// <summary>
    /// Gets the XML documentation for the specified entity.
    /// </summary>
    DocumentationComment GetDocumentation(IEntity entity);
  }
  
  /// <summary>
  /// Provides XML documentation for entities.
  /// </summary>
  public interface IUnresolvedDocumentationProvider
  {
    /// <summary>
    /// Gets the XML documentation for the specified entity.
    /// </summary>
    string GetDocumentation(IUnresolvedEntity entity);
    
    /// <summary>
    /// Gets the XML documentation for the specified entity.
    /// </summary>
    DocumentationComment GetDocumentation(IUnresolvedEntity entity, IEntity resolvedEntity);
  }
}