Skip to content

Commit a8b33c1

Browse files
craigfowlerGithub Actions Workflow (bot)
craigfowler
authored and
Github Actions Workflow (bot)
committed
Publish updated documentation website
1 parent 7fe6cbd commit a8b33c1

12 files changed

Lines changed: 397 additions & 268 deletions

‎docs/api/CSF.Screenplay.ReportModel.ActorCreatedReport.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ <h1 id="CSF_Screenplay_ReportModel_ActorCreatedReport" data-uid="CSF.Screenplay.
126126
<a class="xref" href="CSF.Screenplay.ReportModel.ReportableModelBase.html#CSF_Screenplay_ReportModel_ReportableModelBase_Report">ReportableModelBase.Report</a>
127127
</div>
128128
<div>
129-
<a class="xref" href="CSF.Screenplay.ReportModel.ReportableModelBase.html#CSF_Screenplay_ReportModel_ReportableModelBase_ActorName">ReportableModelBase.ActorName</a>
129+
<a class="xref" href="CSF.Screenplay.ReportModel.ReportableModelBase.html#CSF_Screenplay_ReportModel_ReportableModelBase_Actor">ReportableModelBase.Actor</a>
130130
</div>
131131
<div>
132132
<a class="xref" href="CSF.Screenplay.ReportModel.ReportableModelBase.html#CSF_Screenplay_ReportModel_ReportableModelBase_Started">ReportableModelBase.Started</a>

‎docs/api/CSF.Screenplay.ReportModel.ActorGainedAbilityReport.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ <h1 id="CSF_Screenplay_ReportModel_ActorGainedAbilityReport" data-uid="CSF.Scree
127127
<a class="xref" href="CSF.Screenplay.ReportModel.ReportableModelBase.html#CSF_Screenplay_ReportModel_ReportableModelBase_Report">ReportableModelBase.Report</a>
128128
</div>
129129
<div>
130-
<a class="xref" href="CSF.Screenplay.ReportModel.ReportableModelBase.html#CSF_Screenplay_ReportModel_ReportableModelBase_ActorName">ReportableModelBase.ActorName</a>
130+
<a class="xref" href="CSF.Screenplay.ReportModel.ReportableModelBase.html#CSF_Screenplay_ReportModel_ReportableModelBase_Actor">ReportableModelBase.Actor</a>
131131
</div>
132132
<div>
133133
<a class="xref" href="CSF.Screenplay.ReportModel.ReportableModelBase.html#CSF_Screenplay_ReportModel_ReportableModelBase_Started">ReportableModelBase.Started</a>

‎docs/api/CSF.Screenplay.ReportModel.ActorSpotlitReport.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ <h1 id="CSF_Screenplay_ReportModel_ActorSpotlitReport" data-uid="CSF.Screenplay.
126126
<a class="xref" href="CSF.Screenplay.ReportModel.ReportableModelBase.html#CSF_Screenplay_ReportModel_ReportableModelBase_Report">ReportableModelBase.Report</a>
127127
</div>
128128
<div>
129-
<a class="xref" href="CSF.Screenplay.ReportModel.ReportableModelBase.html#CSF_Screenplay_ReportModel_ReportableModelBase_ActorName">ReportableModelBase.ActorName</a>
129+
<a class="xref" href="CSF.Screenplay.ReportModel.ReportableModelBase.html#CSF_Screenplay_ReportModel_ReportableModelBase_Actor">ReportableModelBase.Actor</a>
130130
</div>
131131
<div>
132132
<a class="xref" href="CSF.Screenplay.ReportModel.ReportableModelBase.html#CSF_Screenplay_ReportModel_ReportableModelBase_Started">ReportableModelBase.Started</a>

‎docs/api/CSF.Screenplay.ReportModel.IdentifierAndNameModel.html‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -161,10 +161,10 @@ <h2 class="section" id="properties">Properties
161161
</h2>
162162

163163

164-
<a id="CSF_Screenplay_ReportModel_IdentifierAndNameModel_Identifier_" data-uid="CSF.Screenplay.ReportModel.IdentifierAndNameModel.Identifier*"></a>
164+
<a id="CSF_Screenplay_ReportModel_IdentifierAndNameModel_Id_" data-uid="CSF.Screenplay.ReportModel.IdentifierAndNameModel.Id*"></a>
165165

166-
<h3 id="CSF_Screenplay_ReportModel_IdentifierAndNameModel_Identifier" data-uid="CSF.Screenplay.ReportModel.IdentifierAndNameModel.Identifier">
167-
Identifier
166+
<h3 id="CSF_Screenplay_ReportModel_IdentifierAndNameModel_Id" data-uid="CSF.Screenplay.ReportModel.IdentifierAndNameModel.Id">
167+
Id
168168
<a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay/ReportModel/IdentifierAndNameModel.cs/#L19"><i class="bi bi-code-slash"></i></a>
169169
</h3>
170170

@@ -173,7 +173,7 @@ <h3 id="CSF_Screenplay_ReportModel_IdentifierAndNameModel_Identifier" data-uid="
173173
<div class="markdown level1 conceptual"></div>
174174

175175
<div class="codewrapper">
176-
<pre><code class="lang-csharp hljs">public string Identifier { get; set; }</code></pre>
176+
<pre><code class="lang-csharp hljs">public string Id { get; set; }</code></pre>
177177
</div>
178178

179179

@@ -193,19 +193,19 @@ <h4 class="section">Property Value</h4>
193193

194194

195195

196-
<a id="CSF_Screenplay_ReportModel_IdentifierAndNameModel_Name_" data-uid="CSF.Screenplay.ReportModel.IdentifierAndNameModel.Name*"></a>
196+
<a id="CSF_Screenplay_ReportModel_IdentifierAndNameModel_IsGeneratedId_" data-uid="CSF.Screenplay.ReportModel.IdentifierAndNameModel.IsGeneratedId*"></a>
197197

198-
<h3 id="CSF_Screenplay_ReportModel_IdentifierAndNameModel_Name" data-uid="CSF.Screenplay.ReportModel.IdentifierAndNameModel.Name">
199-
Name
200-
<a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay/ReportModel/IdentifierAndNameModel.cs/#L24"><i class="bi bi-code-slash"></i></a>
198+
<h3 id="CSF_Screenplay_ReportModel_IdentifierAndNameModel_IsGeneratedId" data-uid="CSF.Screenplay.ReportModel.IdentifierAndNameModel.IsGeneratedId">
199+
IsGeneratedId
200+
<a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay/ReportModel/IdentifierAndNameModel.cs/#L29"><i class="bi bi-code-slash"></i></a>
201201
</h3>
202202

203-
<div class="markdown level1 summary"><p>Corresponds to the value <a class="xref" href="CSF.Screenplay.Performances.IdentifierAndName.html#CSF_Screenplay_Performances_IdentifierAndName_Name">Name</a>.</p>
203+
<div class="markdown level1 summary"><p>Corresponds to the value <a class="xref" href="CSF.Screenplay.Performances.IdentifierAndName.html#CSF_Screenplay_Performances_IdentifierAndName_WasIdentifierAutoGenerated">WasIdentifierAutoGenerated</a>.</p>
204204
</div>
205205
<div class="markdown level1 conceptual"></div>
206206

207207
<div class="codewrapper">
208-
<pre><code class="lang-csharp hljs">public string Name { get; set; }</code></pre>
208+
<pre><code class="lang-csharp hljs">public bool IsGeneratedId { get; set; }</code></pre>
209209
</div>
210210

211211

@@ -214,7 +214,7 @@ <h3 id="CSF_Screenplay_ReportModel_IdentifierAndNameModel_Name" data-uid="CSF.Sc
214214

215215
<h4 class="section">Property Value</h4>
216216
<dl class="parameters">
217-
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
217+
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
218218
<dd></dd>
219219
</dl>
220220

@@ -225,19 +225,19 @@ <h4 class="section">Property Value</h4>
225225

226226

227227

228-
<a id="CSF_Screenplay_ReportModel_IdentifierAndNameModel_WasIdentifierAutoGenerated_" data-uid="CSF.Screenplay.ReportModel.IdentifierAndNameModel.WasIdentifierAutoGenerated*"></a>
228+
<a id="CSF_Screenplay_ReportModel_IdentifierAndNameModel_Name_" data-uid="CSF.Screenplay.ReportModel.IdentifierAndNameModel.Name*"></a>
229229

230-
<h3 id="CSF_Screenplay_ReportModel_IdentifierAndNameModel_WasIdentifierAutoGenerated" data-uid="CSF.Screenplay.ReportModel.IdentifierAndNameModel.WasIdentifierAutoGenerated">
231-
WasIdentifierAutoGenerated
232-
<a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay/ReportModel/IdentifierAndNameModel.cs/#L29"><i class="bi bi-code-slash"></i></a>
230+
<h3 id="CSF_Screenplay_ReportModel_IdentifierAndNameModel_Name" data-uid="CSF.Screenplay.ReportModel.IdentifierAndNameModel.Name">
231+
Name
232+
<a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay/ReportModel/IdentifierAndNameModel.cs/#L24"><i class="bi bi-code-slash"></i></a>
233233
</h3>
234234

235-
<div class="markdown level1 summary"><p>Corresponds to the value <a class="xref" href="CSF.Screenplay.Performances.IdentifierAndName.html#CSF_Screenplay_Performances_IdentifierAndName_WasIdentifierAutoGenerated">WasIdentifierAutoGenerated</a>.</p>
235+
<div class="markdown level1 summary"><p>Corresponds to the value <a class="xref" href="CSF.Screenplay.Performances.IdentifierAndName.html#CSF_Screenplay_Performances_IdentifierAndName_Name">Name</a>.</p>
236236
</div>
237237
<div class="markdown level1 conceptual"></div>
238238

239239
<div class="codewrapper">
240-
<pre><code class="lang-csharp hljs">public bool WasIdentifierAutoGenerated { get; set; }</code></pre>
240+
<pre><code class="lang-csharp hljs">public string Name { get; set; }</code></pre>
241241
</div>
242242

243243

@@ -246,7 +246,7 @@ <h3 id="CSF_Screenplay_ReportModel_IdentifierAndNameModel_WasIdentifierAutoGener
246246

247247
<h4 class="section">Property Value</h4>
248248
<dl class="parameters">
249-
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
249+
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
250250
<dd></dd>
251251
</dl>
252252

‎docs/api/CSF.Screenplay.ReportModel.PerformableAsset.html‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -154,10 +154,10 @@ <h2 id="CSF_Screenplay_ReportModel_PerformableAsset_remarks">Remarks</h2>
154154
down to the implementation.
155155
</p>
156156
<p>
157-
Every asset has one or two properties in common, the <a class="xref" href="CSF.Screenplay.ReportModel.PerformableAsset.html#CSF_Screenplay_ReportModel_PerformableAsset_FileName">FileName</a> and optionally <a class="xref" href="CSF.Screenplay.ReportModel.PerformableAsset.html#CSF_Screenplay_ReportModel_PerformableAsset_FileSummary">FileSummary</a>.
157+
Every asset has one or two properties in common, the <a class="xref" href="CSF.Screenplay.ReportModel.PerformableAsset.html#CSF_Screenplay_ReportModel_PerformableAsset_Name">Name</a> and optionally <a class="xref" href="CSF.Screenplay.ReportModel.PerformableAsset.html#CSF_Screenplay_ReportModel_PerformableAsset_Summary">Summary</a>.
158158
The data for the asset file is then described by one of two ways:
159159
</p>
160-
<ul><li>The content of the asset is located on disk at a path indicated by <a class="xref" href="CSF.Screenplay.ReportModel.PerformableAsset.html#CSF_Screenplay_ReportModel_PerformableAsset_FilePath">FilePath</a></li><li>The content of the asset is embedded within this model as base64-encoded text, within <a class="xref" href="CSF.Screenplay.ReportModel.PerformableAsset.html#CSF_Screenplay_ReportModel_PerformableAsset_FileData">FileData</a></li></ul>
160+
<ul><li>The content of the asset is located on disk at a path indicated by <a class="xref" href="CSF.Screenplay.ReportModel.PerformableAsset.html#CSF_Screenplay_ReportModel_PerformableAsset_Path">Path</a></li><li>The content of the asset is embedded within this model as base64-encoded text, within <a class="xref" href="CSF.Screenplay.ReportModel.PerformableAsset.html#CSF_Screenplay_ReportModel_PerformableAsset_Data">Data</a></li></ul>
161161
<p>
162162
Typically when reports are first created, for expedience, assets are recorded to disk as files.
163163
However, for portability, it is often useful to embed the asset data within the report so that the entire report may be transported as a single file.
@@ -201,10 +201,10 @@ <h4 class="section">Property Value</h4>
201201

202202

203203

204-
<a id="CSF_Screenplay_ReportModel_PerformableAsset_FileData_" data-uid="CSF.Screenplay.ReportModel.PerformableAsset.FileData*"></a>
204+
<a id="CSF_Screenplay_ReportModel_PerformableAsset_Data_" data-uid="CSF.Screenplay.ReportModel.PerformableAsset.Data*"></a>
205205

206-
<h3 id="CSF_Screenplay_ReportModel_PerformableAsset_FileData" data-uid="CSF.Screenplay.ReportModel.PerformableAsset.FileData">
207-
FileData
206+
<h3 id="CSF_Screenplay_ReportModel_PerformableAsset_Data" data-uid="CSF.Screenplay.ReportModel.PerformableAsset.Data">
207+
Data
208208
<a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay/ReportModel/PerformableAsset.cs/#L42"><i class="bi bi-code-slash"></i></a>
209209
</h3>
210210

@@ -213,7 +213,7 @@ <h3 id="CSF_Screenplay_ReportModel_PerformableAsset_FileData" data-uid="CSF.Scre
213213
<div class="markdown level1 conceptual"></div>
214214

215215
<div class="codewrapper">
216-
<pre><code class="lang-csharp hljs">public string FileData { get; set; }</code></pre>
216+
<pre><code class="lang-csharp hljs">public string Data { get; set; }</code></pre>
217217
</div>
218218

219219

@@ -233,10 +233,10 @@ <h4 class="section">Property Value</h4>
233233

234234

235235

236-
<a id="CSF_Screenplay_ReportModel_PerformableAsset_FileName_" data-uid="CSF.Screenplay.ReportModel.PerformableAsset.FileName*"></a>
236+
<a id="CSF_Screenplay_ReportModel_PerformableAsset_Name_" data-uid="CSF.Screenplay.ReportModel.PerformableAsset.Name*"></a>
237237

238-
<h3 id="CSF_Screenplay_ReportModel_PerformableAsset_FileName" data-uid="CSF.Screenplay.ReportModel.PerformableAsset.FileName">
239-
FileName
238+
<h3 id="CSF_Screenplay_ReportModel_PerformableAsset_Name" data-uid="CSF.Screenplay.ReportModel.PerformableAsset.Name">
239+
Name
240240
<a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay/ReportModel/PerformableAsset.cs/#L47"><i class="bi bi-code-slash"></i></a>
241241
</h3>
242242

@@ -245,7 +245,7 @@ <h3 id="CSF_Screenplay_ReportModel_PerformableAsset_FileName" data-uid="CSF.Scre
245245
<div class="markdown level1 conceptual"></div>
246246

247247
<div class="codewrapper">
248-
<pre><code class="lang-csharp hljs">public string FileName { get; set; }</code></pre>
248+
<pre><code class="lang-csharp hljs">public string Name { get; set; }</code></pre>
249249
</div>
250250

251251

@@ -265,10 +265,10 @@ <h4 class="section">Property Value</h4>
265265

266266

267267

268-
<a id="CSF_Screenplay_ReportModel_PerformableAsset_FilePath_" data-uid="CSF.Screenplay.ReportModel.PerformableAsset.FilePath*"></a>
268+
<a id="CSF_Screenplay_ReportModel_PerformableAsset_Path_" data-uid="CSF.Screenplay.ReportModel.PerformableAsset.Path*"></a>
269269

270-
<h3 id="CSF_Screenplay_ReportModel_PerformableAsset_FilePath" data-uid="CSF.Screenplay.ReportModel.PerformableAsset.FilePath">
271-
FilePath
270+
<h3 id="CSF_Screenplay_ReportModel_PerformableAsset_Path" data-uid="CSF.Screenplay.ReportModel.PerformableAsset.Path">
271+
Path
272272
<a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay/ReportModel/PerformableAsset.cs/#L37"><i class="bi bi-code-slash"></i></a>
273273
</h3>
274274

@@ -277,7 +277,7 @@ <h3 id="CSF_Screenplay_ReportModel_PerformableAsset_FilePath" data-uid="CSF.Scre
277277
<div class="markdown level1 conceptual"></div>
278278

279279
<div class="codewrapper">
280-
<pre><code class="lang-csharp hljs">public string FilePath { get; set; }</code></pre>
280+
<pre><code class="lang-csharp hljs">public string Path { get; set; }</code></pre>
281281
</div>
282282

283283

@@ -297,10 +297,10 @@ <h4 class="section">Property Value</h4>
297297

298298

299299

300-
<a id="CSF_Screenplay_ReportModel_PerformableAsset_FileSummary_" data-uid="CSF.Screenplay.ReportModel.PerformableAsset.FileSummary*"></a>
300+
<a id="CSF_Screenplay_ReportModel_PerformableAsset_Summary_" data-uid="CSF.Screenplay.ReportModel.PerformableAsset.Summary*"></a>
301301

302-
<h3 id="CSF_Screenplay_ReportModel_PerformableAsset_FileSummary" data-uid="CSF.Screenplay.ReportModel.PerformableAsset.FileSummary">
303-
FileSummary
302+
<h3 id="CSF_Screenplay_ReportModel_PerformableAsset_Summary" data-uid="CSF.Screenplay.ReportModel.PerformableAsset.Summary">
303+
Summary
304304
<a class="header-action link-secondary" title="View source" href="https://github.com/csf-dev/CSF.Screenplay/blob/master/CSF.Screenplay/ReportModel/PerformableAsset.cs/#L53"><i class="bi bi-code-slash"></i></a>
305305
</h3>
306306

@@ -310,7 +310,7 @@ <h3 id="CSF_Screenplay_ReportModel_PerformableAsset_FileSummary" data-uid="CSF.S
310310
<div class="markdown level1 conceptual"></div>
311311

312312
<div class="codewrapper">
313-
<pre><code class="lang-csharp hljs">public string FileSummary { get; set; }</code></pre>
313+
<pre><code class="lang-csharp hljs">public string Summary { get; set; }</code></pre>
314314
</div>
315315

316316

0 commit comments

Comments
 (0)