Changeset 1167 for trunk/sources/HeuristicLab.Operators.Metaprogramming

Timestamp:

01/22/09 12:06:29 (15 years ago)

Author:

vdorfer

Message:

Created API documentation for HeuristicLab.Operators.Metaprogramming and HeuristicLab.Logging namespace and changed a comment in HeuristicLab.Core namespace(#331)

Location:

trunk/sources/HeuristicLab.Operators.Metaprogramming

Files:

• DoubleRangeVariableInjector.cs (modified) (2 diffs)
• HeuristicLab.Operators.Metaprogramming.csproj (modified) (2 diffs)
• HeuristicLabOperatorsMetaprogrammingPlugin.cs (modified) (1 diff)
• IntRangeVariableInjector.cs (modified) (2 diffs)
• PermutationInjector.cs (modified) (2 diffs)
• SequentialComposer.cs (modified) (2 diffs)

trunk/sources/HeuristicLab.Operators.Metaprogramming/DoubleRangeVariableInjector.cs

@@ -28 +28 @@
 
 namespace HeuristicLab.Operators.Metaprogramming {
+  /// <summary>
+  /// Injects a double variable into the current scope being in a specified range.
+  /// </summary>
   public class DoubleRangeVariableInjector: OperatorBase {
+    /// <inheritdoc select="summary"/>
     public override string Description {
       get { return "TASK."; }
     }
 
+    /// <summary>
+    /// Initializes a new instance of <see cref="DoubleRangeVariableInjector"/> with five variable infos
+    /// (<c>VariableInjectos</c>, <c>VariableName</c>, <c>Min</c>, <c>Max</c> and <c>StepSize</c>).
+    /// </summary>
     public DoubleRangeVariableInjector()
       : base() {
@@ -42 +50 @@
     }
 
+    /// <summary>
+    /// Injects a new double variable in the given <paramref name="scope"/>.
+    /// </summary>
+    /// <param name="scope">The current scope where to inject the variable.</param>
+    /// <returns><c>null</c>.</returns>
     public override IOperation Apply(IScope scope) {
       double min = GetVariableValue<DoubleData>("Min", scope, true).Data;

trunk/sources/HeuristicLab.Operators.Metaprogramming/HeuristicLab.Operators.Metaprogramming.csproj

@@ -4 +4 @@
     <Configuration Condition=" '$(Configuration)' == '' ">Debug</Configuration>
     <Platform Condition=" '$(Platform)' == '' ">AnyCPU</Platform>
-    <ProductVersion>9.0.30729</ProductVersion>
+    <ProductVersion>9.0.21022</ProductVersion>
     <SchemaVersion>2.0</SchemaVersion>
     <ProjectGuid>{F18FD554-19B9-460C-9A49-4AA8D7245727}</ProjectGuid>
@@ -32 +32 @@
     <ErrorReport>prompt</ErrorReport>
     <WarningLevel>4</WarningLevel>
+    <DocumentationFile>bin\Release\HeuristicLab.Operators.Metaprogramming-3.2.XML</DocumentationFile>
   </PropertyGroup>
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|x86' ">

trunk/sources/HeuristicLab.Operators.Metaprogramming/HeuristicLabOperatorsMetaprogrammingPlugin.cs

@@ -26 +26 @@
 
 namespace HeuristicLab.Operators.Metaprogramming {
+  /// <summary>
+  /// Plugin class for HeuristicLab.Operators.Metaprogramming plugin.
+  /// </summary>
   [ClassInfo(Name = "HeuristicLab.Operators.Metaprogramming-3.2")]
   [PluginFile(Filename = "HeuristicLab.Operators.Metaprogramming-3.2.dll", Filetype = PluginFileType.Assembly)]

trunk/sources/HeuristicLab.Operators.Metaprogramming/IntRangeVariableInjector.cs

@@ -28 +28 @@
 
 namespace HeuristicLab.Operators.Metaprogramming {
+  /// <summary>
+  /// Injects a new integer variable into the current scope being in a specified range.
+  /// </summary>
   public class IntRangeVariableInjector: OperatorBase {
+    /// <inheritdoc select="summary"/>
     public override string Description {
       get { return "TASK."; }
     }
 
+    /// <summary>
+    /// Initializes a new instance of <see cref="IntRangeVariableInjector"/> with four variable infos
+    /// (<c>VariableInjector</c>, <c>VariableName</c>, <c>Min</c> and <c>Max</c>).
+    /// </summary>
     public IntRangeVariableInjector()
       : base() {
@@ -41 +49 @@
     }
 
+    /// <summary>
+    /// Injects a new integer variable in the given <paramref name="scope"/>.
+    /// </summary>
+    /// <param name="scope">The current scope where to inject the variable.</param>
+    /// <returns><c>null</c>.</returns>
     public override IOperation Apply(IScope scope) {
       int min = GetVariableValue<IntData>("Min", scope, true).Data;

trunk/sources/HeuristicLab.Operators.Metaprogramming/PermutationInjector.cs

@@ -28 +28 @@
 
 namespace HeuristicLab.Operators.Metaprogramming {
+  /// <summary>
+  /// Injects a new permutation variable in the given scope. The number of items contained
+  /// are in a predifined range.
+  /// </summary>
   public class PermutationInjector : OperatorBase {
+    /// <inheritdoc select="summary"/>
     public override string Description {
       get { return "TASK."; }
     }
 
+    /// <summary>
+    /// Initializes a new instance of <see cref="PermutationInjector"/> with five variable infos
+    /// (<c>VariableInjector</c>, <c>VariableName</c>, <c>Items</c>, <c>Min</c> and <c>Max</c>).
+    /// </summary>
     public PermutationInjector()
       : base() {
@@ -42 +51 @@
     }
 
+    /// <summary>
+    /// Injects a new permutation variable into the given <paramref name="scope"/>.
+    /// </summary>
+    /// <param name="scope">The current scope where to inject the permutation list.</param>
+    /// <returns><c>null</c>.</returns>
     public override IOperation Apply(IScope scope) {
       int min = GetVariableValue<IntData>("Min", scope, true).Data;

trunk/sources/HeuristicLab.Operators.Metaprogramming/SequentialComposer.cs

@@ -28 +28 @@
 
 namespace HeuristicLab.Operators.Metaprogramming {
+  /// <summary>
+  /// Composes a sequence of <see cref="IOperatorGraph"/>s and injects it into the given scope.
+  /// </summary>
   public class SequentialComposer: OperatorBase {
+    /// <inheritdoc select="summary"/>
     public override string Description {
       get { return "TASK."; }
     }
 
+    /// <summary>
+    /// Initializes a new instance of <see cref="SequentialComposer"/> with two variable infos
+    /// (<c>CombineOperator</c> and <c>OperatorNames</c>).
+    /// </summary>
     public SequentialComposer()
       : base() {
@@ -39 +47 @@
     }
 
+    /// <summary>
+    /// Composes a sequence <see cref="IOperatorGraph"/>s and injects it into the given <paramref name="scope"/>.
+    /// </summary>
+    /// <param name="scope">The current scope where to inject the created sequence of operators.</param>
+    /// <returns><c>null</c>.</returns>
     public override IOperation Apply(IScope scope) {
       ItemList<StringData> parts = GetVariableValue<ItemList<StringData>>("OperatorNames", scope, true);