docs: complete XML doc coverage (returns, summaries, inheritdoc)
Resolve all 622 issues flagged by the enhanced CommentChecker: add missing <returns> tags (incl. the standard phrasing on non-generic Task methods), add missing <summary> tags, and replace misused/redundant <inheritdoc/> on members that override or implement nothing with real documentation. Documentation-only — no behavior change; solution builds clean.
This commit is contained in:
@@ -36,6 +36,7 @@ public class SharedScriptLibrary
|
||||
/// </summary>
|
||||
/// <param name="name">Unique name for the shared script.</param>
|
||||
/// <param name="code">C# source code of the shared script.</param>
|
||||
/// <returns><c>true</c> if compilation succeeded and the script was registered; <c>false</c> if compilation failed.</returns>
|
||||
public bool CompileAndRegister(string name, string code)
|
||||
{
|
||||
var result = _compilationService.Compile(name, code);
|
||||
@@ -60,6 +61,7 @@ public class SharedScriptLibrary
|
||||
/// Removes a shared script from the library.
|
||||
/// </summary>
|
||||
/// <param name="name">Name of the shared script to remove.</param>
|
||||
/// <returns><c>true</c> if the script was found and removed; <c>false</c> if no script with that name was registered.</returns>
|
||||
public bool Remove(string name)
|
||||
{
|
||||
lock (_lock)
|
||||
@@ -76,6 +78,7 @@ public class SharedScriptLibrary
|
||||
/// <param name="context">Runtime context providing instance state and services to the script globals.</param>
|
||||
/// <param name="parameters">Optional input parameters passed to the script.</param>
|
||||
/// <param name="cancellationToken">Cancellation token for the execution.</param>
|
||||
/// <returns>A task that resolves to the script's return value, or <c>null</c> if the script returns nothing.</returns>
|
||||
public async Task<object?> ExecuteAsync(
|
||||
string scriptName,
|
||||
ScriptRuntimeContext context,
|
||||
@@ -106,6 +109,7 @@ public class SharedScriptLibrary
|
||||
/// <summary>
|
||||
/// Returns the names of all currently registered shared scripts.
|
||||
/// </summary>
|
||||
/// <returns>A snapshot list of all registered script names at the time of the call.</returns>
|
||||
public IReadOnlyList<string> GetRegisteredScriptNames()
|
||||
{
|
||||
lock (_lock)
|
||||
@@ -118,6 +122,7 @@ public class SharedScriptLibrary
|
||||
/// Returns whether a script with the given name is registered.
|
||||
/// </summary>
|
||||
/// <param name="name">Name of the shared script to look up.</param>
|
||||
/// <returns><c>true</c> if a script with the given name is registered; otherwise <c>false</c>.</returns>
|
||||
public bool Contains(string name)
|
||||
{
|
||||
lock (_lock)
|
||||
|
||||
Reference in New Issue
Block a user