Skip to content

Commit

Permalink
Update website DocFX
Browse files Browse the repository at this point in the history
  • Loading branch information
MrDave1999 committed Dec 4, 2023
1 parent 4ca0168 commit 6e60ffb
Show file tree
Hide file tree
Showing 17 changed files with 543 additions and 138 deletions.
19 changes: 3 additions & 16 deletions api/CPlugin.Net.CPluginConfigurationBase.GetPluginPath.html
Original file line number Diff line number Diff line change
Expand Up @@ -135,22 +135,9 @@ <h5 class="returns">Returns</h5>
</tr>
</tbody>
</table>
<h5 class="exceptions">Exceptions</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Condition</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.argumentexception">ArgumentException</a></td>
<td><p><code>pluginFile</code> does not have .dll extension.</p>
</td>
</tr>
</tbody>
</table>
<h5 id="CPlugin_Net_CPluginConfigurationBase_GetPluginPath_System_String__remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>If the plugin name does not have the <code>.dll</code> extension, it is added by default.</p>
</div>
</article>
</div>

Expand Down
4 changes: 2 additions & 2 deletions api/CPlugin.Net.CPluginEnvConfiguration.-ctor.html
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ <h1 id="CPlugin_Net_CPluginEnvConfiguration__ctor_" data-uid="CPlugin.Net.CPlugi
<a href="https://github.com/MrDave1999/CPlugin.Net/new/master/apiSpec/new?filename=CPlugin_Net_CPluginEnvConfiguration__ctor.md&amp;value=---%0Auid%3A%20CPlugin.Net.CPluginEnvConfiguration.%23ctor%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/MrDave1999/CPlugin.Net/blob/master/src/Core/Configuration/CPluginEnvConfiguration.cs/#L20">View Source</a>
<a href="https://github.com/MrDave1999/CPlugin.Net/blob/master/src/Core/Configuration/CPluginEnvConfiguration.cs/#L22">View Source</a>
</span>
<a id="CPlugin_Net_CPluginEnvConfiguration__ctor_" data-uid="CPlugin.Net.CPluginEnvConfiguration.#ctor*"></a>
<h4 id="CPlugin_Net_CPluginEnvConfiguration__ctor" data-uid="CPlugin.Net.CPluginEnvConfiguration.#ctor">CPluginEnvConfiguration()</h4>
Expand All @@ -112,7 +112,7 @@ <h5 class="decalaration">Declaration</h5>
<a href="https://github.com/MrDave1999/CPlugin.Net/new/master/apiSpec/new?filename=CPlugin_Net_CPluginEnvConfiguration__ctor_.md&amp;value=---%0Auid%3A%20CPlugin.Net.CPluginEnvConfiguration.%23ctor*%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
</li>
<li>
<a href="https://github.com/MrDave1999/CPlugin.Net/blob/master/src/Core/Configuration/CPluginEnvConfiguration.cs/#L20" class="contribution-link">View Source</a>
<a href="https://github.com/MrDave1999/CPlugin.Net/blob/master/src/Core/Configuration/CPluginEnvConfiguration.cs/#L22" class="contribution-link">View Source</a>
</li>
</ul>
</div>
Expand Down
4 changes: 2 additions & 2 deletions api/CPlugin.Net.CPluginEnvConfiguration.GetPluginFiles.html
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ <h1 id="CPlugin_Net_CPluginEnvConfiguration_GetPluginFiles_" data-uid="CPlugin.N
<a href="https://github.com/MrDave1999/CPlugin.Net/new/master/apiSpec/new?filename=CPlugin_Net_CPluginEnvConfiguration_GetPluginFiles.md&amp;value=---%0Auid%3A%20CPlugin.Net.CPluginEnvConfiguration.GetPluginFiles%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/MrDave1999/CPlugin.Net/blob/master/src/Core/Configuration/CPluginEnvConfiguration.cs/#L23">View Source</a>
<a href="https://github.com/MrDave1999/CPlugin.Net/blob/master/src/Core/Configuration/CPluginEnvConfiguration.cs/#L25">View Source</a>
</span>
<a id="CPlugin_Net_CPluginEnvConfiguration_GetPluginFiles_" data-uid="CPlugin.Net.CPluginEnvConfiguration.GetPluginFiles*"></a>
<h4 id="CPlugin_Net_CPluginEnvConfiguration_GetPluginFiles" data-uid="CPlugin.Net.CPluginEnvConfiguration.GetPluginFiles">GetPluginFiles()</h4>
Expand Down Expand Up @@ -140,7 +140,7 @@ <h5 id="CPlugin_Net_CPluginEnvConfiguration_GetPluginFiles_remarks">Remarks</h5>
<a href="https://github.com/MrDave1999/CPlugin.Net/new/master/apiSpec/new?filename=CPlugin_Net_CPluginEnvConfiguration_GetPluginFiles_.md&amp;value=---%0Auid%3A%20CPlugin.Net.CPluginEnvConfiguration.GetPluginFiles*%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
</li>
<li>
<a href="https://github.com/MrDave1999/CPlugin.Net/blob/master/src/Core/Configuration/CPluginEnvConfiguration.cs/#L23" class="contribution-link">View Source</a>
<a href="https://github.com/MrDave1999/CPlugin.Net/blob/master/src/Core/Configuration/CPluginEnvConfiguration.cs/#L25" class="contribution-link">View Source</a>
</li>
</ul>
</div>
Expand Down
8 changes: 5 additions & 3 deletions api/CPlugin.Net.PluginAttribute.-ctor.html
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ <h1 id="CPlugin_Net_PluginAttribute__ctor_" data-uid="CPlugin.Net.PluginAttribut
<a href="https://github.com/MrDave1999/CPlugin.Net/new/master/apiSpec/new?filename=CPlugin_Net_PluginAttribute__ctor_System_Type_.md&amp;value=---%0Auid%3A%20CPlugin.Net.PluginAttribute.%23ctor(System.Type)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/MrDave1999/CPlugin.Net/blob/master/src/Attributes/PluginAttribute.cs/#L30">View Source</a>
<a href="https://github.com/MrDave1999/CPlugin.Net/blob/master/src/Attributes/PluginAttribute.cs/#L40">View Source</a>
</span>
<a id="CPlugin_Net_PluginAttribute__ctor_" data-uid="CPlugin.Net.PluginAttribute.#ctor*"></a>
<h4 id="CPlugin_Net_PluginAttribute__ctor_System_Type_" data-uid="CPlugin.Net.PluginAttribute.#ctor(System.Type)">PluginAttribute(Type)</h4>
Expand Down Expand Up @@ -135,7 +135,9 @@ <h5 class="exceptions">Exceptions</h5>
</tr>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.argumentexception">ArgumentException</a></td>
<td><p><code>pluginType</code> is not instantiable.</p>
<td><p><code>pluginType</code> is an interface or abstract class.</p>
<p>or</p>
<code>pluginType</code> is not an instantiable class.
</td>
</tr>
</tbody>
Expand All @@ -151,7 +153,7 @@ <h5 class="exceptions">Exceptions</h5>
<a href="https://github.com/MrDave1999/CPlugin.Net/new/master/apiSpec/new?filename=CPlugin_Net_PluginAttribute__ctor_.md&amp;value=---%0Auid%3A%20CPlugin.Net.PluginAttribute.%23ctor*%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
</li>
<li>
<a href="https://github.com/MrDave1999/CPlugin.Net/blob/master/src/Attributes/PluginAttribute.cs/#L30" class="contribution-link">View Source</a>
<a href="https://github.com/MrDave1999/CPlugin.Net/blob/master/src/Attributes/PluginAttribute.cs/#L40" class="contribution-link">View Source</a>
</li>
</ul>
</div>
Expand Down
4 changes: 2 additions & 2 deletions api/CPlugin.Net.PluginAttribute.PluginType.html
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ <h1 id="CPlugin_Net_PluginAttribute_PluginType_" data-uid="CPlugin.Net.PluginAtt
<a href="https://github.com/MrDave1999/CPlugin.Net/new/master/apiSpec/new?filename=CPlugin_Net_PluginAttribute_PluginType.md&amp;value=---%0Auid%3A%20CPlugin.Net.PluginAttribute.PluginType%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/MrDave1999/CPlugin.Net/blob/master/src/Attributes/PluginAttribute.cs/#L16">View Source</a>
<a href="https://github.com/MrDave1999/CPlugin.Net/blob/master/src/Attributes/PluginAttribute.cs/#L24">View Source</a>
</span>
<a id="CPlugin_Net_PluginAttribute_PluginType_" data-uid="CPlugin.Net.PluginAttribute.PluginType*"></a>
<h4 id="CPlugin_Net_PluginAttribute_PluginType" data-uid="CPlugin.Net.PluginAttribute.PluginType">PluginType</h4>
Expand Down Expand Up @@ -127,7 +127,7 @@ <h5 class="propertyValue">Property Value</h5>
<a href="https://github.com/MrDave1999/CPlugin.Net/new/master/apiSpec/new?filename=CPlugin_Net_PluginAttribute_PluginType_.md&amp;value=---%0Auid%3A%20CPlugin.Net.PluginAttribute.PluginType*%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
</li>
<li>
<a href="https://github.com/MrDave1999/CPlugin.Net/blob/master/src/Attributes/PluginAttribute.cs/#L16" class="contribution-link">View Source</a>
<a href="https://github.com/MrDave1999/CPlugin.Net/blob/master/src/Attributes/PluginAttribute.cs/#L24" class="contribution-link">View Source</a>
</li>
</ul>
</div>
Expand Down
16 changes: 12 additions & 4 deletions api/CPlugin.Net.PluginAttribute.html
Original file line number Diff line number Diff line change
Expand Up @@ -83,9 +83,7 @@

<h1 id="CPlugin_Net_PluginAttribute" data-uid="CPlugin.Net.PluginAttribute" class="text-break">Class PluginAttribute
</h1>
<div class="markdown level0 summary"><p>This attribute is required so that the plugin loader can create the instance of the type that implements the contract.</p>
<p>Example:</p>
<code>[assembly: Plugin(typeof(PluginStartup))]</code>
<div class="markdown level0 summary"><p>This attribute is required so that the type finder can create the instance of the subtype that implements the contract.</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
Expand Down Expand Up @@ -230,6 +228,16 @@ <h5 id="CPlugin_Net_PluginAttribute_syntax">Syntax</h5>
<pre><code class="lang-csharp hljs">[AttributeUsage(AttributeTargets.Assembly, Inherited = false, AllowMultiple = true)]
public class PluginAttribute : Attribute</code></pre>
</div>
<h5 id="CPlugin_Net_PluginAttribute_remarks"><strong>Remarks</strong></h5>
<div class="markdown level0 remarks"><p>Example:</p>
<p>
<code>IPluginStartup</code> represents the contract and can reside in its own project called <code>App.Contracts</code>.
</p>
<p>Each plugin must implement the contract in this way:</p>
<code>class Startup : IPluginStartup { }</code>
<p>And then add this line before the namespace declaration:</p>
<code>[assembly: Plugin(typeof(Startup))]</code>
</div>
<h3 id="constructors">Constructors
</h3>
<table class="table table-bordered table-striped table-condensed">
Expand Down Expand Up @@ -279,7 +287,7 @@ <h3 id="properties">Properties
<a href="https://github.com/MrDave1999/CPlugin.Net/new/master/apiSpec/new?filename=CPlugin_Net_PluginAttribute.md&amp;value=---%0Auid%3A%20CPlugin.Net.PluginAttribute%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
</li>
<li>
<a href="https://github.com/MrDave1999/CPlugin.Net/blob/master/src/Attributes/PluginAttribute.cs/#L10" class="contribution-link">View Source</a>
<a href="https://github.com/MrDave1999/CPlugin.Net/blob/master/src/Attributes/PluginAttribute.cs/#L18" class="contribution-link">View Source</a>
</li>
</ul>
</div>
Expand Down
4 changes: 2 additions & 2 deletions api/CPlugin.Net.PluginLoader.Assemblies.html
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ <h1 id="CPlugin_Net_PluginLoader_Assemblies_" data-uid="CPlugin.Net.PluginLoader
<a href="https://github.com/MrDave1999/CPlugin.Net/new/master/apiSpec/new?filename=CPlugin_Net_PluginLoader_Assemblies.md&amp;value=---%0Auid%3A%20CPlugin.Net.PluginLoader.Assemblies%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/MrDave1999/CPlugin.Net/blob/master/src/Core/PluginLoader.cs/#L19">View Source</a>
<a href="https://github.com/MrDave1999/CPlugin.Net/blob/master/src/Core/PluginLoader.cs/#L18">View Source</a>
</span>
<a id="CPlugin_Net_PluginLoader_Assemblies_" data-uid="CPlugin.Net.PluginLoader.Assemblies*"></a>
<h4 id="CPlugin_Net_PluginLoader_Assemblies" data-uid="CPlugin.Net.PluginLoader.Assemblies">Assemblies</h4>
Expand Down Expand Up @@ -127,7 +127,7 @@ <h5 class="propertyValue">Property Value</h5>
<a href="https://github.com/MrDave1999/CPlugin.Net/new/master/apiSpec/new?filename=CPlugin_Net_PluginLoader_Assemblies_.md&amp;value=---%0Auid%3A%20CPlugin.Net.PluginLoader.Assemblies*%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
</li>
<li>
<a href="https://github.com/MrDave1999/CPlugin.Net/blob/master/src/Core/PluginLoader.cs/#L19" class="contribution-link">View Source</a>
<a href="https://github.com/MrDave1999/CPlugin.Net/blob/master/src/Core/PluginLoader.cs/#L18" class="contribution-link">View Source</a>
</li>
</ul>
</div>
Expand Down
48 changes: 17 additions & 31 deletions api/CPlugin.Net.PluginLoader.Load.html
Original file line number Diff line number Diff line change
Expand Up @@ -87,57 +87,43 @@ <h1 id="CPlugin_Net_PluginLoader_Load_" data-uid="CPlugin.Net.PluginLoader.Load*

<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/MrDave1999/CPlugin.Net/new/master/apiSpec/new?filename=CPlugin_Net_PluginLoader_Load__1.md&amp;value=---%0Auid%3A%20CPlugin.Net.PluginLoader.Load%60%601%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
<a href="https://github.com/MrDave1999/CPlugin.Net/new/master/apiSpec/new?filename=CPlugin_Net_PluginLoader_Load_CPlugin_Net_CPluginConfigurationBase_.md&amp;value=---%0Auid%3A%20CPlugin.Net.PluginLoader.Load(CPlugin.Net.CPluginConfigurationBase)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/MrDave1999/CPlugin.Net/blob/master/src/Core/PluginLoader.cs/#L59">View Source</a>
<a href="https://github.com/MrDave1999/CPlugin.Net/blob/master/src/Core/PluginLoader.cs/#L32">View Source</a>
</span>
<a id="CPlugin_Net_PluginLoader_Load_" data-uid="CPlugin.Net.PluginLoader.Load*"></a>
<h4 id="CPlugin_Net_PluginLoader_Load__1" data-uid="CPlugin.Net.PluginLoader.Load``1">Load&lt;TContract&gt;()</h4>
<div class="markdown level1 summary"><p>Loads the plugins together with the specified contract.</p>
<h4 id="CPlugin_Net_PluginLoader_Load_CPlugin_Net_CPluginConfigurationBase_" data-uid="CPlugin.Net.PluginLoader.Load(CPlugin.Net.CPluginConfigurationBase)">Load(CPluginConfigurationBase)</h4>
<div class="markdown level1 summary"><p>Loads plugins from a configuration source specified by the <code>configuration</code> parameter.
This means that the plugin names can be obtained from a json or .env file.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static IEnumerable&lt;TContract&gt; Load&lt;TContract&gt;()
where TContract : class</code></pre>
<pre><code class="lang-csharp hljs">public static void Load(CPluginConfigurationBase configuration)</code></pre>
</div>
<h5 class="returns">Returns</h5>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a>&lt;TContract&gt;</td>
<td><p>An instance of type <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable&lt;T&gt;</a> that contains the instances
that implement the contract specified by <code data-dev-comment-type="typeparamref" class="typeparamref">TContract</code>.</p>
<p>or</p>
Returns an empty enumerable when the plugin names could not be obtained from a configuration source.
<p>This method never returns <code>null</code>.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="typeParameters">Type Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="parametername">TContract</span></td>
<td><p>The type of contract shared between the host application and the plugins.</p>
<td><a class="xref" href="CPlugin.Net.CPluginConfigurationBase.html">CPluginConfigurationBase</a></td>
<td><span class="parametername">configuration</span></td>
<td><p>A configuration source to get the plugin files.</p>
</td>
</tr>
</tbody>
</table>
<h5 id="CPlugin_Net_PluginLoader_Load_CPlugin_Net_CPluginConfigurationBase__remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>This method is idempotent, so if this method is called N times,
it will not reload assemblies that have already been loaded.</p>
</div>
<h5 class="exceptions">Exceptions</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
Expand All @@ -148,8 +134,8 @@ <h5 class="exceptions">Exceptions</h5>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.invalidoperationexception">InvalidOperationException</a></td>
<td><p>If a plugin does not use the <a class="xref" href="CPlugin.Net.PluginAttribute.html">PluginAttribute</a> type at the assembly level.</p>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.argumentnullexception">ArgumentNullException</a></td>
<td><p><code>configuration</code> is <code>null</code>.</p>
</td>
</tr>
</tbody>
Expand All @@ -165,7 +151,7 @@ <h5 class="exceptions">Exceptions</h5>
<a href="https://github.com/MrDave1999/CPlugin.Net/new/master/apiSpec/new?filename=CPlugin_Net_PluginLoader_Load_.md&amp;value=---%0Auid%3A%20CPlugin.Net.PluginLoader.Load*%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
</li>
<li>
<a href="https://github.com/MrDave1999/CPlugin.Net/blob/master/src/Core/PluginLoader.cs/#L59" class="contribution-link">View Source</a>
<a href="https://github.com/MrDave1999/CPlugin.Net/blob/master/src/Core/PluginLoader.cs/#L32" class="contribution-link">View Source</a>
</li>
</ul>
</div>
Expand Down
Loading

0 comments on commit 6e60ffb

Please sign in to comment.