Skip to content

Commit 32bbba7

Browse files
craigfowlerGithub Actions Workflow (bot)
craigfowler
authored and
Github Actions Workflow (bot)
committed
Publish updated documentation website
1 parent 05675b6 commit 32bbba7

19 files changed

Lines changed: 771 additions & 60 deletions

‎docs/api/CSF.Screenplay.IHasCustomTypeName.html‎

Lines changed: 198 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,198 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<meta charset="utf-8">
5+
<title>Interface IHasCustomTypeName | Screenplay </title>
6+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
7+
<meta name="title" content="Interface IHasCustomTypeName | Screenplay ">
8+
9+
<meta name="description" content="An object which can provide a custom human-readable .NET type name.">
10+
<link rel="icon" href="../favicon.ico">
11+
<link rel="stylesheet" href="../public/docfx.min.css">
12+
<link rel="stylesheet" href="../public/main.css">
13+
<meta name="docfx:navrel" content="../toc.html">
14+
<meta name="docfx:tocrel" content="toc.html">
15+
16+
<meta name="docfx:rel" content="../">
17+
18+
19+
<meta name="docfx:docurl" content="https://github.com/csf-dev/CSF.Screenplay/new/master/apiSpec/new?filename=CSF_Screenplay_IHasCustomTypeName.md&amp;value=---%0Auid%3A%20CSF.Screenplay.IHasCustomTypeName%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">
20+
<meta name="loc:inThisArticle" content="In this article">
21+
<meta name="loc:searchResultsCount" content="{count} results for &quot;{query}&quot;">
22+
<meta name="loc:searchNoResults" content="No results for &quot;{query}&quot;">
23+
<meta name="loc:tocFilter" content="Filter by title">
24+
<meta name="loc:nextArticle" content="Next">
25+
<meta name="loc:prevArticle" content="Previous">
26+
<meta name="loc:themeLight" content="Light">
27+
<meta name="loc:themeDark" content="Dark">
28+
<meta name="loc:themeAuto" content="Auto">
29+
<meta name="loc:changeTheme" content="Change theme">
30+
<meta name="loc:copy" content="Copy">
31+
<meta name="loc:downloadPdf" content="Download PDF">
32+
33+
<script type="module" src="./../public/docfx.min.js"></script>
34+
35+
<script>
36+
const theme = localStorage.getItem('theme') || 'auto'
37+
document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
38+
</script>
39+
40+
</head>
41+
42+
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
43+
<header class="bg-body border-bottom">
44+
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
45+
<div class="container-xxl flex-nowrap">
46+
<a class="navbar-brand" href="../index.html">
47+
<img id="logo" class="svg" src="../logo.svg" alt="CSF.Screenplay">
48+
CSF.Screenplay
49+
</a>
50+
<button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation">
51+
<i class="bi bi-three-dots"></i>
52+
</button>
53+
<div class="collapse navbar-collapse" id="navpanel">
54+
<div id="navbar">
55+
<form class="search" role="search" id="search">
56+
<i class="bi bi-search"></i>
57+
<input class="form-control" id="search-query" type="search" disabled placeholder="Search" autocomplete="off" aria-label="Search">
58+
</form>
59+
</div>
60+
</div>
61+
</div>
62+
</nav>
63+
</header>
64+
65+
<main class="container-xxl">
66+
<div class="toc-offcanvas">
67+
<div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
68+
<div class="offcanvas-header">
69+
<h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
70+
<button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
71+
</div>
72+
<div class="offcanvas-body">
73+
<nav class="toc" id="toc"></nav>
74+
</div>
75+
</div>
76+
</div>
77+
78+
<div class="content">
79+
<div class="actionbar">
80+
<button class="btn btn-lg border-0 d-md-none" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
81+
<i class="bi bi-list"></i>
82+
</button>
83+
84+
<nav id="breadcrumb"></nav>
85+
</div>
86+
87+
<article data-uid="CSF.Screenplay.IHasCustomTypeName">
88+
89+
90+
91+
<h1 id="CSF_Screenplay_IHasCustomTypeName" data-uid="CSF.Screenplay.IHasCustomTypeName" class="text-break">
92+
Interface IHasCustomTypeName <a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay.Abstractions/IHasCustomTypeName.cs/#L18"><i class="bi bi-code-slash"></i></a>
93+
</h1>
94+
95+
<div class="facts text-secondary">
96+
<dl><dt>Namespace</dt><dd><a class="xref" href="CSF.html">CSF</a>.<a class="xref" href="CSF.Screenplay.html">Screenplay</a></dd></dl>
97+
<dl><dt>Assembly</dt><dd>CSF.Screenplay.Abstractions.dll</dd></dl>
98+
</div>
99+
100+
<div class="markdown summary"><p>An object which can provide a custom human-readable .NET type name.</p>
101+
</div>
102+
<div class="markdown conceptual"></div>
103+
104+
<div class="codewrapper">
105+
<pre><code class="lang-csharp hljs">public interface IHasCustomTypeName</code></pre>
106+
</div>
107+
108+
109+
110+
111+
112+
113+
114+
115+
116+
117+
118+
<h2 id="CSF_Screenplay_IHasCustomTypeName_remarks">Remarks</h2>
119+
<div class="markdown level0 remarks"><p>
120+
This is particularly important when reporting, particularly when writing the name of the performable type
121+
into a report. Some performables may be written using the adapter or decorator patterns, in which a general-use
122+
class wraps a specific class which implements a subset of a performable. Using <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.type.gettype#system-type-gettype">GetType()</a>
123+
will yield the type name of the general-use 'outer' class, which is usually not very useful on its own.
124+
</p>
125+
<p>
126+
If general-use performables, such as adapters, implement this interface, then they can return more useful human-readable
127+
type names to the consuming logic, making use of their inner/wrapped implementation type.
128+
</p>
129+
</div>
130+
131+
132+
<h2 class="section" id="methods">Methods
133+
</h2>
134+
135+
136+
<a id="CSF_Screenplay_IHasCustomTypeName_GetHumanReadableTypeName_" data-uid="CSF.Screenplay.IHasCustomTypeName.GetHumanReadableTypeName*"></a>
137+
138+
<h3 id="CSF_Screenplay_IHasCustomTypeName_GetHumanReadableTypeName" data-uid="CSF.Screenplay.IHasCustomTypeName.GetHumanReadableTypeName">
139+
GetHumanReadableTypeName()
140+
<a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay.Abstractions/IHasCustomTypeName.cs/#L28"><i class="bi bi-code-slash"></i></a>
141+
</h3>
142+
143+
<div class="markdown level1 summary"><p>Gets a human-readable name of the type of the current instance.</p>
144+
</div>
145+
<div class="markdown level1 conceptual"></div>
146+
147+
<div class="codewrapper">
148+
<pre><code class="lang-csharp hljs">string GetHumanReadableTypeName()</code></pre>
149+
</div>
150+
151+
152+
<h4 class="section">Returns</h4>
153+
<dl class="parameters">
154+
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
155+
<dd><p>A human-readable name of the .NET type of the current instance, which could (for example) be
156+
qualified with additional context, such as a wrapped implementation.</p>
157+
</dd>
158+
</dl>
159+
160+
161+
162+
163+
164+
165+
166+
<h4 class="section" id="CSF_Screenplay_IHasCustomTypeName_GetHumanReadableTypeName_remarks">Remarks</h4>
167+
<div class="markdown level1 remarks"><p>See the remarks on <a class="xref" href="CSF.Screenplay.IHasCustomTypeName.html">IHasCustomTypeName</a>; this does not need to be the same as <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.type.gettype#system-type-gettype">GetType()</a>.</p>
168+
</div>
169+
170+
171+
172+
173+
174+
</article>
175+
176+
<div class="contribution d-print-none">
177+
<a href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay.Abstractions/IHasCustomTypeName.cs/#L18" class="edit-link">Edit this page</a>
178+
</div>
179+
180+
181+
</div>
182+
183+
<div class="affix">
184+
<nav id="affix"></nav>
185+
</div>
186+
</main>
187+
188+
<div class="container-xxl search-results" id="search-results"></div>
189+
190+
<footer class="border-top text-secondary">
191+
<div class="container-xxl">
192+
<div class="flex-fill">
193+
<span>Made with <a href="https://dotnet.github.io/docfx">docfx</a></span>
194+
</div>
195+
</div>
196+
</footer>
197+
</body>
198+
</html>

‎docs/api/CSF.Screenplay.Reporting.PerformanceReportBuilder.html‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ <h2 class="section" id="constructors">Constructors
162162

163163
<h3 id="CSF_Screenplay_Reporting_PerformanceReportBuilder__ctor_System_Collections_Generic_List_CSF_Screenplay_ReportModel_IdentifierAndNameModel__CSF_Screenplay_Reporting_IGetsValueFormatter_CSF_Screenplay_IFormatsReportFragment_CSF_Screenplay_Reporting_IGetsContentType_CSF_Screenplay_Reporting_IMeasuresTime_" data-uid="CSF.Screenplay.Reporting.PerformanceReportBuilder.#ctor(System.Collections.Generic.List{CSF.Screenplay.ReportModel.IdentifierAndNameModel},CSF.Screenplay.Reporting.IGetsValueFormatter,CSF.Screenplay.IFormatsReportFragment,CSF.Screenplay.Reporting.IGetsContentType,CSF.Screenplay.Reporting.IMeasuresTime)">
164164
PerformanceReportBuilder(List&lt;IdentifierAndNameModel&gt;, IGetsValueFormatter, IFormatsReportFragment, IGetsContentType, IMeasuresTime)
165-
<a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay/Reporting/PerformanceReportBuilder.cs/#L292"><i class="bi bi-code-slash"></i></a>
165+
<a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay/Reporting/PerformanceReportBuilder.cs/#L294"><i class="bi bi-code-slash"></i></a>
166166
</h3>
167167

168168
<div class="markdown level1 summary"><p>Initialises a new instance of <a class="xref" href="CSF.Screenplay.Reporting.PerformanceReportBuilder.html">PerformanceReportBuilder</a>.</p>
@@ -384,7 +384,7 @@ <h4 class="section" id="CSF_Screenplay_Reporting_PerformanceReportBuilder_BeginP
384384

385385
<h3 id="CSF_Screenplay_Reporting_PerformanceReportBuilder_EndPerformable_System_Object_CSF_Screenplay_Actor_" data-uid="CSF.Screenplay.Reporting.PerformanceReportBuilder.EndPerformable(System.Object,CSF.Screenplay.Actor)">
386386
EndPerformable(object, Actor)
387-
<a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay/Reporting/PerformanceReportBuilder.cs/#L239"><i class="bi bi-code-slash"></i></a>
387+
<a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay/Reporting/PerformanceReportBuilder.cs/#L241"><i class="bi bi-code-slash"></i></a>
388388
</h3>
389389

390390
<div class="markdown level1 summary"><p>Indicates that the current performable has finished normally and that it should no longer be current.</p>
@@ -480,7 +480,7 @@ <h4 class="section" id="CSF_Screenplay_Reporting_PerformanceReportBuilder_GetRep
480480

481481
<h3 id="CSF_Screenplay_Reporting_PerformanceReportBuilder_RecordAssetForCurrentPerformable_System_String_System_String_" data-uid="CSF.Screenplay.Reporting.PerformanceReportBuilder.RecordAssetForCurrentPerformable(System.String,System.String)">
482482
RecordAssetForCurrentPerformable(string, string)
483-
<a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay/Reporting/PerformanceReportBuilder.cs/#L197"><i class="bi bi-code-slash"></i></a>
483+
<a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay/Reporting/PerformanceReportBuilder.cs/#L199"><i class="bi bi-code-slash"></i></a>
484484
</h3>
485485

486486
<div class="markdown level1 summary"><p>Enriches the current performable with information about a file asset.</p>
@@ -521,7 +521,7 @@ <h4 class="section" id="CSF_Screenplay_Reporting_PerformanceReportBuilder_Record
521521

522522
<h3 id="CSF_Screenplay_Reporting_PerformanceReportBuilder_RecordFailureForCurrentPerformable_System_Exception_System_Object_CSF_Screenplay_Actor_" data-uid="CSF.Screenplay.Reporting.PerformanceReportBuilder.RecordFailureForCurrentPerformable(System.Exception,System.Object,CSF.Screenplay.Actor)">
523523
RecordFailureForCurrentPerformable(Exception, object, Actor)
524-
<a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay/Reporting/PerformanceReportBuilder.cs/#L262"><i class="bi bi-code-slash"></i></a>
524+
<a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay/Reporting/PerformanceReportBuilder.cs/#L264"><i class="bi bi-code-slash"></i></a>
525525
</h3>
526526

527527
<div class="markdown level1 summary"><p>Records the current performable as a failure, due to an uncaught exception.</p>
@@ -568,7 +568,7 @@ <h4 class="section" id="CSF_Screenplay_Reporting_PerformanceReportBuilder_Record
568568

569569
<h3 id="CSF_Screenplay_Reporting_PerformanceReportBuilder_RecordResultForCurrentPerformable_System_Object_" data-uid="CSF.Screenplay.Reporting.PerformanceReportBuilder.RecordResultForCurrentPerformable(System.Object)">
570570
RecordResultForCurrentPerformable(object)
571-
<a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay/Reporting/PerformanceReportBuilder.cs/#L219"><i class="bi bi-code-slash"></i></a>
571+
<a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay/Reporting/PerformanceReportBuilder.cs/#L221"><i class="bi bi-code-slash"></i></a>
572572
</h3>
573573

574574
<div class="markdown level1 summary"><p>Enriches the current performable with information about its result.</p>

‎docs/api/CSF.Screenplay.Selenium.Actions.SingleElementPerformableAdapter.html‎

Lines changed: 41 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ <h1 id="CSF_Screenplay_Selenium_Actions_SingleElementPerformableAdapter" data-ui
102102
<div class="markdown conceptual"></div>
103103

104104
<div class="codewrapper">
105-
<pre><code class="lang-csharp hljs">public class SingleElementPerformableAdapter : IPerformable, ICanReport</code></pre>
105+
<pre><code class="lang-csharp hljs">public class SingleElementPerformableAdapter : IPerformable, ICanReport, IHasCustomTypeName</code></pre>
106106
</div>
107107

108108

@@ -121,6 +121,7 @@ <h1 id="CSF_Screenplay_Selenium_Actions_SingleElementPerformableAdapter" data-ui
121121
<dd>
122122
<div><a class="xref" href="CSF.Screenplay.IPerformable.html">IPerformable</a></div>
123123
<div><a class="xref" href="CSF.Screenplay.ICanReport.html">ICanReport</a></div>
124+
<div><a class="xref" href="CSF.Screenplay.IHasCustomTypeName.html">IHasCustomTypeName</a></div>
124125
</dd>
125126
</dl>
126127

@@ -174,7 +175,7 @@ <h2 class="section" id="constructors">Constructors
174175

175176
<h3 id="CSF_Screenplay_Selenium_Actions_SingleElementPerformableAdapter__ctor_CSF_Screenplay_Selenium_Actions_ISingleElementPerformable_CSF_Screenplay_Selenium_Elements_ITarget_" data-uid="CSF.Screenplay.Selenium.Actions.SingleElementPerformableAdapter.#ctor(CSF.Screenplay.Selenium.Actions.ISingleElementPerformable,CSF.Screenplay.Selenium.Elements.ITarget)">
176177
SingleElementPerformableAdapter(ISingleElementPerformable, ITarget)
177-
<a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay.Selenium/Actions/SingleElementPerformableAdapter.cs/#L46"><i class="bi bi-code-slash"></i></a>
178+
<a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay.Selenium/Actions/SingleElementPerformableAdapter.cs/#L50"><i class="bi bi-code-slash"></i></a>
178179
</h3>
179180

180181
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="CSF.Screenplay.Selenium.Actions.SingleElementPerformableAdapter.html">SingleElementPerformableAdapter</a> class with the specified performable and target.</p>
@@ -214,7 +215,7 @@ <h2 class="section" id="methods">Methods
214215

215216
<h3 id="CSF_Screenplay_Selenium_Actions_SingleElementPerformableAdapter_From_CSF_Screenplay_Selenium_Actions_ISingleElementPerformable_CSF_Screenplay_Selenium_Elements_ITarget_" data-uid="CSF.Screenplay.Selenium.Actions.SingleElementPerformableAdapter.From(CSF.Screenplay.Selenium.Actions.ISingleElementPerformable,CSF.Screenplay.Selenium.Elements.ITarget)">
216217
From(ISingleElementPerformable, ITarget)
217-
<a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay.Selenium/Actions/SingleElementPerformableAdapter.cs/#L58"><i class="bi bi-code-slash"></i></a>
218+
<a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay.Selenium/Actions/SingleElementPerformableAdapter.cs/#L62"><i class="bi bi-code-slash"></i></a>
218219
</h3>
219220

220221
<div class="markdown level1 summary"><p>Creates a new instance of the <a class="xref" href="CSF.Screenplay.Selenium.Actions.SingleElementPerformableAdapter.html">SingleElementPerformableAdapter</a> class with the specified performable and target.</p>
@@ -252,6 +253,43 @@ <h4 class="section">Returns</h4>
252253

253254

254255

256+
<a id="CSF_Screenplay_Selenium_Actions_SingleElementPerformableAdapter_GetHumanReadableTypeName_" data-uid="CSF.Screenplay.Selenium.Actions.SingleElementPerformableAdapter.GetHumanReadableTypeName*"></a>
257+
258+
<h3 id="CSF_Screenplay_Selenium_Actions_SingleElementPerformableAdapter_GetHumanReadableTypeName" data-uid="CSF.Screenplay.Selenium.Actions.SingleElementPerformableAdapter.GetHumanReadableTypeName">
259+
GetHumanReadableTypeName()
260+
<a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay.Selenium/Actions/SingleElementPerformableAdapter.cs/#L42"><i class="bi bi-code-slash"></i></a>
261+
</h3>
262+
263+
<div class="markdown level1 summary"><p>Gets a human-readable name of the type of the current instance.</p>
264+
</div>
265+
<div class="markdown level1 conceptual"></div>
266+
267+
<div class="codewrapper">
268+
<pre><code class="lang-csharp hljs">public string GetHumanReadableTypeName()</code></pre>
269+
</div>
270+
271+
272+
<h4 class="section">Returns</h4>
273+
<dl class="parameters">
274+
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
275+
<dd><p>A human-readable name of the .NET type of the current instance, which could (for example) be
276+
qualified with additional context, such as a wrapped implementation.</p>
277+
</dd>
278+
</dl>
279+
280+
281+
282+
283+
284+
285+
286+
<h4 class="section" id="CSF_Screenplay_Selenium_Actions_SingleElementPerformableAdapter_GetHumanReadableTypeName_remarks">Remarks</h4>
287+
<div class="markdown level1 remarks"><p>See the remarks on <a class="xref" href="CSF.Screenplay.IHasCustomTypeName.html">IHasCustomTypeName</a>; this does not need to be the same as <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.type.gettype#system-type-gettype">GetType()</a>.</p>
288+
</div>
289+
290+
291+
292+
255293
<a id="CSF_Screenplay_Selenium_Actions_SingleElementPerformableAdapter_GetReportFragment_" data-uid="CSF.Screenplay.Selenium.Actions.SingleElementPerformableAdapter.GetReportFragment*"></a>
256294

257295
<h3 id="CSF_Screenplay_Selenium_Actions_SingleElementPerformableAdapter_GetReportFragment_CSF_Screenplay_Actor_CSF_Screenplay_IFormatsReportFragment_" data-uid="CSF.Screenplay.Selenium.Actions.SingleElementPerformableAdapter.GetReportFragment(CSF.Screenplay.Actor,CSF.Screenplay.IFormatsReportFragment)">

0 commit comments

Comments
 (0)