Skip to content

Commit

Permalink
Update website DocFX
Browse files Browse the repository at this point in the history
  • Loading branch information
MrDave1999 committed Mar 20, 2024
1 parent ca6872f commit 94dc271
Show file tree
Hide file tree
Showing 8 changed files with 498 additions and 45 deletions.
208 changes: 208 additions & 0 deletions api/CPlugin.Net.CPluginServiceCollectionExtensions.AddSubtypesOf.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,208 @@
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>

<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Method AddSubtypesOf
| CPlugin.Net </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Method AddSubtypesOf
| CPlugin.Net ">
<meta name="generator" content="docfx 2.59.4.0">

<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
<link rel="stylesheet" href="../styles/docfx.css">
<link rel="stylesheet" href="../styles/main.css">
<meta property="docfx:navrel" content="../toc.html">
<meta property="docfx:tocrel" content="toc.html">

<meta property="docfx:rel" content="../">
<meta property="docfx:newtab" content="true">
</head>
<body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>

<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>

<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../logo.svg" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>

<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div class="container body-content">

<div id="search-results">
<div class="search-list">Search Results for <span></span></div>
<div class="sr-items">
<p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
</div>
<ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
</div>
</div>
<div role="main" class="container body-content hide-when-search">

<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="CPlugin.Net.CPluginServiceCollectionExtensions.AddSubtypesOf*">

<h1 id="CPlugin_Net_CPluginServiceCollectionExtensions_AddSubtypesOf_" data-uid="CPlugin.Net.CPluginServiceCollectionExtensions.AddSubtypesOf*">Method AddSubtypesOf
</h1>
<div class="markdown level0 summary"></div>
<div class="markdown level0 conceptual"></div>

<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_CPluginServiceCollectionExtensions_AddSubtypesOf__1_Microsoft_Extensions_DependencyInjection_IServiceCollection_Microsoft_Extensions_DependencyInjection_ServiceLifetime_.md&amp;value=---%0Auid%3A%20CPlugin.Net.CPluginServiceCollectionExtensions.AddSubtypesOf%60%601(Microsoft.Extensions.DependencyInjection.IServiceCollection%2CMicrosoft.Extensions.DependencyInjection.ServiceLifetime)%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/ServiceCollectionExtensions.cs/#L31">View Source</a>
</span>
<a id="CPlugin_Net_CPluginServiceCollectionExtensions_AddSubtypesOf_" data-uid="CPlugin.Net.CPluginServiceCollectionExtensions.AddSubtypesOf*"></a>
<h4 id="CPlugin_Net_CPluginServiceCollectionExtensions_AddSubtypesOf__1_Microsoft_Extensions_DependencyInjection_IServiceCollection_Microsoft_Extensions_DependencyInjection_ServiceLifetime_" data-uid="CPlugin.Net.CPluginServiceCollectionExtensions.AddSubtypesOf``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,Microsoft.Extensions.DependencyInjection.ServiceLifetime)">AddSubtypesOf&lt;TSupertype&gt;(IServiceCollection, ServiceLifetime)</h4>
<div class="markdown level1 summary"><p>Adds the subtypes that implement the contract specified by <code data-dev-comment-type="typeparamref" class="typeparamref">TSupertype</code>
to the service collection, using the assemblies loaded by <a class="xref" href="CPlugin.Net.PluginLoader.html">PluginLoader</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static IServiceCollection AddSubtypesOf&lt;TSupertype&gt;(this IServiceCollection services, ServiceLifetime serviceLifetime)
where TSupertype : class</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/microsoft.extensions.dependencyinjection.iservicecollection">IServiceCollection</a></td>
<td><span class="parametername">services</span></td>
<td><p>The <a class="xref" href="https://learn.microsoft.com/dotnet/api/microsoft.extensions.dependencyinjection.iservicecollection">IServiceCollection</a> to add the service to.</p>
</td>
</tr>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/microsoft.extensions.dependencyinjection.servicelifetime">ServiceLifetime</a></td>
<td><span class="parametername">serviceLifetime</span></td>
<td><p>Specifies the lifetime of the services to be added to the service collection.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</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/microsoft.extensions.dependencyinjection.iservicecollection">IServiceCollection</a></td>
<td><p>A reference to this instance after the operation has completed.</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">TSupertype</span></td>
<td><p>The type of contract (base type) shared between the host application and the plugins.</p>
</td>
</tr>
</tbody>
</table>
<h5 id="CPlugin_Net_CPluginServiceCollectionExtensions_AddSubtypesOf__1_Microsoft_Extensions_DependencyInjection_IServiceCollection_Microsoft_Extensions_DependencyInjection_ServiceLifetime__remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>This method uses the <a class="xref" href="CPlugin.Net.PluginAttribute.html">PluginAttribute</a> type to add the implementations of the contract
to the service collection, so plugins must use it.</p>
</div>
</article>
</div>

<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
<li>
<a href="https://github.com/MrDave1999/CPlugin.Net/new/master/apiSpec/new?filename=CPlugin_Net_CPluginServiceCollectionExtensions_AddSubtypesOf_.md&amp;value=---%0Auid%3A%20CPlugin.Net.CPluginServiceCollectionExtensions.AddSubtypesOf*%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/ServiceCollectionExtensions.cs/#L31" class="contribution-link">View Source</a>
</li>
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<h5>In This Article</h5>
<div></div>
</nav>
</div>
</div>
</div>
</div>

<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
Copyright ©2023 <b>CPlugin.Net</b>

</div>
</div>
</footer>
</div>

<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
<script type="text/javascript" src="../styles/docfx.js"></script>
<script type="text/javascript" src="../styles/main.js"></script>
</body>
</html>
186 changes: 186 additions & 0 deletions api/CPlugin.Net.CPluginServiceCollectionExtensions.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,186 @@
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>

<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class CPluginServiceCollectionExtensions
| CPlugin.Net </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class CPluginServiceCollectionExtensions
| CPlugin.Net ">
<meta name="generator" content="docfx 2.59.4.0">

<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
<link rel="stylesheet" href="../styles/docfx.css">
<link rel="stylesheet" href="../styles/main.css">
<meta property="docfx:navrel" content="../toc.html">
<meta property="docfx:tocrel" content="toc.html">

<meta property="docfx:rel" content="../">
<meta property="docfx:newtab" content="true">
</head>
<body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>

<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>

<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../logo.svg" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>

<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div class="container body-content">

<div id="search-results">
<div class="search-list">Search Results for <span></span></div>
<div class="sr-items">
<p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
</div>
<ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
</div>
</div>
<div role="main" class="container body-content hide-when-search">

<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="CPlugin.Net.CPluginServiceCollectionExtensions">


<h1 id="CPlugin_Net_CPluginServiceCollectionExtensions" data-uid="CPlugin.Net.CPluginServiceCollectionExtensions" class="text-break">Class CPluginServiceCollectionExtensions
</h1>
<div class="markdown level0 summary"><p>Extension methods for adding services to an <a class="xref" href="https://learn.microsoft.com/dotnet/api/microsoft.extensions.dependencyinjection.iservicecollection">IServiceCollection</a>.</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
<h5>Inheritance</h5>
<div class="level0"><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">Object</a></div>
<div class="level1"><span class="xref">CPluginServiceCollectionExtensions</span></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">Object.Equals(Object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">Object.Equals(Object, Object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode#system-object-gethashcode">Object.GetHashCode()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype#system-object-gettype">Object.GetType()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone#system-object-memberwiseclone">Object.MemberwiseClone()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals#system-object-referenceequals(system-object-system-object)">Object.ReferenceEquals(Object, Object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring#system-object-tostring">Object.ToString()</a>
</div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="CPlugin.Net.html">CPlugin.Net</a></h6>
<h6><strong>Assembly</strong>: CPlugin.Net.dll</h6>
<h5 id="CPlugin_Net_CPluginServiceCollectionExtensions_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static class CPluginServiceCollectionExtensions</code></pre>
</div>
<h3 id="methods">Methods
</h3>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td id="CPlugin_Net_CPluginServiceCollectionExtensions_AddSubtypesOf__1_Microsoft_Extensions_DependencyInjection_IServiceCollection_Microsoft_Extensions_DependencyInjection_ServiceLifetime_" data-uid="CPlugin.Net.CPluginServiceCollectionExtensions.AddSubtypesOf``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,Microsoft.Extensions.DependencyInjection.ServiceLifetime)">
<a class="xref" href="CPlugin.Net.CPluginServiceCollectionExtensions.AddSubtypesOf.html#CPlugin_Net_CPluginServiceCollectionExtensions_AddSubtypesOf__1_Microsoft_Extensions_DependencyInjection_IServiceCollection_Microsoft_Extensions_DependencyInjection_ServiceLifetime_">AddSubtypesOf&lt;TSupertype&gt;(IServiceCollection, ServiceLifetime)</a>
</td>
<td class="markdown level1 summary"><p>Adds the subtypes that implement the contract specified by <code data-dev-comment-type="typeparamref" class="typeparamref">TSupertype</code>
to the service collection, using the assemblies loaded by <a class="xref" href="CPlugin.Net.PluginLoader.html">PluginLoader</a>.</p>
</td>
</tr>
</tbody>
</table>
</article>
</div>

<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
<li>
<a href="https://github.com/MrDave1999/CPlugin.Net/new/master/apiSpec/new?filename=CPlugin_Net_CPluginServiceCollectionExtensions.md&amp;value=---%0Auid%3A%20CPlugin.Net.CPluginServiceCollectionExtensions%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/ServiceCollectionExtensions.cs/#L9" class="contribution-link">View Source</a>
</li>
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<h5>In This Article</h5>
<div></div>
</nav>
</div>
</div>
</div>
</div>

<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
Copyright ©2023 <b>CPlugin.Net</b>

</div>
</div>
</footer>
</div>

<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
<script type="text/javascript" src="../styles/docfx.js"></script>
<script type="text/javascript" src="../styles/main.js"></script>
</body>
</html>
Loading

0 comments on commit 94dc271

Please sign in to comment.