/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

  1. // Copyright (c) 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. using System;
  19. using System.IO;
  20. namespace ICSharpCode.NRefactory.TypeSystem
  21. {
  22. /// <summary>
  23. /// Provides XML documentation for members.
  24. /// </summary>
  25. public interface IDocumentationProvider
  26. {
  27. /// <summary>
  28. /// Gets the XML documentation for the specified entity.
  29. /// </summary>
  30. string GetDocumentation(IEntity entity);
  31. }
  32. }