Skip to content

Commit 9905b9c

Browse files
committed
Updated API documentation (closes #193)
1 parent 8ef019f commit 9905b9c

File tree

318 files changed

+3322
-4662
lines changed

Some content is hidden

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

318 files changed

+3322
-4662
lines changed

docs/_docfx/api/.manifest

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

docs/_docfx/api/index.md

Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,29 @@
11
# Welcome to the API Reference
22

3-
Here you will find My Tested ASP.NET Core MVC API reference containing detailed information on all publicly available assertion methods and classes.
3+
Here you will find [My Tested ASP.NET Core MVC](https://mytestedasp.net/Core/Mvc) API reference containing detailed information on all publicly available assertion methods and classes.
44

5-
Commonly used types:
5+
<strong class="article-contents">Test case starting points</strong>
66

7-
- [MyMvc](/api/MyTested.AspNetCore.Mvc.MyMvc.html) - starting point of the framework
8-
- [IControllerBuilder](/api/MyTested.AspNetCore.Mvc.Builders.Contracts.Controllers.IControllerBuilder`1.html) - controller test builder
9-
- [IRouteTestBuilder](/api/MyTested.AspNetCore.Mvc.Builders.Contracts.Routes.IRouteTestBuilder.html) - route test builder
7+
- [MyMvc](/api/MyTested.AspNetCore.Mvc.MyMvc.html) - contains all available starting points
8+
- [MyApplication](/api/MyTested.AspNetCore.Mvc.MyApplication.html) - specifies the test application
9+
- [MyController](/api/MyTested.AspNetCore.Mvc.MyController-1.html) - specifies controller test case
10+
- [MyViewComponent](/api/MyTested.AspNetCore.Mvc.MyViewComponent-1.html) - specifies view component test case
11+
- [MyRouting](/api/MyTested.AspNetCore.Mvc.MyRouting.html) - specifies route test case
12+
13+
<strong class="article-contents">Commonly used test builders</strong>
14+
15+
- [IControllerBuilder](/api/MyTested.AspNetCore.Mvc.Builders.Contracts.Controllers.IControllerBuilder-1.html) - controller test builder
16+
- [IViewComponentBuilder](/api/MyTested.AspNetCore.Mvc.Builders.Contracts.ViewComponents.IViewComponentBuilder-1.html) - view component test builder
17+
- [IRouteTestBuilder](/api/MyTested.AspNetCore.Mvc.Builders.Contracts.Routes.IRouteTestBuilder.html) - route test builder
18+
- [IApplicationConfigurationBuilder](/api/MyTested.AspNetCore.Mvc.Builders.Contracts.Application.IApplicationConfigurationBuilder.html) - application configuration builder
19+
20+
<strong class="article-contents">Helper classes</strong>
21+
22+
- [From](/api/MyTested.AspNetCore.Mvc.From.html) - helps with resolving values in lambda expressions
23+
- [With](/api/MyTested.AspNetCore.Mvc.With.html) - helps with null, default and ignored values
24+
- [AuthenticationScheme](/api/MyTested.AspNetCore.Mvc.AuthenticationScheme.html) - contains common authentication schemes
25+
- [ContentType](/api/MyTested.AspNetCore.Mvc.ContentType.html) - contains common content type header values
26+
- [HttpHeader](/api/MyTested.AspNetCore.Mvc.HttpHeader.html) - contains common HTTP header names
27+
- [HttpMethod](/api/MyTested.AspNetCore.Mvc.HttpMethod.html) - contains common HTTP methods
28+
- [HttpScheme](/api/MyTested.AspNetCore.Mvc.HttpScheme.html) - contains common HTTP schemes
29+
- [HttpStatusCode](/api/MyTested.AspNetCore.Mvc.HttpStatusCode.html) - contains common HTTP status codes

docs/_docfx/custom/styles/main.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ $(function() {
77

88
elements.each(function (i, el) {
99
$(el).text($(el).text().replace('MyTested.AspNetCore.Mvc.Builders.Contracts.', ''));
10-
$(el).text($(el).text().replace('MyTested.AspNetCore.Mvc', 'Common'));
10+
$(el).text($(el).text().replace('MyTested.AspNetCore.Mvc', 'Common Classes & Extensions'));
1111
});
1212

1313
$('#toc.toc').show();

docs/_docfx/filterConfig.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,12 @@ apiRules:
1313
uidRegex: ^MyTested.AspNetCore.Mvc.HttpStatusCode
1414
- include:
1515
uidRegex: ^MyTested.AspNetCore.Mvc.With
16+
- include:
17+
uidRegex: ^MyTested.AspNetCore.Mvc.From
1618
- include:
1719
uidRegex: ^MyTested.AspNetCore.Mvc.My
20+
- exclude:
21+
uidRegex: ^MyTested.AspNetCore.Mvc.Utilities.Extensions
1822
- include:
1923
uidRegex: Extensions$
2024
- exclude:
@@ -23,5 +27,7 @@ apiRules:
2327
uidRegex: IAnd
2428
- exclude:
2529
uidRegex: ^MyTested.AspNetCore.Mvc.Internal
30+
- exclude:
31+
uidRegex: ^MyTested.AspNetCore.Mvc.Plugins
2632
- include:
2733
type: Interface
225 KB
Loading

docs/_docfx/troubleshoot/intro.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
# Welcome to the Troubleshoot
22

3-
Here you will find My Tested ASP.NET Core MVC solutions for frequently asked questions and common problems.
3+
Here you will find [My Tested ASP.NET Core MVC](https://mytestedasp.net/Core/Mvc) solutions for frequently asked questions and common problems.
44

5-
<strong class="article-contents">The troubleshoot section is still work in progress...</strong>
5+
<strong class="article-contents">Table of contents</strong>
66

7-
<span>Sorry for the inconvenience caused! :(</span>
8-
9-
<img src="/images/catsorry.jpg" />
7+
- [When I run a test, I receive a type initializer exception without any descriptive message](/troubleshoot/typeinitexception.html)

docs/_docfx/troubleshoot/toc.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11

22
- name: Introduction
3-
href: intro.md
3+
href: intro.md
4+
- name: Type Initializer Exception
5+
href: typeinitexception.md
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# When I run a test, I receive a type initializer exception without any descriptive message
2+
3+
`MyTested.AspNetCore.Mvc` uses a static constructor to bootstrap and prepare the test application. If your configuration is not valid, `System.TypeInitializerException` may be thrown. Depending on your test runner, you may not see a descriptive and helpful message.
4+
5+
In order to see more details about the problem, run the test in `Debug` mode and analyse the message of the `InnerException`.
6+
7+
<img src="/images/troubleshoot/typeinitexception.jpg" />

docs/_docfx/tutorial/intro.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Welcome to the Tutorial
22

3-
Here you will find My Tested ASP.NET Core MVC tutorial, in which you will learn the most important parts of the testing framework.
3+
Here you will find [My Tested ASP.NET Core MVC](https://mytestedasp.net/Core/Mvc) tutorial, in which you will learn the most important parts of the testing framework.
44

55
<strong class="article-contents">The tutorial is still work in progress...</strong>
66

docs/api/MyTested.AspNetCore.Mvc.ActionAttributesTestBuilderViewFeaturesExtensions.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -87,10 +87,10 @@ <h3 id="methods">Methods
8787
</h3>
8888
<span class="small pull-right mobile-hide">
8989
<span class="divider">|</span>
90-
<a href="https://github.com/ivaylokenov/MyTested.AspNetCore.Mvc/new/development/docs/_docfx/apispec/new?filename=MyTested_AspNetCore_Mvc_ActionAttributesTestBuilderViewFeaturesExtensions_ValidatingAntiForgeryToken_MyTested_AspNetCore_Mvc_Builders_Contracts_Attributes_IActionAttributesTestBuilder_.md&amp;value=---%0Auid%3A%20MyTested.AspNetCore.Mvc.ActionAttributesTestBuilderViewFeaturesExtensions.ValidatingAntiForgeryToken(MyTested.AspNetCore.Mvc.Builders.Contracts.Attributes.IActionAttributesTestBuilder)%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>
90+
<a href="https://github.com/ivaylokenov/MyTested.AspNetCore.Mvc/new/documentation/docs/_docfx/apispec/new?filename=MyTested_AspNetCore_Mvc_ActionAttributesTestBuilderViewFeaturesExtensions_ValidatingAntiForgeryToken_MyTested_AspNetCore_Mvc_Builders_Contracts_Attributes_IActionAttributesTestBuilder_.md&amp;value=---%0Auid%3A%20MyTested.AspNetCore.Mvc.ActionAttributesTestBuilderViewFeaturesExtensions.ValidatingAntiForgeryToken(MyTested.AspNetCore.Mvc.Builders.Contracts.Attributes.IActionAttributesTestBuilder)%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>
9191
</span>
9292
<span class="small pull-right mobile-hide">
93-
<a href="https://github.com/ivaylokenov/MyTested.AspNetCore.Mvc/blob/development/src/MyTested.AspNetCore.Mvc.ViewFeatures/ActionAttributesTestBuilderViewFeaturesExtensions.cs/#L16">View Source</a>
93+
<a href="https://github.com/ivaylokenov/MyTested.AspNetCore.Mvc/blob/documentation/src/MyTested.AspNetCore.Mvc.ViewFeatures/ActionAttributesTestBuilderViewFeaturesExtensions.cs/#L16">View Source</a>
9494
</span>
9595
<h4 id="MyTested_AspNetCore_Mvc_ActionAttributesTestBuilderViewFeaturesExtensions_ValidatingAntiForgeryToken_MyTested_AspNetCore_Mvc_Builders_Contracts_Attributes_IActionAttributesTestBuilder_" data-uid="MyTested.AspNetCore.Mvc.ActionAttributesTestBuilderViewFeaturesExtensions.ValidatingAntiForgeryToken(MyTested.AspNetCore.Mvc.Builders.Contracts.Attributes.IActionAttributesTestBuilder)">ValidatingAntiForgeryToken(IActionAttributesTestBuilder)</h4>
9696
<div class="markdown level1 summary"><p sourcefile="api/MyTested.AspNetCore.Mvc.ActionAttributesTestBuilderViewFeaturesExtensions.yml" sourcestartlinenumber="2" sourceendlinenumber="2">Tests whether the action attributes contain <span class="xref">Microsoft.AspNetCore.Mvc.ValidateAntiForgeryTokenAttribute</span>.</p>
@@ -142,10 +142,10 @@ <h5 class="returns">Returns</h5>
142142
<div class="contribution">
143143
<ul class="nav">
144144
<li>
145-
<a href="https://github.com/ivaylokenov/MyTested.AspNetCore.Mvc/new/development/docs/_docfx/apispec/new?filename=MyTested_AspNetCore_Mvc_ActionAttributesTestBuilderViewFeaturesExtensions.md&amp;value=---%0Auid%3A%20MyTested.AspNetCore.Mvc.ActionAttributesTestBuilderViewFeaturesExtensions%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>
145+
<a href="https://github.com/ivaylokenov/MyTested.AspNetCore.Mvc/new/documentation/docs/_docfx/apispec/new?filename=MyTested_AspNetCore_Mvc_ActionAttributesTestBuilderViewFeaturesExtensions.md&amp;value=---%0Auid%3A%20MyTested.AspNetCore.Mvc.ActionAttributesTestBuilderViewFeaturesExtensions%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>
146146
</li>
147147
<li>
148-
<a href="https://github.com/ivaylokenov/MyTested.AspNetCore.Mvc/blob/development/src/MyTested.AspNetCore.Mvc.ViewFeatures/ActionAttributesTestBuilderViewFeaturesExtensions.cs/#L9" class="contribution-link">View Source</a>
148+
<a href="https://github.com/ivaylokenov/MyTested.AspNetCore.Mvc/blob/documentation/src/MyTested.AspNetCore.Mvc.ViewFeatures/ActionAttributesTestBuilderViewFeaturesExtensions.cs/#L9" class="contribution-link">View Source</a>
149149
</li>
150150
</ul>
151151
</div>

0 commit comments

Comments
 (0)