/IronPython_Main/Runtime/Microsoft.Scripting/Runtime/DocumentationAttribute.cs

# · C# · 37 lines · 13 code · 4 blank · 20 comment · 0 complexity · 709f15904889f3b5e44fc169316db2e9 MD5 · raw file

  1. /* ****************************************************************************
  2. *
  3. * Copyright (c) Microsoft Corporation.
  4. *
  5. * This source code is subject to terms and conditions of the Apache License, Version 2.0. A
  6. * copy of the license can be found in the License.html file at the root of this distribution. If
  7. * you cannot locate the Apache License, Version 2.0, please send an email to
  8. * dlr@microsoft.com. By using this source code in any fashion, you are agreeing to be bound
  9. * by the terms of the Apache License, Version 2.0.
  10. *
  11. * You must not remove this notice, or any other, from this software.
  12. *
  13. *
  14. * ***************************************************************************/
  15. using System;
  16. namespace Microsoft.Scripting.Runtime {
  17. /// <summary>
  18. /// Provides a mechanism for providing documentation stored in an assembly as metadata.
  19. ///
  20. /// Applying this attribute will enable documentation to be provided to the user at run-time
  21. /// even if XML Docuementation files are unavailable.
  22. /// </summary>
  23. [AttributeUsage(AttributeTargets.All)]
  24. public sealed class DocumentationAttribute : Attribute {
  25. private readonly string _doc;
  26. public DocumentationAttribute(string documentation) {
  27. _doc = documentation;
  28. }
  29. public string Documentation {
  30. get { return _doc; }
  31. }
  32. }
  33. }