Noi/RegexBot
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Adding clarification

Browse source
This commit is contained in:
Noikoio 2018-02-27 12:32:12 -08:00
parent 8c0ae8fd44
commit 419370c379
1 changed files with 3 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
BotModule.cs
View file

@ -25,6 +25,7 @@ namespace Noikoio.RegexBot
/// <summary>
/// Processes module-specific configuration.
/// This method is not called if the user did not provide configuration for the module.
/// </summary>
/// <remarks>
/// Module code <i>should not</i> hold on to this data, but instead use <see cref="GetConfig(ulong)"/> to retrieve
@ -36,8 +37,8 @@ namespace Noikoio.RegexBot
/// Processed configuration data prepared for later use.
/// </returns>
/// <exception cref="ConfigItem.RuleImportException">
/// This method should throw RuleImportException in the event of any error.
/// The exception message will be properly logged.
/// This method should throw <see cref="ConfigItem.RuleImportException"/>
/// in the event of configuration errors. The exception message will be properly displayed.
/// </exception>
public abstract Task<object> ProcessConfiguration(JToken configSection);