Skip to content

Commit

Permalink
📝 CI: automated Generate Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Jun 7, 2023
1 parent 3e74004 commit 3f2ef47
Show file tree
Hide file tree
Showing 4 changed files with 351 additions and 27 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -195,6 +195,13 @@ <h3 id="toc">
<span>
&nbsp;: int|null </span>
</dt>
<dd></dd>

<dt class="phpdocumentor-table-of-contents__entry -property -public">
<a href="classes/amcintosh-FreshBooks-Exception-FreshBooksException.html#property_errorDetails">$errorDetails</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt;|null </span>
</dt>
<dd></dd>

<dt class="phpdocumentor-table-of-contents__entry -property -public">
Expand All @@ -216,6 +223,13 @@ <h3 id="toc">
<span>
&nbsp;: int|null </span>
</dt>
<dd></dd>

<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/amcintosh-FreshBooks-Exception-FreshBooksException.html#method_getErrorDetails">getErrorDetails()</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt;|null </span>
</dt>
<dd></dd>

<dt class="phpdocumentor-table-of-contents__entry -method -public">
Expand Down Expand Up @@ -270,6 +284,40 @@ <h4 class="phpdocumentor-element__name" id="property_errorCode">



</article>
<article
class="
phpdocumentor-element
-property
-public
"
>
<h4 class="phpdocumentor-element__name" id="property_errorDetails">
$errorDetails
<a href="classes/amcintosh-FreshBooks-Exception-FreshBooksException.html#property_errorDetails" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Exception/FreshBooksException.php"><a href="files/src-exception-freshbooksexception.html"><abbr title="src/Exception/FreshBooksException.php">FreshBooksException.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">11</span>

</aside>


<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;|null</span>
<span class="phpdocumentor-signature__name">$errorDetails</span>
</code>

<section class="phpdocumentor-description"></section>

<section class="phpdocumentor-description"></section>



</article>
<article
class="
Expand Down Expand Up @@ -325,14 +373,14 @@ <h4 class="phpdocumentor-element__name" id="method___construct">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Exception/FreshBooksException.php"><a href="files/src-exception-freshbooksexception.html"><abbr title="src/Exception/FreshBooksException.php">FreshBooksException.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">12</span>
<span class="phpdocumentor-element-found-in__line">13</span>

</aside>


<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">__construct</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$message</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$statusCode</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type"><abbr title="\amcintosh\FreshBooks\Exception\Throwable">Throwable</abbr>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$previous</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$rawResponse</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$errorCode</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<span class="phpdocumentor-signature__name">__construct</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$message</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$statusCode</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type"><abbr title="\amcintosh\FreshBooks\Exception\Throwable">Throwable</abbr>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$previous</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$rawResponse</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$errorCode</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$errorDetails</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>

<section class="phpdocumentor-description"></section>

Expand Down Expand Up @@ -377,6 +425,14 @@ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>

</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$errorDetails</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
= <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>

</dd>
</dl>

Expand All @@ -401,7 +457,7 @@ <h4 class="phpdocumentor-element__name" id="method_getErrorCode">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Exception/FreshBooksException.php"><a href="files/src-exception-freshbooksexception.html"><abbr title="src/Exception/FreshBooksException.php">FreshBooksException.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">30</span>
<span class="phpdocumentor-element-found-in__line">33</span>

</aside>

Expand All @@ -420,6 +476,39 @@ <h5 class="phpdocumentor-return-value__heading">Return values</h5>
&mdash;


</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getErrorDetails">
getErrorDetails()
<a href="classes/amcintosh-FreshBooks-Exception-FreshBooksException.html#method_getErrorDetails" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Exception/FreshBooksException.php"><a href="files/src-exception-freshbooksexception.html"><abbr title="src/Exception/FreshBooksException.php">FreshBooksException.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">38</span>

</aside>


<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getErrorDetails</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;|null</span></code>

<section class="phpdocumentor-description"></section>




<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;|null</span>
&mdash;


</article>
<article
class="phpdocumentor-element
Expand All @@ -434,7 +523,7 @@ <h4 class="phpdocumentor-element__name" id="method_getRawResponse">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Exception/FreshBooksException.php"><a href="files/src-exception-freshbooksexception.html"><abbr title="src/Exception/FreshBooksException.php">FreshBooksException.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">25</span>
<span class="phpdocumentor-element-found-in__line">28</span>

</aside>

Expand Down
Loading

0 comments on commit 3f2ef47

Please sign in to comment.