Free cookie consent management tool by TermsFeed Policy Generator

source: trunk/sources/HeuristicLab.PluginInfrastructure/ClassInfoAttribute.cs @ 1729

Last change on this file since 1729 was 1189, checked in by vdorfer, 16 years ago

Created parts of the API documentation for HeuristicLab.PluginInfrastructure namespace (#331)

File size: 2.3 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2008 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
4 *
5 * This file is part of HeuristicLab.
6 *
7 * HeuristicLab is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
11 *
12 * HeuristicLab is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with HeuristicLab. If not, see <http://www.gnu.org/licenses/>.
19 */
20#endregion
21
22using System;
23using System.Collections.Generic;
24using System.Text;
25
26namespace HeuristicLab.PluginInfrastructure {
27  /// <summary>
28  /// This attribute can be used to specify meta data for classes.
29  /// For example to specify name, version and description of applications or plugins.
30  /// </summary>
31  [AttributeUsage(AttributeTargets.Class)]
32  public class ClassInfoAttribute : System.Attribute {
33    private string name;
34    /// <summary>
35    /// Gets or sets the name of the plugin to which the assembly belongs to.
36    /// </summary>
37    public string Name {
38      get { return name; }
39      set { name = value; }
40    }
41
42    private string version;
43    /// <summary>
44    /// Gets or sets the version of the plugin.
45    /// </summary>
46    public string Version {
47      get { return version; }
48      set { version = value; }
49    }
50
51    private string description;
52    /// <summary>
53    /// Gets or sets the description of the plugin.
54    /// </summary>
55    public string Description {
56      get { return description; }
57      set { description = value; }
58    }
59
60    private bool autoRestart;
61    /// <summary>
62    /// Gets or sets the boolean flag whether the plugin should be automatically restarted.
63    /// </summary>
64    public bool AutoRestart {
65      get { return autoRestart; }
66      set { autoRestart = value; }
67    }
68
69    /// <summary>
70    /// Initializes a new instance of <see cref="ClassInfoAttribute"/>.
71    /// </summary>
72    public ClassInfoAttribute() {}
73  }
74}
Note: See TracBrowser for help on using the repository browser.