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

 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
16using System;
17
18namespace Microsoft.Scripting.Runtime {
19    /// <summary>
20    /// Provides a mechanism for providing documentation stored in an assembly as metadata.  
21    /// 
22    /// Applying this attribute will enable documentation to be provided to the user at run-time
23    /// even if XML Docuementation files are unavailable.
24    /// </summary>
25    [AttributeUsage(AttributeTargets.All)]
26    public sealed class DocumentationAttribute : Attribute {
27        private readonly string _doc;
28
29        public DocumentationAttribute(string documentation) {
30            _doc = documentation;
31        }
32
33        public string Documentation {
34            get { return _doc; }
35        }
36    }
37}