Skip to content

Commit 925dc21

Browse files
committed
deploy: 99818db
1 parent 4d3533c commit 925dc21

290 files changed

Lines changed: 3797 additions & 2857 deletions

File tree

Some content is hidden

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

previews/pr-326/classes/FastForward-DevTools-Console-Command-DocsCommand.html

Lines changed: 338 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3750,6 +3750,25 @@ <h4 id="toc-methods" class="h6 mb-0 fw-semibold">Methods</h4>
37503750
</p>
37513751
</div>
37523752

3753+
<span class="text-body-secondary small text-end">
3754+
&nbsp;: bool </span>
3755+
</div>
3756+
</div>
3757+
<div class="list-group-item">
3758+
<div class="d-flex justify-content-between align-items-start gap-3">
3759+
<div class="flex-grow-1">
3760+
<a
3761+
class="text-decoration-none fw-semibold text-primary"
3762+
href="classes/FastForward-DevTools-Console-Command-DocsCommand.html#method_isDefaultGuideSource"
3763+
>
3764+
isDefaultGuideSource()
3765+
</a>
3766+
3767+
<p class="text-body-secondary mb-0 small mt-1">
3768+
Detects whether a source option still points at the default guide directory.
3769+
</p>
3770+
</div>
3771+
37533772
<span class="text-body-secondary small text-end">
37543773
&nbsp;: bool </span>
37553774
</div>
@@ -3771,6 +3790,25 @@ <h4 id="toc-methods" class="h6 mb-0 fw-semibold">Methods</h4>
37713790

37723791
<span class="text-body-secondary small text-end">
37733792
&nbsp;: bool </span>
3793+
</div>
3794+
</div>
3795+
<div class="list-group-item">
3796+
<div class="d-flex justify-content-between align-items-start gap-3">
3797+
<div class="flex-grow-1">
3798+
<a
3799+
class="text-decoration-none fw-semibold text-primary"
3800+
href="classes/FastForward-DevTools-Console-Command-DocsCommand.html#method_normalizeProjectRelativePath"
3801+
>
3802+
normalizeProjectRelativePath()
3803+
</a>
3804+
3805+
<p class="text-body-secondary mb-0 small mt-1">
3806+
Normalizes a project-relative path for resilient default-option comparisons.
3807+
</p>
3808+
</div>
3809+
3810+
<span class="text-body-secondary small text-end">
3811+
&nbsp;: string </span>
37743812
</div>
37753813
</div>
37763814
<div class="list-group-item">
@@ -6742,6 +6780,150 @@ <h5 class="h6 text-uppercase text-body-secondary fw-semibold mb-0">Return values
67426780
</div>
67436781
</section>
67446782

6783+
</article> <article class="border rounded-4 p-4 bg-body shadow-sm">
6784+
<div class="d-flex flex-wrap align-items-start justify-content-between gap-3 mb-3">
6785+
<div>
6786+
<h4 class="h5 mb-2" id="method_isDefaultGuideSource">
6787+
<span class="text-primary">isDefaultGuideSource()</span>
6788+
<a
6789+
href="classes/FastForward-DevTools-Console-Command-DocsCommand.html#method_isDefaultGuideSource"
6790+
class="ms-2 text-decoration-none text-body-secondary"
6791+
aria-label="Permalink"
6792+
title="Permalink"
6793+
>
6794+
<i class="fas fa-link small"></i>
6795+
</a>
6796+
</h4>
6797+
6798+
<div class="d-flex flex-wrap gap-2">
6799+
<span class="badge text-bg-light border text-dark">Private</span>
6800+
6801+
6802+
6803+
6804+
</div>
6805+
</div>
6806+
</div>
6807+
6808+
<aside class="d-flex flex-wrap align-items-center gap-2 mb-4 text-body-secondary small">
6809+
<i class="fas fa-map-marker-alt text-danger"></i>
6810+
6811+
<span>Defined in</span>
6812+
6813+
<abbr title="src/Console/Command/DocsCommand.php" class="text-decoration-none mb-0">
6814+
<a href="files/src-console-command-docscommand.html"><abbr title="src/Console/Command/DocsCommand.php">DocsCommand.php</abbr></a>
6815+
</abbr>
6816+
6817+
<span class="text-body-tertiary">:</span>
6818+
6819+
<span class="badge text-bg-light border">264</span>
6820+
6821+
</aside>
6822+
<div class="mb-4">
6823+
<p class="lead text-body-secondary mb-0">Detects whether a source option still points at the default guide directory.</p>
6824+
</div>
6825+
6826+
6827+
<div class="mt-4">
6828+
<code class="d-inline-flex flex-wrap align-items-center gap-2 px-3 py-2 rounded-3 bg-body-tertiary border">
6829+
<span class="badge text-bg-light border text-dark">private</span>
6830+
6831+
6832+
6833+
6834+
6835+
<span class="text-primary fw-semibold">isDefaultGuideSource</span><span class="text-body-secondary">(</span><span><span class="text-info-emphasis">
6836+
string&nbsp;
6837+
</span><span class="text-primary">$sourceOption</span></span><span class="text-body-secondary">)</span><span class="text-body-secondary"> : </span><span class="text-info-emphasis">bool</span></code>
6838+
</div>
6839+
6840+
<div class="mt-3 d-flex flex-wrap gap-2">
6841+
</div>
6842+
6843+
6844+
6845+
6846+
<section class="mt-4">
6847+
<div class="d-flex align-items-center gap-2 mb-3">
6848+
<i class="fas fa-sliders-h text-info"></i>
6849+
<h5 class="h6 text-uppercase text-body-secondary fw-semibold mb-0">Parameters</h5>
6850+
</div>
6851+
6852+
<div class="d-grid gap-3">
6853+
<div class="card border-0 bg-body-tertiary shadow-sm">
6854+
<div class="card-body p-3">
6855+
<div class="d-flex flex-wrap align-items-center gap-2 mb-2">
6856+
<code class="text-primary fw-semibold mb-0">$sourceOption</code>
6857+
6858+
<span class="text-body-secondary">:</span>
6859+
6860+
<span class="badge text-bg-light border text-dark">
6861+
string
6862+
</span>
6863+
6864+
</div>
6865+
6866+
<div>
6867+
6868+
<section class="mt-2">
6869+
<div>
6870+
<div class="d-flex align-items-center gap-2 mb-3">
6871+
<i class="fas fa-align-left text-primary"></i>
6872+
<h3 class="h6 text-uppercase text-body-secondary fw-semibold mb-0">Description</h3>
6873+
</div>
6874+
6875+
<div>
6876+
<p>the guide source option received from the CLI</p>
6877+
6878+
</div>
6879+
</div>
6880+
</section>
6881+
6882+
</div>
6883+
</div>
6884+
</div>
6885+
</div>
6886+
</section>
6887+
6888+
6889+
6890+
6891+
6892+
<section class="mt-4">
6893+
<div class="d-flex align-items-center gap-2 mb-3">
6894+
<i class="fas fa-reply text-success"></i>
6895+
<h5 class="h6 text-uppercase text-body-secondary fw-semibold mb-0">Return values</h5>
6896+
</div>
6897+
6898+
<div class="card border-0 bg-body-tertiary shadow-sm">
6899+
<div class="card-body p-3">
6900+
<div class="d-flex flex-wrap align-items-center gap-2 mb-3">
6901+
<span class="badge text-bg-light border text-dark">
6902+
bool
6903+
</span>
6904+
</div>
6905+
6906+
<div>
6907+
6908+
<section class="mt-2">
6909+
<div>
6910+
<div class="d-flex align-items-center gap-2 mb-3">
6911+
<i class="fas fa-align-left text-primary"></i>
6912+
<h3 class="h6 text-uppercase text-body-secondary fw-semibold mb-0">Description</h3>
6913+
</div>
6914+
6915+
<div>
6916+
<p>true when the provided path is equivalent to the default guide directory</p>
6917+
6918+
</div>
6919+
</div>
6920+
</section>
6921+
6922+
</div>
6923+
</div>
6924+
</div>
6925+
</section>
6926+
67456927
</article> <article class="border rounded-4 p-4 bg-body shadow-sm">
67466928
<div class="d-flex flex-wrap align-items-start justify-content-between gap-3 mb-3">
67476929
<div>
@@ -6884,6 +7066,150 @@ <h5 class="h6 text-uppercase text-body-secondary fw-semibold mb-0">Return values
68847066
</div>
68857067
</section>
68867068

7069+
</article> <article class="border rounded-4 p-4 bg-body shadow-sm">
7070+
<div class="d-flex flex-wrap align-items-start justify-content-between gap-3 mb-3">
7071+
<div>
7072+
<h4 class="h5 mb-2" id="method_normalizeProjectRelativePath">
7073+
<span class="text-primary">normalizeProjectRelativePath()</span>
7074+
<a
7075+
href="classes/FastForward-DevTools-Console-Command-DocsCommand.html#method_normalizeProjectRelativePath"
7076+
class="ms-2 text-decoration-none text-body-secondary"
7077+
aria-label="Permalink"
7078+
title="Permalink"
7079+
>
7080+
<i class="fas fa-link small"></i>
7081+
</a>
7082+
</h4>
7083+
7084+
<div class="d-flex flex-wrap gap-2">
7085+
<span class="badge text-bg-light border text-dark">Private</span>
7086+
7087+
7088+
7089+
7090+
</div>
7091+
</div>
7092+
</div>
7093+
7094+
<aside class="d-flex flex-wrap align-items-center gap-2 mb-4 text-body-secondary small">
7095+
<i class="fas fa-map-marker-alt text-danger"></i>
7096+
7097+
<span>Defined in</span>
7098+
7099+
<abbr title="src/Console/Command/DocsCommand.php" class="text-decoration-none mb-0">
7100+
<a href="files/src-console-command-docscommand.html"><abbr title="src/Console/Command/DocsCommand.php">DocsCommand.php</abbr></a>
7101+
</abbr>
7102+
7103+
<span class="text-body-tertiary">:</span>
7104+
7105+
<span class="badge text-bg-light border">278</span>
7106+
7107+
</aside>
7108+
<div class="mb-4">
7109+
<p class="lead text-body-secondary mb-0">Normalizes a project-relative path for resilient default-option comparisons.</p>
7110+
</div>
7111+
7112+
7113+
<div class="mt-4">
7114+
<code class="d-inline-flex flex-wrap align-items-center gap-2 px-3 py-2 rounded-3 bg-body-tertiary border">
7115+
<span class="badge text-bg-light border text-dark">private</span>
7116+
7117+
7118+
7119+
7120+
7121+
<span class="text-primary fw-semibold">normalizeProjectRelativePath</span><span class="text-body-secondary">(</span><span><span class="text-info-emphasis">
7122+
string&nbsp;
7123+
</span><span class="text-primary">$path</span></span><span class="text-body-secondary">)</span><span class="text-body-secondary"> : </span><span class="text-info-emphasis">string</span></code>
7124+
</div>
7125+
7126+
<div class="mt-3 d-flex flex-wrap gap-2">
7127+
</div>
7128+
7129+
7130+
7131+
7132+
<section class="mt-4">
7133+
<div class="d-flex align-items-center gap-2 mb-3">
7134+
<i class="fas fa-sliders-h text-info"></i>
7135+
<h5 class="h6 text-uppercase text-body-secondary fw-semibold mb-0">Parameters</h5>
7136+
</div>
7137+
7138+
<div class="d-grid gap-3">
7139+
<div class="card border-0 bg-body-tertiary shadow-sm">
7140+
<div class="card-body p-3">
7141+
<div class="d-flex flex-wrap align-items-center gap-2 mb-2">
7142+
<code class="text-primary fw-semibold mb-0">$path</code>
7143+
7144+
<span class="text-body-secondary">:</span>
7145+
7146+
<span class="badge text-bg-light border text-dark">
7147+
string
7148+
</span>
7149+
7150+
</div>
7151+
7152+
<div>
7153+
7154+
<section class="mt-2">
7155+
<div>
7156+
<div class="d-flex align-items-center gap-2 mb-3">
7157+
<i class="fas fa-align-left text-primary"></i>
7158+
<h3 class="h6 text-uppercase text-body-secondary fw-semibold mb-0">Description</h3>
7159+
</div>
7160+
7161+
<div>
7162+
<p>the project-relative path to normalize</p>
7163+
7164+
</div>
7165+
</div>
7166+
</section>
7167+
7168+
</div>
7169+
</div>
7170+
</div>
7171+
</div>
7172+
</section>
7173+
7174+
7175+
7176+
7177+
7178+
<section class="mt-4">
7179+
<div class="d-flex align-items-center gap-2 mb-3">
7180+
<i class="fas fa-reply text-success"></i>
7181+
<h5 class="h6 text-uppercase text-body-secondary fw-semibold mb-0">Return values</h5>
7182+
</div>
7183+
7184+
<div class="card border-0 bg-body-tertiary shadow-sm">
7185+
<div class="card-body p-3">
7186+
<div class="d-flex flex-wrap align-items-center gap-2 mb-3">
7187+
<span class="badge text-bg-light border text-dark">
7188+
string
7189+
</span>
7190+
</div>
7191+
7192+
<div>
7193+
7194+
<section class="mt-2">
7195+
<div>
7196+
<div class="d-flex align-items-center gap-2 mb-3">
7197+
<i class="fas fa-align-left text-primary"></i>
7198+
<h3 class="h6 text-uppercase text-body-secondary fw-semibold mb-0">Description</h3>
7199+
</div>
7200+
7201+
<div>
7202+
<p>the normalized project-relative path</p>
7203+
7204+
</div>
7205+
</div>
7206+
</section>
7207+
7208+
</div>
7209+
</div>
7210+
</div>
7211+
</section>
7212+
68877213
</article> <article class="border rounded-4 p-4 bg-body shadow-sm">
68887214
<div class="d-flex flex-wrap align-items-start justify-content-between gap-3 mb-3">
68897215
<div>
@@ -7594,12 +7920,24 @@ <h5 class="modal-title d-flex align-items-center gap-2" id="source-view-label">
75947920
</a>
75957921
<a
75967922
class="list-group-item list-group-item-action px-0 py-2 border-0 bg-transparent d-flex align-items-center justify-content-between gap-2"
7923+
href="classes/FastForward-DevTools-Console-Command-DocsCommand.html#method_isDefaultGuideSource"
7924+
>
7925+
<span class="text-truncate">isDefaultGuideSource()</span>
7926+
</a>
7927+
<a
7928+
class="list-group-item list-group-item-action px-0 py-2 border-0 bg-transparent d-flex align-items-center justify-content-between gap-2"
75977929
href="classes/FastForward-DevTools-Console-Input-HasCacheOption.html#method_isNoCacheRequested"
75987930
>
75997931
<span class="text-truncate">isNoCacheRequested()</span>
76007932
</a>
76017933
<a
76027934
class="list-group-item list-group-item-action px-0 py-2 border-0 bg-transparent d-flex align-items-center justify-content-between gap-2"
7935+
href="classes/FastForward-DevTools-Console-Command-DocsCommand.html#method_normalizeProjectRelativePath"
7936+
>
7937+
<span class="text-truncate">normalizeProjectRelativePath()</span>
7938+
</a>
7939+
<a
7940+
class="list-group-item list-group-item-action px-0 py-2 border-0 bg-transparent d-flex align-items-center justify-content-between gap-2"
76037941
href="classes/FastForward-DevTools-Console-Command-Traits-LogsCommandResults.html#method_notice"
76047942
>
76057943
<span class="text-truncate">notice()</span>

0 commit comments

Comments
 (0)