Skip to content

Commit d1e5c78

Browse files
committed
style: Add XML comments to missing members
1 parent d94c966 commit d1e5c78

3 files changed

Lines changed: 8 additions & 0 deletions

File tree

src/Attributes/PluginAttribute.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ namespace CPlugin.Net;
44

55
/// <summary>
66
/// This attribute is required so that the plugin loader can create the instance of the type that implements the contract.
7+
/// <para>Example:</para>
8+
/// <c>[assembly: Plugin(typeof(PluginStartup))]</c>
79
/// </summary>
810
[AttributeUsage(AttributeTargets.Assembly, Inherited = false, AllowMultiple = true)]
911
public class PluginAttribute : Attribute

src/Core/Configuration/CPluginJsonConfiguration.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,9 @@ public class CPluginJsonConfiguration : CPluginConfigurationBase
2222
/// <summary>
2323
/// Initializes a new instance of the <see cref="CPluginJsonConfiguration"/> class.
2424
/// </summary>
25+
/// <param name="configuration">
26+
/// A set of key/value application configuration properties.
27+
/// </param>
2528
/// <exception cref="ArgumentNullException">
2629
/// <c>configuration</c> is <c>null</c>.
2730
/// </exception>

src/Core/PluginLoader.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,9 @@ public static void SetConfiguration(CPluginConfigurationBase configuration)
5050
/// An instance of type <see cref="IEnumerable{TContract}"/> that contains the instances
5151
/// that implement the contract specified by <typeparamref name="TContract"/>.
5252
/// </returns>
53+
/// <exception cref="InvalidOperationException">
54+
/// If a plugin does not use the <see cref="PluginAttribute"/> type at the assembly level.
55+
/// </exception>
5356
public static IEnumerable<TContract> Load<TContract>() where TContract : class
5457
{
5558
var contracts = new List<TContract>();

0 commit comments

Comments
 (0)