From ee185f72e4ca906083f1d8b0bf8d91aa3c4146f0 Mon Sep 17 00:00:00 2001 From: James Vaughan Date: Wed, 3 Jun 2026 15:26:40 -0400 Subject: [PATCH] Update documentation link for RuntimeModules --- src/XTMF2/RuntimeModules/BasicEvent.cs | 4 ++-- src/XTMF2/RuntimeModules/BasicParameter.cs | 2 +- src/XTMF2/RuntimeModules/Cache.cs | 2 +- src/XTMF2/RuntimeModules/CombineContext.cs | 12 ++++++------ src/XTMF2/RuntimeModules/DirectoryPath.cs | 2 +- src/XTMF2/RuntimeModules/Execute.cs | 4 ++-- .../RuntimeModules/ExecuteActionsThenFunction.cs | 2 +- src/XTMF2/RuntimeModules/ExecuteWithContext.cs | 4 ++-- src/XTMF2/RuntimeModules/Fail.cs | 12 ++++++------ src/XTMF2/RuntimeModules/If.cs | 12 ++++++------ src/XTMF2/RuntimeModules/Ignore.cs | 8 ++++---- src/XTMF2/RuntimeModules/IsCalibrationRun.cs | 2 +- src/XTMF2/RuntimeModules/IsEstimationRun.cs | 2 +- src/XTMF2/RuntimeModules/Log.cs | 2 +- src/XTMF2/RuntimeModules/OpenReadStreamFromFile.cs | 2 +- .../RuntimeModules/OpenReadStreamFromMemoryPipe.cs | 2 +- src/XTMF2/RuntimeModules/OpenWriteStreamFromFile.cs | 2 +- .../RuntimeModules/OpenWriteStreamFromMemoryPipe.cs | 2 +- .../RuntimeModules/OpenWriteStreamToRunStatus.cs | 2 +- src/XTMF2/RuntimeModules/ReportInvocation.cs | 10 +++++----- src/XTMF2/RuntimeModules/ScriptedParameter.cs | 2 +- src/XTMF2/RuntimeModules/SetParameter.cs | 2 +- src/XTMF2/RuntimeModules/SetableParameter.cs | 2 +- src/XTMF2/RuntimeModules/Sleep.cs | 2 +- src/XTMF2/RuntimeModules/StartModule.cs | 2 +- src/XTMF2/RuntimeModules/StepUp.cs | 6 +++--- src/XTMF2/RuntimeModules/WithContext.cs | 4 ++-- src/XTMF2/RuntimeModules/WriteToLog.cs | 12 ++++++------ 28 files changed, 61 insertions(+), 61 deletions(-) diff --git a/src/XTMF2/RuntimeModules/BasicEvent.cs b/src/XTMF2/RuntimeModules/BasicEvent.cs index 7e80226..ce9abab 100644 --- a/src/XTMF2/RuntimeModules/BasicEvent.cs +++ b/src/XTMF2/RuntimeModules/BasicEvent.cs @@ -23,7 +23,7 @@ You should have received a copy of the GNU General Public License namespace XTMF2.RuntimeModules { - [Module(Name = "Basic Event", DocumentationLink = "http://tmg.utoronto.ca/doc/2.0", + [Module(Name = "Basic Event", DocumentationLink = "https://tmg.utoronto.ca/doc/2.0/xtmf2/modules/XTMF2/RuntimeModules/BasicEvent.html", Description = "Provides the ability for modules to invoke a set of other modules that are waiting for something to occur.")] public sealed class BasicEvent : BaseEvent { @@ -52,7 +52,7 @@ public override void Register(Action module) } } - [Module(Name = "Basic Event", DocumentationLink = "http://tmg.utoronto.ca/doc/2.0", + [Module(Name = "Basic Event", DocumentationLink = "https://tmg.utoronto.ca/doc/2.0/xtmf2/modules/XTMF2/RuntimeModules/BasicEvent.html", Description = "Provides the ability for modules to invoke a set of other modules that are waiting for something to occur.")] public sealed class BasicEvent : BaseEvent { diff --git a/src/XTMF2/RuntimeModules/BasicParameter.cs b/src/XTMF2/RuntimeModules/BasicParameter.cs index 3b104c5..47f617e 100644 --- a/src/XTMF2/RuntimeModules/BasicParameter.cs +++ b/src/XTMF2/RuntimeModules/BasicParameter.cs @@ -22,7 +22,7 @@ You should have received a copy of the GNU General Public License namespace XTMF2.RuntimeModules { - [Module(Name = "Basic Parameter", DocumentationLink = "http://tmg.utoronto.ca/doc/2.0", + [Module(Name = "Basic Parameter", DocumentationLink = "https://tmg.utoronto.ca/doc/2.0/xtmf2/modules/XTMF2/RuntimeModules/BasicParameter.html", Description = "Provides the ability to have a value in a model system.")] public class BasicParameter : BaseFunction { diff --git a/src/XTMF2/RuntimeModules/Cache.cs b/src/XTMF2/RuntimeModules/Cache.cs index 52ac38e..5fb9b2f 100644 --- a/src/XTMF2/RuntimeModules/Cache.cs +++ b/src/XTMF2/RuntimeModules/Cache.cs @@ -23,7 +23,7 @@ You should have received a copy of the GNU General Public License namespace XTMF2.RuntimeModules { - [Module(Name = "Cache", DocumentationLink = "http://tmg.utoronto.ca/doc/2.0", + [Module(Name = "Cache", DocumentationLink = "https://tmg.utoronto.ca/doc/2.0/xtmf2/modules/XTMF2/RuntimeModules/Cache.html", Description = "Provides a way to keep the result of a function unless unloaded by an event.")] public sealed class Cache : BaseFunction, IDisposable { diff --git a/src/XTMF2/RuntimeModules/CombineContext.cs b/src/XTMF2/RuntimeModules/CombineContext.cs index 7b42508..d0a88bb 100644 --- a/src/XTMF2/RuntimeModules/CombineContext.cs +++ b/src/XTMF2/RuntimeModules/CombineContext.cs @@ -22,7 +22,7 @@ You should have received a copy of the GNU General Public License namespace XTMF2.RuntimeModules { - [Module(Name = "Combine Context From No Context", DocumentationLink = "http://tmg.utoronto.ca/doc/2.0", + [Module(Name = "Combine Context From No Context", DocumentationLink = "https://tmg.utoronto.ca/doc/2.0/xtmf2/modules/XTMF2/RuntimeModules/CombineContextFromNoContext.html", Description = "Combines the contexts as derived from First and Second and invokes To Invoke with the combined context.")] public sealed class CombineContextAFromNoContext : BaseAction { @@ -41,7 +41,7 @@ public override void Invoke() } } - [Module(Name = "Combine Context From No Context", DocumentationLink = "http://tmg.utoronto.ca/doc/2.0", + [Module(Name = "Combine Context From No Context", DocumentationLink = "https://tmg.utoronto.ca/doc/2.0/xtmf2/modules/XTMF2/RuntimeModules/CombineContextFromNoContext.html", Description = "Combines the contexts as derived from First and Second and invokes To Invoke with the combined context.")] public sealed class CombineContextA : BaseAction { @@ -56,7 +56,7 @@ public override void Invoke(Context1 context) } } - [Module(Name = "Combine Context From No Context", DocumentationLink = "http://tmg.utoronto.ca/doc/2.0", + [Module(Name = "Combine Context From No Context", DocumentationLink = "https://tmg.utoronto.ca/doc/2.0/xtmf2/modules/XTMF2/RuntimeModules/CombineContextFromNoContext.html", Description = "Combines the contexts as derived from First and Second and invokes To Invoke with the combined context.")] public sealed class CombineContextAFromContext : BaseAction { @@ -71,7 +71,7 @@ public override void Invoke(Context1 context) } } - [Module(Name = "Combine Context From No Context", DocumentationLink = "http://tmg.utoronto.ca/doc/2.0", + [Module(Name = "Combine Context From No Context", DocumentationLink = "https://tmg.utoronto.ca/doc/2.0/xtmf2/modules/XTMF2/RuntimeModules/CombineContextFromNoContext.html", Description = "Combines the contexts as derived from First and Second and invokes To Invoke with the combined context.")] public sealed class CombineContextFFromNoContext : BaseFunction { @@ -90,7 +90,7 @@ public override Return Invoke() } } - [Module(Name = "Combine Context From No Context", DocumentationLink = "http://tmg.utoronto.ca/doc/2.0", + [Module(Name = "Combine Context From No Context", DocumentationLink = "https://tmg.utoronto.ca/doc/2.0/xtmf2/modules/XTMF2/RuntimeModules/CombineContextFromNoContext.html", Description = "Combines the contexts as derived from First and Second and invokes To Invoke with the combined context.")] public sealed class CombineContexF : BaseFunction { @@ -105,7 +105,7 @@ public override Return Invoke(Context1 context) } } - [Module(Name = "Combine Context From No Context", DocumentationLink = "http://tmg.utoronto.ca/doc/2.0", + [Module(Name = "Combine Context From No Context", DocumentationLink = "https://tmg.utoronto.ca/doc/2.0/xtmf2/modules/XTMF2/RuntimeModules/CombineContextFromNoContext.html", Description = "Combines the contexts as derived from First and Second and invokes To Invoke with the combined context.")] public sealed class CombineContextFFromContext : BaseFunction { diff --git a/src/XTMF2/RuntimeModules/DirectoryPath.cs b/src/XTMF2/RuntimeModules/DirectoryPath.cs index 24ab3f5..ace38f9 100644 --- a/src/XTMF2/RuntimeModules/DirectoryPath.cs +++ b/src/XTMF2/RuntimeModules/DirectoryPath.cs @@ -22,7 +22,7 @@ You should have received a copy of the GNU General Public License namespace XTMF2.RuntimeModules { - [Module(Name = "Directory Path", DocumentationLink = "http://tmg.utoronto.ca/doc/2.0", + [Module(Name = "Directory Path", DocumentationLink = "https://tmg.utoronto.ca/doc/2.0/xtmf2/modules/XTMF2/RuntimeModules/DirectoryPath.html", Description = "Provides the ability to specify a directory path recursively.")] public sealed class DirectoryPath : BaseFunction { diff --git a/src/XTMF2/RuntimeModules/Execute.cs b/src/XTMF2/RuntimeModules/Execute.cs index 179b204..fedf84e 100644 --- a/src/XTMF2/RuntimeModules/Execute.cs +++ b/src/XTMF2/RuntimeModules/Execute.cs @@ -23,7 +23,7 @@ You should have received a copy of the GNU General Public License namespace XTMF2.RuntimeModules { - [Module(Name = "Execute", DocumentationLink = "http://tmg.utoronto.ca/doc/2.0", + [Module(Name = "Execute", DocumentationLink = "https://tmg.utoronto.ca/doc/2.0/xtmf2/modules/XTMF2/RuntimeModules/Execute.html", Description = "Provides a way to execute a series of actions in order, optionally in parallel or with multiple iterations.")] public class Execute : BaseAction { @@ -68,7 +68,7 @@ public override void Invoke() } } - [Module(Name = "Execute", DocumentationLink = "http://tmg.utoronto.ca/doc/2.0", + [Module(Name = "Execute", DocumentationLink = "https://tmg.utoronto.ca/doc/2.0/xtmf2/modules/XTMF2/RuntimeModules/Execute.html", Description = "Provides a way to execute a series of actions in order, optionally in parallel or with multiple iterations.")] public class Execute : BaseAction { diff --git a/src/XTMF2/RuntimeModules/ExecuteActionsThenFunction.cs b/src/XTMF2/RuntimeModules/ExecuteActionsThenFunction.cs index 4afbee2..f32893f 100644 --- a/src/XTMF2/RuntimeModules/ExecuteActionsThenFunction.cs +++ b/src/XTMF2/RuntimeModules/ExecuteActionsThenFunction.cs @@ -23,7 +23,7 @@ You should have received a copy of the GNU General Public License namespace XTMF2.RuntimeModules { - [Module(Name = "Execute Actions Then Function", DocumentationLink = "http://tmg.utoronto.ca/doc/2.0", + [Module(Name = "Execute Actions Then Function", DocumentationLink = "https://tmg.utoronto.ca/doc/2.0/xtmf2/modules/XTMF2/RuntimeModules/ExecuteActionsThenFunction.html", Description = "Allows you to execute actions before calling a function. This allows you to ")] public class ExecuteActionsThenFunction : BaseFunction { diff --git a/src/XTMF2/RuntimeModules/ExecuteWithContext.cs b/src/XTMF2/RuntimeModules/ExecuteWithContext.cs index ff1f6f5..ae06523 100644 --- a/src/XTMF2/RuntimeModules/ExecuteWithContext.cs +++ b/src/XTMF2/RuntimeModules/ExecuteWithContext.cs @@ -19,7 +19,7 @@ You should have received a copy of the GNU General Public License namespace XTMF2.RuntimeModules; -[Module(Name = "Execute With Context", DocumentationLink = "http://tmg.utoronto.ca/doc/2.0", +[Module(Name = "Execute With Context", DocumentationLink = "https://tmg.utoronto.ca/doc/2.0/xtmf2/modules/XTMF2/RuntimeModules/ExecuteWithContext.html", Description = "Provides a way to execute a series of actions with a context loaded from the provided context.")] public sealed class ExecuteWithContext : BaseAction { @@ -39,7 +39,7 @@ override public void Invoke() } } -[Module(Name = "Execute With Forwarded Context", DocumentationLink = "http://tmg.utoronto.ca/doc/2.0", +[Module(Name = "Execute With Forwarded Context", DocumentationLink = "https://tmg.utoronto.ca/doc/2.0/xtmf2/modules/XTMF2/RuntimeModules/ExecuteWithForwardedContext.html", Description = "Provides a way to execute a series of actions using a context provided to it.")] public sealed class ExecuteWithForwardedContext : BaseAction { diff --git a/src/XTMF2/RuntimeModules/Fail.cs b/src/XTMF2/RuntimeModules/Fail.cs index 9cd44cf..7a4c12a 100644 --- a/src/XTMF2/RuntimeModules/Fail.cs +++ b/src/XTMF2/RuntimeModules/Fail.cs @@ -23,7 +23,7 @@ You should have received a copy of the GNU General Public License namespace XTMF2.RuntimeModules { [Module(Name = "Fail", Description = "Crash the model run with a message.", - DocumentationLink = "http://tmg.utoronto.ca/doc/2.0/")] + DocumentationLink = "https://tmg.utoronto.ca/doc/2.0/xtmf2/modules/XTMF2/RuntimeModules/Fail.html")] public sealed class FailA : BaseAction { [Parameter(Name = "Message", Index = 0, Description = "The message to fail with.", DefaultValue = "Invalid state!")] @@ -36,7 +36,7 @@ public override void Invoke() } [Module(Name = "Fail", Description = "Crash the model run with a message.", - DocumentationLink = "http://tmg.utoronto.ca/doc/2.0/")] + DocumentationLink = "https://tmg.utoronto.ca/doc/2.0/xtmf2/modules/XTMF2/RuntimeModules/Fail.html")] public sealed class FailA : BaseAction { [Parameter(Name = "Message", Index = 0, Description = "The message to fail with.", DefaultValue = "Invalid state!")] @@ -49,7 +49,7 @@ public override void Invoke(Context context) } [Module(Name = "Fail", Description = "Crash the model run with a message.", - DocumentationLink = "http://tmg.utoronto.ca/doc/2.0/")] + DocumentationLink = "https://tmg.utoronto.ca/doc/2.0/xtmf2/modules/XTMF2/RuntimeModules/Fail.html")] public sealed class FailWithContextA : BaseAction { [Parameter(Name = "Message", Index = 0, Description = "The message to fail with.", DefaultValue = "Invalid state!")] @@ -62,7 +62,7 @@ public override void Invoke(Context context) } [Module(Name = "Fail", Description = "Crash the model run with a message.", - DocumentationLink = "http://tmg.utoronto.ca/doc/2.0/")] + DocumentationLink = "https://tmg.utoronto.ca/doc/2.0/xtmf2/modules/XTMF2/RuntimeModules/Fail.html")] public sealed class FailF : BaseFunction { [Parameter(Name = "Message", Index = 0, Description = "The message to fail with.", DefaultValue = "Invalid state!")] @@ -75,7 +75,7 @@ public override Return Invoke() } [Module(Name = "Fail", Description = "Crash the model run with a message.", - DocumentationLink = "http://tmg.utoronto.ca/doc/2.0/")] + DocumentationLink = "https://tmg.utoronto.ca/doc/2.0/xtmf2/modules/XTMF2/RuntimeModules/Fail.html")] public sealed class FailF : BaseFunction { [Parameter(Name = "Message", Index = 0, Description = "The message to fail with.", DefaultValue = "Invalid state!")] @@ -88,7 +88,7 @@ public override Return Invoke(Context context) } [Module(Name = "Fail", Description = "Crash the model run with a message.", - DocumentationLink = "http://tmg.utoronto.ca/doc/2.0/")] + DocumentationLink = "https://tmg.utoronto.ca/doc/2.0/xtmf2/modules/XTMF2/RuntimeModules/Fail.html")] public sealed class FailWithContextF : BaseFunction { [Parameter(Name = "Message", Index = 0, Description = "The message to fail with.", DefaultValue = "Invalid state!")] diff --git a/src/XTMF2/RuntimeModules/If.cs b/src/XTMF2/RuntimeModules/If.cs index f38fae7..839e4a0 100644 --- a/src/XTMF2/RuntimeModules/If.cs +++ b/src/XTMF2/RuntimeModules/If.cs @@ -22,7 +22,7 @@ You should have received a copy of the GNU General Public License namespace XTMF2.RuntimeModules { - [Module(Name = "If", DocumentationLink = "http://tmg.utoronto.ca/doc/2.0", + [Module(Name = "If", DocumentationLink = "https://tmg.utoronto.ca/doc/2.0/xtmf2/modules/XTMF2/RuntimeModules/If.html", Description = "Provides a way to conditionally execute. If the condition is true or false different functions will be invoked.")] public sealed class IfF : BaseFunction { @@ -49,7 +49,7 @@ public override Return Invoke() } } - [Module(Name = "If", DocumentationLink = "http://tmg.utoronto.ca/doc/2.0", + [Module(Name = "If", DocumentationLink = "https://tmg.utoronto.ca/doc/2.0/xtmf2/modules/XTMF2/RuntimeModules/If.html", Description = "Provides a way to conditionally execute. If the condition is true or false different functions will be invoked.")] public sealed class IfF : BaseFunction { @@ -76,7 +76,7 @@ public override Return Invoke(Context context) } } - [Module(Name = "If", DocumentationLink = "http://tmg.utoronto.ca/doc/2.0", + [Module(Name = "If", DocumentationLink = "https://tmg.utoronto.ca/doc/2.0/xtmf2/modules/XTMF2/RuntimeModules/If.html", Description = "Provides a way to conditionally execute. If the condition is true or false different functions will be invoked.")] public sealed class IfWithContextF : BaseFunction { @@ -103,7 +103,7 @@ public override Return Invoke(Context context) } } - [Module(Name = "If", DocumentationLink = "http://tmg.utoronto.ca/doc/2.0", + [Module(Name = "If", DocumentationLink = "https://tmg.utoronto.ca/doc/2.0/xtmf2/modules/XTMF2/RuntimeModules/If.html", Description = "Provides a way to conditionally execute. If the condition is true or false different functions will be invoked.")] public sealed class IfA : BaseAction { @@ -130,7 +130,7 @@ public override void Invoke() } } - [Module(Name = "If", DocumentationLink = "http://tmg.utoronto.ca/doc/2.0", + [Module(Name = "If", DocumentationLink = "https://tmg.utoronto.ca/doc/2.0/xtmf2/modules/XTMF2/RuntimeModules/If.html", Description = "Provides a way to conditionally execute. If the condition is true or false different functions will be invoked.")] public sealed class IfA : BaseAction { @@ -157,7 +157,7 @@ public override void Invoke(Context context) } } - [Module(Name = "If", DocumentationLink = "http://tmg.utoronto.ca/doc/2.0", + [Module(Name = "If", DocumentationLink = "https://tmg.utoronto.ca/doc/2.0/xtmf2/modules/XTMF2/RuntimeModules/If.html", Description = "Provides a way to conditionally execute. If the condition is true or false different functions will be invoked.")] public sealed class IfWithContextA : BaseAction { diff --git a/src/XTMF2/RuntimeModules/Ignore.cs b/src/XTMF2/RuntimeModules/Ignore.cs index 4ca5a3f..c68b0fc 100644 --- a/src/XTMF2/RuntimeModules/Ignore.cs +++ b/src/XTMF2/RuntimeModules/Ignore.cs @@ -23,7 +23,7 @@ You should have received a copy of the GNU General Public License namespace XTMF2.RuntimeModules { - [Module(Name = "Ignore Result", DocumentationLink = "http://tmg.utoronto.ca/doc/2.0", + [Module(Name = "Ignore Result", DocumentationLink = "https://tmg.utoronto.ca/doc/2.0/xtmf2/modules/XTMF2/RuntimeModules/IgnoreResult.html", Description = "Ignore the result of a function call. This allows you to call functions from an action.")] public class IgnoreResult : BaseAction { @@ -36,7 +36,7 @@ public override void Invoke() } } - [Module(Name = "Ignore Result", DocumentationLink = "http://tmg.utoronto.ca/doc/2.0", + [Module(Name = "Ignore Result", DocumentationLink = "https://tmg.utoronto.ca/doc/2.0/xtmf2/modules/XTMF2/RuntimeModules/IgnoreResult.html", Description = "Ignore the result of a function call. This allows you to call functions from an action.")] public class IgnoreResult : BaseAction { @@ -49,7 +49,7 @@ public override void Invoke(Context context) } } - [Module(Name = "Ignore Context", DocumentationLink = "http://tmg.utoronto.ca/doc/2.0", + [Module(Name = "Ignore Context", DocumentationLink = "https://tmg.utoronto.ca/doc/2.0/xtmf2/modules/XTMF2/RuntimeModules/IgnoreContext.html", Description = "Ignore the context of a function call. This allows you to call functions that don't require a context.")] public class IgnoreContext : BaseAction { @@ -62,7 +62,7 @@ public override void Invoke(Context context) } } - [Module(Name = "Ignore Context", DocumentationLink = "http://tmg.utoronto.ca/doc/2.0", + [Module(Name = "Ignore Context", DocumentationLink = "https://tmg.utoronto.ca/doc/2.0/xtmf2/modules/XTMF2/RuntimeModules/IgnoreContext.html", Description = "Ignore the context of a function call. This allows you to call functions that don't require a context.")] public class IgnoreContext : BaseFunction { diff --git a/src/XTMF2/RuntimeModules/IsCalibrationRun.cs b/src/XTMF2/RuntimeModules/IsCalibrationRun.cs index cbdcbc3..a9a1404 100644 --- a/src/XTMF2/RuntimeModules/IsCalibrationRun.cs +++ b/src/XTMF2/RuntimeModules/IsCalibrationRun.cs @@ -21,7 +21,7 @@ namespace XTMF2.RuntimeModules; [Module(Name = "Is Calibration Run", Description = "Returns true when the currently executing run is in calibration mode.", - DocumentationLink = "https://tmg.utoronto.ca/doc/2.0")] + DocumentationLink = "https://tmg.utoronto.ca/doc/2.0/xtmf2/modules/XTMF2/RuntimeModules/IsCalibrationRun.html")] public sealed class IsCalibrationRun : BaseFunction { private readonly XTMFRuntime _runtime; diff --git a/src/XTMF2/RuntimeModules/IsEstimationRun.cs b/src/XTMF2/RuntimeModules/IsEstimationRun.cs index 87e14ca..3dbe512 100644 --- a/src/XTMF2/RuntimeModules/IsEstimationRun.cs +++ b/src/XTMF2/RuntimeModules/IsEstimationRun.cs @@ -21,7 +21,7 @@ namespace XTMF2.RuntimeModules; [Module(Name = "Is Estimation Run", Description = "Returns true when the currently executing run is in estimation mode.", - DocumentationLink = "https://tmg.utoronto.ca/doc/2.0")] + DocumentationLink = "https://tmg.utoronto.ca/doc/2.0/xtmf2/modules/XTMF2/RuntimeModules/IsEstimationRun.html")] public sealed class IsEstimationRun : BaseFunction { private readonly XTMFRuntime _runtime; diff --git a/src/XTMF2/RuntimeModules/Log.cs b/src/XTMF2/RuntimeModules/Log.cs index b9739cf..f998cae 100644 --- a/src/XTMF2/RuntimeModules/Log.cs +++ b/src/XTMF2/RuntimeModules/Log.cs @@ -25,7 +25,7 @@ You should have received a copy of the GNU General Public License namespace XTMF2.RuntimeModules { - [Module(Name = "Log", DocumentationLink = "http://tmg.utoronto.ca/doc/2.0", + [Module(Name = "Log", DocumentationLink = "https://tmg.utoronto.ca/doc/2.0/xtmf2/modules/XTMF2/RuntimeModules/Log.html", Description = "Provides functionality for synchronizing the writing of events to a log and providing time stamps.")] public sealed class Log : BaseAction, IFunction, IDisposable { diff --git a/src/XTMF2/RuntimeModules/OpenReadStreamFromFile.cs b/src/XTMF2/RuntimeModules/OpenReadStreamFromFile.cs index 2ef0e63..aab73e2 100644 --- a/src/XTMF2/RuntimeModules/OpenReadStreamFromFile.cs +++ b/src/XTMF2/RuntimeModules/OpenReadStreamFromFile.cs @@ -22,7 +22,7 @@ You should have received a copy of the GNU General Public License namespace XTMF2.RuntimeModules { - [Module(Name = "Open Read Stream From File", DocumentationLink = "http://tmg.utoronto.ca/doc/2.0", + [Module(Name = "Open Read Stream From File", DocumentationLink = "https://tmg.utoronto.ca/doc/2.0/xtmf2/modules/XTMF2/RuntimeModules/OpenReadStreamFromFile.html", Description = "Provides the ability to read a file from the path given to it via the context.")] public class OpenReadStreamFromFile : BaseFunction { diff --git a/src/XTMF2/RuntimeModules/OpenReadStreamFromMemoryPipe.cs b/src/XTMF2/RuntimeModules/OpenReadStreamFromMemoryPipe.cs index bbeb6a7..9bd5ee4 100644 --- a/src/XTMF2/RuntimeModules/OpenReadStreamFromMemoryPipe.cs +++ b/src/XTMF2/RuntimeModules/OpenReadStreamFromMemoryPipe.cs @@ -21,7 +21,7 @@ namespace XTMF2.RuntimeModules { [Module(Name = "Open Read Stream From Memory Pipe", Description = "Gets a ReadStream that is backed by memory.", - DocumentationLink = "http://tmg.utoronto.ca/doc/2.0")] + DocumentationLink = "https://tmg.utoronto.ca/doc/2.0/xtmf2/modules/XTMF2/RuntimeModules/OpenReadStreamFromMemoryPipe.html")] public sealed class OpenReadStreamFromMemoryPipe : BaseFunction { [SubModule(Index=0,Name = "Pipe", Description = "The pipe to read from", Required = true)] diff --git a/src/XTMF2/RuntimeModules/OpenWriteStreamFromFile.cs b/src/XTMF2/RuntimeModules/OpenWriteStreamFromFile.cs index 313292f..3351269 100644 --- a/src/XTMF2/RuntimeModules/OpenWriteStreamFromFile.cs +++ b/src/XTMF2/RuntimeModules/OpenWriteStreamFromFile.cs @@ -23,7 +23,7 @@ You should have received a copy of the GNU General Public License namespace XTMF2.RuntimeModules { - [Module(Name = "Open Write Stream From File", DocumentationLink = "http://tmg.utoronto.ca/doc/2.0", + [Module(Name = "Open Write Stream From File", DocumentationLink = "https://tmg.utoronto.ca/doc/2.0/xtmf2/modules/XTMF2/RuntimeModules/OpenWriteStreamFromFile.html", Description = "Provides a WriteStream to the given file name from context.")] public class OpenWriteStreamFromFile : BaseFunction { diff --git a/src/XTMF2/RuntimeModules/OpenWriteStreamFromMemoryPipe.cs b/src/XTMF2/RuntimeModules/OpenWriteStreamFromMemoryPipe.cs index 11d20b4..4f9361a 100644 --- a/src/XTMF2/RuntimeModules/OpenWriteStreamFromMemoryPipe.cs +++ b/src/XTMF2/RuntimeModules/OpenWriteStreamFromMemoryPipe.cs @@ -22,7 +22,7 @@ namespace XTMF2.RuntimeModules { [Module(Name = "Open Write Stream From Memory Pipe", Description = "Gets a WriteStream that is backed by memory.", - DocumentationLink = "http://tmg.utoronto.ca/doc/2.0")] + DocumentationLink = "https://tmg.utoronto.ca/doc/2.0/xtmf2/modules/XTMF2/RuntimeModules/OpenWriteStreamFromMemoryPipe.html")] public sealed class OpenWriteStreamFromMemoryPipe : BaseFunction { [SubModule(Index = 0, Name = "Pipe", Description = "The pipe to write to", Required = true)] diff --git a/src/XTMF2/RuntimeModules/OpenWriteStreamToRunStatus.cs b/src/XTMF2/RuntimeModules/OpenWriteStreamToRunStatus.cs index 1755e73..115624f 100644 --- a/src/XTMF2/RuntimeModules/OpenWriteStreamToRunStatus.cs +++ b/src/XTMF2/RuntimeModules/OpenWriteStreamToRunStatus.cs @@ -21,7 +21,7 @@ namespace XTMF2.RuntimeModules; [Module(Name ="OpenWriteStreamToRunStatus", Description = "Opens a stream that can be written to in order to send status messages back to the client. This works with Logs.", - DocumentationLink = "https://tmg.utoronto.ca/doc/2.0")] + DocumentationLink = "https://tmg.utoronto.ca/doc/2.0/xtmf2/modules/XTMF2/RuntimeModules/OpenWriteStreamToRunStatus.html")] public sealed class OpenWriteStreamToRunStatus : BaseFunction { private readonly XTMFRuntime _runtime; diff --git a/src/XTMF2/RuntimeModules/ReportInvocation.cs b/src/XTMF2/RuntimeModules/ReportInvocation.cs index fcc3b5b..8a163fd 100644 --- a/src/XTMF2/RuntimeModules/ReportInvocation.cs +++ b/src/XTMF2/RuntimeModules/ReportInvocation.cs @@ -23,7 +23,7 @@ You should have received a copy of the GNU General Public License namespace XTMF2.RuntimeModules { - [Module(Name = "Report Invocation", DocumentationLink = "http://tmg.utoronto.ca/doc/2.0", + [Module(Name = "Report Invocation", DocumentationLink = "https://tmg.utoronto.ca/doc/2.0/xtmf2/modules/XTMF2/RuntimeModules/ReportInvocation.html", Description = "Reports to XTMF that the model system has run through this point.")] public sealed class ReportFunctionInvocation : BaseFunction { @@ -48,7 +48,7 @@ public override Return Invoke() } } - [Module(Name = "Report Invocation", DocumentationLink = "http://tmg.utoronto.ca/doc/2.0", + [Module(Name = "Report Invocation", DocumentationLink = "https://tmg.utoronto.ca/doc/2.0/xtmf2/modules/XTMF2/RuntimeModules/ReportInvocation.html", Description = "Reports to XTMF that the model system has run through this point.")] public sealed class ReportFunctionInvocation : BaseFunction { @@ -72,7 +72,7 @@ public override Return Invoke(Context context) } } - [Module(Name = "Report Invocation", DocumentationLink = "http://tmg.utoronto.ca/doc/2.0", + [Module(Name = "Report Invocation", DocumentationLink = "https://tmg.utoronto.ca/doc/2.0/xtmf2/modules/XTMF2/RuntimeModules/ReportInvocation.html", Description = "Reports to XTMF that the model system has run through this point.")] public sealed class ReportActionInvocation : BaseAction { @@ -96,7 +96,7 @@ public override void Invoke() } } - [Module(Name = "Report Invocation", DocumentationLink = "http://tmg.utoronto.ca/doc/2.0", + [Module(Name = "Report Invocation", DocumentationLink = "https://tmg.utoronto.ca/doc/2.0/xtmf2/modules/XTMF2/RuntimeModules/ReportInvocation.html", Description = "Reports to XTMF that the model system has run through this point.")] public sealed class ReportActionInvocation : BaseAction { @@ -120,7 +120,7 @@ public override void Invoke(Context context) } } - [Module(Name = "Report Invocation", DocumentationLink = "http://tmg.utoronto.ca/doc/2.0", + [Module(Name = "Report Invocation", DocumentationLink = "https://tmg.utoronto.ca/doc/2.0/xtmf2/modules/XTMF2/RuntimeModules/ReportInvocation.html", Description = "Reports to XTMF that the model system has run through this point.")] public sealed class ReportActionInvocationWithContext : BaseAction { diff --git a/src/XTMF2/RuntimeModules/ScriptedParameter.cs b/src/XTMF2/RuntimeModules/ScriptedParameter.cs index fb7ebdf..f5d0407 100644 --- a/src/XTMF2/RuntimeModules/ScriptedParameter.cs +++ b/src/XTMF2/RuntimeModules/ScriptedParameter.cs @@ -22,7 +22,7 @@ You should have received a copy of the GNU General Public License namespace XTMF2.RuntimeModules { - [Module(Name = "Scripted Parameter", DocumentationLink = "http://tmg.utoronto.ca/doc/2.0", + [Module(Name = "Scripted Parameter", DocumentationLink = "https://tmg.utoronto.ca/doc/2.0/xtmf2/modules/XTMF2/RuntimeModules/ScriptedParameter.html", Description = "Provides the ability to have a value that is calculated in an expression.")] public sealed class ScriptedParameter : BaseFunction { diff --git a/src/XTMF2/RuntimeModules/SetParameter.cs b/src/XTMF2/RuntimeModules/SetParameter.cs index 7b6784f..f4f3042 100644 --- a/src/XTMF2/RuntimeModules/SetParameter.cs +++ b/src/XTMF2/RuntimeModules/SetParameter.cs @@ -17,7 +17,7 @@ namespace XTMF2.RuntimeModules; [Module(Name = "Set Parameter", Description = "Sets the value of a parameter to the provided value.", - DocumentationLink = "http://tmg.utoronto.ca/doc/2.0")] + DocumentationLink = "https://tmg.utoronto.ca/doc/2.0/xtmf2/modules/XTMF2/RuntimeModules/SetParameter.html")] public sealed class SetParameter : BaseAction { [Parameter(Required = true, Name = "Value", Description = "The value to set the parameter to.", Index = 0)] diff --git a/src/XTMF2/RuntimeModules/SetableParameter.cs b/src/XTMF2/RuntimeModules/SetableParameter.cs index 83f8d3f..647c171 100644 --- a/src/XTMF2/RuntimeModules/SetableParameter.cs +++ b/src/XTMF2/RuntimeModules/SetableParameter.cs @@ -23,7 +23,7 @@ You should have received a copy of the GNU General Public License namespace XTMF2.RuntimeModules { [Module(Name = "Setable Parameter", Description = "A basic data store of variable type that can be set.", - DocumentationLink = "http://tmg.utoronto.ca/doc/2.0")] + DocumentationLink = "https://tmg.utoronto.ca/doc/2.0/xtmf2/modules/XTMF2/RuntimeModules/SetableParameter.html")] public sealed class SetableParameter : BasicParameter, ISetableValue { public T Get() diff --git a/src/XTMF2/RuntimeModules/Sleep.cs b/src/XTMF2/RuntimeModules/Sleep.cs index e5eadc3..3b480e8 100644 --- a/src/XTMF2/RuntimeModules/Sleep.cs +++ b/src/XTMF2/RuntimeModules/Sleep.cs @@ -22,7 +22,7 @@ You should have received a copy of the GNU General Public License namespace XTMF2.RuntimeModules; -[Module(Name = "Sleep", DocumentationLink = "http://tmg.utoronto.ca/doc/2.0", Description = "Pauses execution for a specified duration.")] +[Module(Name = "Sleep", DocumentationLink = "https://tmg.utoronto.ca/doc/2.0/xtmf2/modules/XTMF2/RuntimeModules/Sleep.html", Description = "Pauses execution for a specified duration.")] public sealed class Sleep : BaseAction { [Parameter(DefaultValue = "1000", Description = "The number of milliseconds to sleep for.", Index = 0, diff --git a/src/XTMF2/RuntimeModules/StartModule.cs b/src/XTMF2/RuntimeModules/StartModule.cs index 267cfcb..cf55f58 100644 --- a/src/XTMF2/RuntimeModules/StartModule.cs +++ b/src/XTMF2/RuntimeModules/StartModule.cs @@ -25,7 +25,7 @@ namespace XTMF2.RuntimeModules /// /// The type used for a start node /// - [Module(Name = "Start", DocumentationLink = "http://tmg.utoronto.ca/doc/2.0", + [Module(Name = "Start", DocumentationLink = "https://tmg.utoronto.ca/doc/2.0/xtmf2/modules/XTMF2/RuntimeModules/Start.html", Description = "A starting point for a model system.")] public sealed class StartModule : BaseAction { diff --git a/src/XTMF2/RuntimeModules/StepUp.cs b/src/XTMF2/RuntimeModules/StepUp.cs index 9e80786..3567729 100644 --- a/src/XTMF2/RuntimeModules/StepUp.cs +++ b/src/XTMF2/RuntimeModules/StepUp.cs @@ -22,7 +22,7 @@ You should have received a copy of the GNU General Public License namespace XTMF2.RuntimeModules { - [Module(Name = "Step Return Up", DocumentationLink = "http://tmg.utoronto.ca/doc/2.0", + [Module(Name = "Step Return Up", DocumentationLink = "https://tmg.utoronto.ca/doc/2.0/xtmf2/modules/XTMF2/RuntimeModules/StepReturnUp.html", Description = "Converts the result of a function to the expected type from the calling module.")] public sealed class StepReturnUp : BaseFunction where Original : ConvertTo @@ -36,7 +36,7 @@ public override ConvertTo Invoke() } } - [Module(Name = "Step Return Up", DocumentationLink = "http://tmg.utoronto.ca/doc/2.0", + [Module(Name = "Step Return Up", DocumentationLink = "https://tmg.utoronto.ca/doc/2.0/xtmf2/modules/XTMF2/RuntimeModules/StepReturnUp.html", Description = "Converts the result of a function to the expected type from the calling module.")] public sealed class StepReturnUp : BaseFunction where Original : ConvertTo @@ -50,7 +50,7 @@ public override ConvertTo Invoke(Context context) } } - [Module(Name = "Step Return Up", DocumentationLink = "http://tmg.utoronto.ca/doc/2.0", + [Module(Name = "Step Return Up", DocumentationLink = "https://tmg.utoronto.ca/doc/2.0/xtmf2/modules/XTMF2/RuntimeModules/StepReturnUp.html", Description = "Converts the result of a function to the expected type from the calling module.")] public sealed class StepActionUp : BaseAction where Original : ConvertTo diff --git a/src/XTMF2/RuntimeModules/WithContext.cs b/src/XTMF2/RuntimeModules/WithContext.cs index 4beda68..03ebbae 100644 --- a/src/XTMF2/RuntimeModules/WithContext.cs +++ b/src/XTMF2/RuntimeModules/WithContext.cs @@ -21,7 +21,7 @@ You should have received a copy of the GNU General Public License namespace XTMF2.RuntimeModules; -[Module(Name = "With Context", DocumentationLink = "http://tmg.utoronto.ca/doc/2.0", +[Module(Name = "With Context", DocumentationLink = "https://tmg.utoronto.ca/doc/2.0/xtmf2/modules/XTMF2/RuntimeModules/WithContext.html", Description = "Provides a way to execute an action with a context loaded from the provided context.")] public sealed class WithContext : BaseAction where Context1 : Context2 { @@ -38,7 +38,7 @@ override public void Invoke() } } -[Module(Name = "Return Using Context", DocumentationLink = "http://tmg.utoronto.ca/doc/2.0", +[Module(Name = "Return Using Context", DocumentationLink = "https://tmg.utoronto.ca/doc/2.0/xtmf2/modules/XTMF2/RuntimeModules/ReturnUsingContext.html", Description = "Provides a way to execute a function with a context loaded from the provided context and return the result.")] public sealed class ReturnUsingContext : BaseFunction { diff --git a/src/XTMF2/RuntimeModules/WriteToLog.cs b/src/XTMF2/RuntimeModules/WriteToLog.cs index fd8e0f0..d46738d 100644 --- a/src/XTMF2/RuntimeModules/WriteToLog.cs +++ b/src/XTMF2/RuntimeModules/WriteToLog.cs @@ -22,7 +22,7 @@ You should have received a copy of the GNU General Public License namespace XTMF2.RuntimeModules { - [Module(Name = "Write to Log", DocumentationLink = "http://tmg.utoronto.ca/doc/2.0", + [Module(Name = "Write to Log", DocumentationLink = "https://tmg.utoronto.ca/doc/2.0/xtmf2/modules/XTMF2/RuntimeModules/WriteToLog.html", Description = "Writes the provided mess to the log and then invokes the next step.")] public sealed class WriteToLogF : BaseFunction { @@ -43,7 +43,7 @@ public override Return Invoke() } } - [Module(Name = "Write to Log", DocumentationLink = "http://tmg.utoronto.ca/doc/2.0", + [Module(Name = "Write to Log", DocumentationLink = "https://tmg.utoronto.ca/doc/2.0/xtmf2/modules/XTMF2/RuntimeModules/WriteToLog.html", Description = "Writes the provided mess to the log and then invokes the next step.")] public sealed class WriteToLogF : BaseFunction { @@ -64,7 +64,7 @@ public override Return Invoke(Context context) } } - [Module(Name = "Write to Log", DocumentationLink = "http://tmg.utoronto.ca/doc/2.0", + [Module(Name = "Write to Log", DocumentationLink = "https://tmg.utoronto.ca/doc/2.0/xtmf2/modules/XTMF2/RuntimeModules/WriteToLog.html", Description = "Writes the provided mess to the log and then invokes the next step.")] public sealed class WriteToLogBasedOnContextF : BaseFunction { @@ -85,7 +85,7 @@ public override Return Invoke(Context context) } } - [Module(Name = "Write to Log", DocumentationLink = "http://tmg.utoronto.ca/doc/2.0", + [Module(Name = "Write to Log", DocumentationLink = "https://tmg.utoronto.ca/doc/2.0/xtmf2/modules/XTMF2/RuntimeModules/WriteToLog.html", Description = "Writes the provided mess to the log and then invokes the next step.")] public sealed class WriteToLogA : BaseAction { @@ -106,7 +106,7 @@ public override void Invoke() } } - [Module(Name = "Write to Log", DocumentationLink = "http://tmg.utoronto.ca/doc/2.0", + [Module(Name = "Write to Log", DocumentationLink = "https://tmg.utoronto.ca/doc/2.0/xtmf2/modules/XTMF2/RuntimeModules/WriteToLog.html", Description = "Writes the provided mess to the log and then invokes the next step.")] public sealed class WriteToLogA : BaseAction { @@ -127,7 +127,7 @@ public override void Invoke(Context context) } } - [Module(Name = "Write to Log", DocumentationLink = "http://tmg.utoronto.ca/doc/2.0", + [Module(Name = "Write to Log", DocumentationLink = "https://tmg.utoronto.ca/doc/2.0/xtmf2/modules/XTMF2/RuntimeModules/WriteToLog.html", Description = "Writes the provided mess to the log and then invokes the next step.")] public sealed class WriteToLogBasedOnContextA : BaseAction {