Skip to content

Commit 453300b

Browse files
jeremydmillerjeremydmiller
committed
Documentation Update for 4.5.0
1 parent a0e53f5 commit 453300b

File tree

62 files changed

+131
-131
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

62 files changed

+131
-131
lines changed

‎autofactory/index.html

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
<nav class="navbar navbar-default navbar-fixed-top" role="banner">
3232
<div class="container">
3333
<div class="navbar-header">
34-
<a href="/" class="navbar-brand">StructureMap 4.4.3</a>
34+
<a href="/" class="navbar-brand">StructureMap 4.5.0</a>
3535
</div>
3636
<nav class="collapse navbar-collapse" role="navigation">
3737
<ul class="nav navbar-nav pull-right">
@@ -74,7 +74,7 @@
7474

7575
<div class="col-md-3" id="leftCol">
7676
<ul class="nav nav-stacked affix" id="sidebar">
77-
<li><h3><img src="/content/images/structuremap-logo-210x210.png" alt="StructureMap 4.4.3" width="210" height="210"></h3></li>
77+
<li><h3><img src="/content/images/structuremap-logo-210x210.png" alt="StructureMap 4.5.0" width="210" height="210"></h3></li>
7878
<li><h3 class="no-margin">Next</h3><p><a href="/best-practices">Best Practices</a></p></li>
7979
<li><h3 class="no-margin">Previous</h3><a href="/dynamic-interception">Aspect Oriented Programming with StructureMap.DynamicInterception</a></p></li>
8080
</ul>
@@ -95,9 +95,9 @@ <h1>Auto-factories <a href="https://github.com/structuremap/structuremap/blob/ma
9595
with implementation
9696
<pre><code class="language-csharp">&#xD;&#xA;public class DummyService : IDummyService&#xD;&#xA;{&#xD;&#xA; public string Name { get; set; }&#xD;&#xA;}&#xD;&#xA;&#xD;&#xA;</code></pre>
9797
<p>Now you declare an interface for your factory:</p>
98-
<pre><code class="language-csharp">&#xD;&#xA;public interface ISimpleDummyFactory&#xD;&#xA;{&#xD;&#xA; IDummyService CreateDummyService();&#xD;&#xA;}&#xD;&#xA;&#xD;&#xA;</code></pre>
98+
<p class="bg-warning" style="padding:10px"><b>Missing code sample &#x27;ISimpleDummyFactory&#x27;</b><small> -- Wait for dotnet stdocs to catch up reading samples or CTRL&#x2B;SHIFT&#x2B;R to force refresh</small></p>
9999
<p>All you need to do is to call <code>CreateFactory</code> when configuring the container as shown below:</p>
100-
<pre><code class="language-csharp">&#xD;&#xA;[Fact]&#xD;&#xA;public void Simple_factory_creation()&#xD;&#xA;{&#xD;&#xA; var container = new Container(cfg =&gt;&#xD;&#xA; {&#xD;&#xA; cfg.For&lt;IDummyService&gt;().Use&lt;DummyService&gt;();&#xD;&#xA; cfg.For&lt;ISimpleDummyFactory&gt;().CreateFactory();&#xD;&#xA; });&#xD;&#xA;&#xD;&#xA; var factory = container.GetInstance&lt;ISimpleDummyFactory&gt;();&#xD;&#xA;&#xD;&#xA; var component = factory.CreateDummyService();&#xD;&#xA;&#xD;&#xA; component.ShouldNotBeNull();&#xD;&#xA; component.ShouldBeOfType&lt;DummyService&gt;();&#xD;&#xA;}&#xD;&#xA;&#xD;&#xA;</code></pre>
100+
<p class="bg-warning" style="padding:10px"><b>Missing code sample &#x27;simple-factory&#x27;</b><small> -- Wait for dotnet stdocs to catch up reading samples or CTRL&#x2B;SHIFT&#x2B;R to force refresh</small></p>
101101
<h2 id="default-convention">Default convention</h2>
102102
<p>As for now, Auto-factories support two types of methods:</p>
103103
<ol>
@@ -115,7 +115,8 @@ <h2 id="default-convention">Default convention</h2>
115115
<pre><code class="language-csharp">&#xD;&#xA;public interface IDummyFactory&#xD;&#xA;{&#xD;&#xA; // This method will return the names of all registered implementations of TService.&#xD;&#xA; IList&lt;string&gt; GetNames&lt;TService&gt;();&#xD;&#xA;&#xD;&#xA; // This method will just create the default IDummyService implementation.&#xD;&#xA; IDummyService CreateDummyService();&#xD;&#xA;&#xD;&#xA; // This method will just create the default IDummyService implementation and pass namePart1 and namePart2 as&#xD;&#xA; // dependencies.&#xD;&#xA; IDummyService CreateDummyService(string namePart1, string namePart2);&#xD;&#xA;&#xD;&#xA; // This method will create IDummyService implementation with serviceName name.&#xD;&#xA; IDummyService GetNamedDummyService(string serviceName, string namePart1, string namePart2);&#xD;&#xA;&#xD;&#xA; // Generic methods are also allowed as factory methods.&#xD;&#xA; TService CreateService&lt;TService&gt;();&#xD;&#xA;&#xD;&#xA; // Something that is common for event-sourcing implementations.&#xD;&#xA; IHandler&lt;TMessage&gt; CreateHandler&lt;TMessage&gt;();&#xD;&#xA;}&#xD;&#xA;&#xD;&#xA;</code></pre>
116116
<h2 id="custom-convention">Custom convention</h2>
117117
<p>If the default convention doesn't work for you, you can create and use your custom convention. All you need is to implement <code>IAutoFactoryConventionProvider</code> and use the corresponding <code>CreateFactory</code> overload. <code>IAutoFactoryConventionProvider</code> has a single method to implement:</p>
118-
<pre><code class="language-csharp">&#xD;&#xA;IAutoFactoryMethodDefinition GetMethodDefinition(MethodInfo methodInfo, IList&lt;object&gt; arguments);&#xD;&#xA;&#xD;&#xA;</code></pre>
118+
<pre><code>IAutoFactoryMethodDefinition GetMethodDefinition(MethodInfo methodInfo, IList&lt;object&gt; arguments);
119+
</code></pre>
119120
<p><code>IAutoFactoryMethodDefinition</code> is defined as follows:</p>
120121
<pre><code class="language-csharp">&#xD;&#xA;/// &lt;summary&gt;&#xD;&#xA;/// Describes how AutoFactory should treat the specific method declared in an abstract factory interface.&#xD;&#xA;/// &lt;/summary&gt;&#xD;&#xA;public interface IAutoFactoryMethodDefinition&#xD;&#xA;{&#xD;&#xA; /// &lt;summary&gt;&#xD;&#xA; /// The method type. See &lt;see cref=&quot;AutoFactoryMethodType&quot;/&gt; for possible values.&#xD;&#xA; /// &lt;/summary&gt;&#xD;&#xA; AutoFactoryMethodType MethodType { get; }&#xD;&#xA;&#xD;&#xA; /// &lt;summary&gt;&#xD;&#xA; /// The instance type to create.&#xD;&#xA; /// &lt;/summary&gt;&#xD;&#xA; Type InstanceType { get; }&#xD;&#xA;&#xD;&#xA; /// &lt;summary&gt;&#xD;&#xA; /// The instance name if available.&#xD;&#xA; /// &lt;/summary&gt;&#xD;&#xA; string InstanceName { get; }&#xD;&#xA;&#xD;&#xA; /// &lt;summary&gt;&#xD;&#xA; /// Explicit arguments if available.&#xD;&#xA; /// &lt;/summary&gt;&#xD;&#xA; ExplicitArguments ExplicitArguments { get; }&#xD;&#xA;}&#xD;&#xA;&#xD;&#xA;</code></pre>
121122

‎best-practices/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
<nav class="navbar navbar-default navbar-fixed-top" role="banner">
3232
<div class="container">
3333
<div class="navbar-header">
34-
<a href="/" class="navbar-brand">StructureMap 4.4.3</a>
34+
<a href="/" class="navbar-brand">StructureMap 4.5.0</a>
3535
</div>
3636
<nav class="collapse navbar-collapse" role="navigation">
3737
<ul class="nav navbar-nav pull-right">
@@ -74,7 +74,7 @@
7474

7575
<div class="col-md-3" id="leftCol">
7676
<ul class="nav nav-stacked affix" id="sidebar">
77-
<li><h3><img src="/content/images/structuremap-logo-210x210.png" alt="StructureMap 4.4.3" width="210" height="210"></h3></li>
77+
<li><h3><img src="/content/images/structuremap-logo-210x210.png" alt="StructureMap 4.5.0" width="210" height="210"></h3></li>
7878
<li><h3 class="no-margin">Next</h3><p><a href="/history">History</a></p></li>
7979
<li><h3 class="no-margin">Previous</h3><a href="/autofactory">Auto-factories</a></p></li>
8080
</ul>

‎diagnostics/build-plans/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
<nav class="navbar navbar-default navbar-fixed-top" role="banner">
3232
<div class="container">
3333
<div class="navbar-header">
34-
<a href="/" class="navbar-brand">StructureMap 4.4.3</a>
34+
<a href="/" class="navbar-brand">StructureMap 4.5.0</a>
3535
</div>
3636
<nav class="collapse navbar-collapse" role="navigation">
3737
<ul class="nav navbar-nav pull-right">
@@ -74,7 +74,7 @@
7474

7575
<div class="col-md-3" id="leftCol">
7676
<ul class="nav nav-stacked affix" id="sidebar">
77-
<li><h3><img src="/content/images/structuremap-logo-210x210.png" alt="StructureMap 4.4.3" width="210" height="210"></h3></li>
77+
<li><h3><img src="/content/images/structuremap-logo-210x210.png" alt="StructureMap 4.5.0" width="210" height="210"></h3></li>
7878
<li><h3 class="no-margin">Next</h3><p><a href="/diagnostics/using-the-container-model">Using the Container Model</a></p></li>
7979
<li><h3 class="no-margin">Previous</h3><a href="/diagnostics/environment-tests">Environment Tests</a></p></li>
8080
</ul>

‎diagnostics/environment-tests/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
<nav class="navbar navbar-default navbar-fixed-top" role="banner">
3232
<div class="container">
3333
<div class="navbar-header">
34-
<a href="/" class="navbar-brand">StructureMap 4.4.3</a>
34+
<a href="/" class="navbar-brand">StructureMap 4.5.0</a>
3535
</div>
3636
<nav class="collapse navbar-collapse" role="navigation">
3737
<ul class="nav navbar-nav pull-right">
@@ -74,7 +74,7 @@
7474

7575
<div class="col-md-3" id="leftCol">
7676
<ul class="nav nav-stacked affix" id="sidebar">
77-
<li><h3><img src="/content/images/structuremap-logo-210x210.png" alt="StructureMap 4.4.3" width="210" height="210"></h3></li>
77+
<li><h3><img src="/content/images/structuremap-logo-210x210.png" alt="StructureMap 4.5.0" width="210" height="210"></h3></li>
7878
<li><h3 class="no-margin">Next</h3><p><a href="/diagnostics/build-plans">Build Plans</a></p></li>
7979
<li><h3 class="no-margin">Previous</h3><a href="/diagnostics/validating-container-configuration">Validating Container Configuration</a></p></li>
8080
</ul>

‎diagnostics/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
<nav class="navbar navbar-default navbar-fixed-top" role="banner">
3232
<div class="container">
3333
<div class="navbar-header">
34-
<a href="/" class="navbar-brand">StructureMap 4.4.3</a>
34+
<a href="/" class="navbar-brand">StructureMap 4.5.0</a>
3535
</div>
3636
<nav class="collapse navbar-collapse" role="navigation">
3737
<ul class="nav navbar-nav pull-right">
@@ -74,7 +74,7 @@
7474

7575
<div class="col-md-3" id="leftCol">
7676
<ul class="nav nav-stacked affix" id="sidebar">
77-
<li><h3><img src="/content/images/structuremap-logo-210x210.png" alt="StructureMap 4.4.3" width="210" height="210"></h3></li>
77+
<li><h3><img src="/content/images/structuremap-logo-210x210.png" alt="StructureMap 4.5.0" width="210" height="210"></h3></li>
7878
<li><h3 class="no-margin">Next</h3><p><a href="/diagnostics/whatdoihave">WhatDoIHave()</a></p></li>
7979
<li><h3 class="no-margin">Previous</h3><a href="/interpreting-exceptions">Interpreting Exceptions</a></p></li>
8080
</ul>

‎diagnostics/type-scanning/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
<nav class="navbar navbar-default navbar-fixed-top" role="banner">
3232
<div class="container">
3333
<div class="navbar-header">
34-
<a href="/" class="navbar-brand">StructureMap 4.4.3</a>
34+
<a href="/" class="navbar-brand">StructureMap 4.5.0</a>
3535
</div>
3636
<nav class="collapse navbar-collapse" role="navigation">
3737
<ul class="nav navbar-nav pull-right">
@@ -74,7 +74,7 @@
7474

7575
<div class="col-md-3" id="leftCol">
7676
<ul class="nav nav-stacked affix" id="sidebar">
77-
<li><h3><img src="/content/images/structuremap-logo-210x210.png" alt="StructureMap 4.4.3" width="210" height="210"></h3></li>
77+
<li><h3><img src="/content/images/structuremap-logo-210x210.png" alt="StructureMap 4.5.0" width="210" height="210"></h3></li>
7878
<li><h3 class="no-margin">Next</h3><p><a href="/dynamic-interception">Aspect Oriented Programming with StructureMap.DynamicInterception</a></p></li>
7979
<li><h3 class="no-margin">Previous</h3><a href="/diagnostics/using-the-container-model">Using the Container Model</a></p></li>
8080
</ul>

‎diagnostics/using-the-container-model/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
<nav class="navbar navbar-default navbar-fixed-top" role="banner">
3232
<div class="container">
3333
<div class="navbar-header">
34-
<a href="/" class="navbar-brand">StructureMap 4.4.3</a>
34+
<a href="/" class="navbar-brand">StructureMap 4.5.0</a>
3535
</div>
3636
<nav class="collapse navbar-collapse" role="navigation">
3737
<ul class="nav navbar-nav pull-right">
@@ -74,7 +74,7 @@
7474

7575
<div class="col-md-3" id="leftCol">
7676
<ul class="nav nav-stacked affix" id="sidebar">
77-
<li><h3><img src="/content/images/structuremap-logo-210x210.png" alt="StructureMap 4.4.3" width="210" height="210"></h3></li>
77+
<li><h3><img src="/content/images/structuremap-logo-210x210.png" alt="StructureMap 4.5.0" width="210" height="210"></h3></li>
7878
<li><h3 class="no-margin">Next</h3><p><a href="/diagnostics/type-scanning">Type Scanning Diagnostics</a></p></li>
7979
<li><h3 class="no-margin">Previous</h3><a href="/diagnostics/build-plans">Build Plans</a></p></li>
8080
</ul>

‎diagnostics/validating-container-configuration/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
<nav class="navbar navbar-default navbar-fixed-top" role="banner">
3232
<div class="container">
3333
<div class="navbar-header">
34-
<a href="/" class="navbar-brand">StructureMap 4.4.3</a>
34+
<a href="/" class="navbar-brand">StructureMap 4.5.0</a>
3535
</div>
3636
<nav class="collapse navbar-collapse" role="navigation">
3737
<ul class="nav navbar-nav pull-right">
@@ -74,7 +74,7 @@
7474

7575
<div class="col-md-3" id="leftCol">
7676
<ul class="nav nav-stacked affix" id="sidebar">
77-
<li><h3><img src="/content/images/structuremap-logo-210x210.png" alt="StructureMap 4.4.3" width="210" height="210"></h3></li>
77+
<li><h3><img src="/content/images/structuremap-logo-210x210.png" alt="StructureMap 4.5.0" width="210" height="210"></h3></li>
7878
<li><h3 class="no-margin">Next</h3><p><a href="/diagnostics/environment-tests">Environment Tests</a></p></li>
7979
<li><h3 class="no-margin">Previous</h3><a href="/diagnostics/whatdoihave">WhatDoIHave()</a></p></li>
8080
</ul>

‎diagnostics/whatdoihave/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
<nav class="navbar navbar-default navbar-fixed-top" role="banner">
3232
<div class="container">
3333
<div class="navbar-header">
34-
<a href="/" class="navbar-brand">StructureMap 4.4.3</a>
34+
<a href="/" class="navbar-brand">StructureMap 4.5.0</a>
3535
</div>
3636
<nav class="collapse navbar-collapse" role="navigation">
3737
<ul class="nav navbar-nav pull-right">
@@ -74,7 +74,7 @@
7474

7575
<div class="col-md-3" id="leftCol">
7676
<ul class="nav nav-stacked affix" id="sidebar">
77-
<li><h3><img src="/content/images/structuremap-logo-210x210.png" alt="StructureMap 4.4.3" width="210" height="210"></h3></li>
77+
<li><h3><img src="/content/images/structuremap-logo-210x210.png" alt="StructureMap 4.5.0" width="210" height="210"></h3></li>
7878
<li><h3 class="no-margin">Next</h3><p><a href="/diagnostics/validating-container-configuration">Validating Container Configuration</a></p></li>
7979
<li><h3 class="no-margin">Previous</h3><a href="/diagnostics">Diagnostics</a></p></li>
8080
</ul>

‎documentation/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
<nav class="navbar navbar-default navbar-fixed-top" role="banner">
3232
<div class="container">
3333
<div class="navbar-header">
34-
<a href="/" class="navbar-brand">StructureMap 4.4.3</a>
34+
<a href="/" class="navbar-brand">StructureMap 4.5.0</a>
3535
</div>
3636
<nav class="collapse navbar-collapse" role="navigation">
3737
<ul class="nav navbar-nav pull-right">
@@ -74,7 +74,7 @@
7474

7575
<div class="col-md-3" id="leftCol">
7676
<ul class="nav nav-stacked affix" id="sidebar">
77-
<li><h3><img src="/content/images/structuremap-logo-210x210.png" alt="StructureMap 4.4.3" width="210" height="210"></h3></li>
77+
<li><h3><img src="/content/images/structuremap-logo-210x210.png" alt="StructureMap 4.5.0" width="210" height="210"></h3></li>
7878
<li><h3 class="no-margin">Next</h3><p><a href="/roadmap">Roadmap</a></p></li>
7979
<li><h3 class="no-margin">Previous</h3><a href="/">StructureMap</a></p></li>
8080
</ul>

0 commit comments

Comments
 (0)