Deploying to gh-pages from @ 39b3b2a 🚀

classes/chillerlan-OAuth-Core-AccessToken.html

@@ -160,7 +160,7 @@ <h3 id="toc">
     <span>
         &nbsp;= 86400 * 365                            </span>
 </dt>
-<dd>defines a maximum expiry period (1 year)</dd>
+<dd>Defines a maximum expiry period (1 year)</dd>
 
                     <dt class="phpdocumentor-table-of-contents__entry -property -public">
     <a href="classes/chillerlan-OAuth-Core-AccessToken.html#property_accessToken">$accessToken</a>
@@ -216,21 +216,21 @@ <h3 id="toc">
     <span>
                         &nbsp;: string|null            </span>
 </dt>
-<dd>the oauth access token</dd>
+<dd>The oauth access token</dd>
 
             <dt class="phpdocumentor-table-of-contents__entry -property -protected">
     <a href="classes/chillerlan-OAuth-Core-AccessToken.html#property_accessTokenSecret">$accessTokenSecret</a>
     <span>
                         &nbsp;: string|null            </span>
 </dt>
-<dd>the access token secret (OAuth1)</dd>
+<dd>The access token secret (OAuth1)</dd>
 
             <dt class="phpdocumentor-table-of-contents__entry -property -protected">
     <a href="classes/chillerlan-OAuth-Core-AccessToken.html#property_expires">$expires</a>
     <span>
                         &nbsp;: int|null            </span>
 </dt>
-<dd>the token expiration date/time</dd>
+<dd>The token expiration date/time</dd>
 
             <dt class="phpdocumentor-table-of-contents__entry -property -protected">
     <a href="classes/chillerlan-OAuth-Core-AccessToken.html#property_extraParams">$extraParams</a>
@@ -244,14 +244,14 @@ <h3 id="toc">
     <span>
                         &nbsp;: string|null            </span>
 </dt>
-<dd>the provider who issued this token</dd>
+<dd>The provider who issued this token</dd>
 
             <dt class="phpdocumentor-table-of-contents__entry -property -protected">
     <a href="classes/chillerlan-OAuth-Core-AccessToken.html#property_refreshToken">$refreshToken</a>
     <span>
                         &nbsp;: string|null            </span>
 </dt>
-<dd>an optional refresh token (OAuth2)</dd>
+<dd>An optional refresh token (OAuth2)</dd>
 
             <dt class="phpdocumentor-table-of-contents__entry -property -protected">
     <a href="classes/chillerlan-OAuth-Core-AccessToken.html#property_scopes">$scopes</a>
@@ -272,21 +272,21 @@ <h3 id="toc">
     <span>
                                 &nbsp;: bool    </span>
 </dt>
-<dd></dd>
+<dd>Checks whether this token is expired</dd>
 
             <dt class="phpdocumentor-table-of-contents__entry -method -public">
     <a href="classes/chillerlan-OAuth-Core-AccessToken.html#method_setExpiry">setExpiry()</a>
     <span>
                                 &nbsp;: <a href="classes/chillerlan-OAuth-Core-AccessToken.html"><abbr title="\chillerlan\OAuth\Core\AccessToken">AccessToken</abbr></a>    </span>
 </dt>
-<dd></dd>
+<dd>Sets the expiration for this token</dd>
 
             <dt class="phpdocumentor-table-of-contents__entry -method -protected">
     <a href="classes/chillerlan-OAuth-Core-AccessToken.html#method_set_expires">set_expires()</a>
     <span>
                                 &nbsp;: void    </span>
 </dt>
-<dd></dd>
+<dd>Expiry setter</dd>
 
         </dl>
 
@@ -369,7 +369,7 @@ <h4 class="phpdocumentor-element__name" id="constant_EXPIRY_MAX">
 
     </aside>
 
-        <p class="phpdocumentor-summary">defines a maximum expiry period (1 year)</p>
+        <p class="phpdocumentor-summary">Defines a maximum expiry period (1 year)</p>
 
     <code class="phpdocumentor-signature phpdocumentor-code ">
     <span class="phpdocumentor-signature__visibility">public</span>
@@ -648,7 +648,7 @@ <h4 class="phpdocumentor-element__name" id="property_accessToken">
 
     </aside>
 
-        <p class="phpdocumentor-summary">the oauth access token</p>
+        <p class="phpdocumentor-summary">The oauth access token</p>
 
     <code class="phpdocumentor-code phpdocumentor-signature ">
     <span class="phpdocumentor-signature__visibility">protected</span>
@@ -682,7 +682,7 @@ <h4 class="phpdocumentor-element__name" id="property_accessTokenSecret">
 
     </aside>
 
-        <p class="phpdocumentor-summary">the access token secret (OAuth1)</p>
+        <p class="phpdocumentor-summary">The access token secret (OAuth1)</p>
 
     <code class="phpdocumentor-code phpdocumentor-signature ">
     <span class="phpdocumentor-signature__visibility">protected</span>
@@ -716,7 +716,7 @@ <h4 class="phpdocumentor-element__name" id="property_expires">
 
     </aside>
 
-        <p class="phpdocumentor-summary">the token expiration date/time</p>
+        <p class="phpdocumentor-summary">The token expiration date/time</p>
 
     <code class="phpdocumentor-code phpdocumentor-signature ">
     <span class="phpdocumentor-signature__visibility">protected</span>
@@ -799,7 +799,7 @@ <h4 class="phpdocumentor-element__name" id="property_provider">
 
     </aside>
 
-        <p class="phpdocumentor-summary">the provider who issued this token</p>
+        <p class="phpdocumentor-summary">The provider who issued this token</p>
 
     <code class="phpdocumentor-code phpdocumentor-signature ">
     <span class="phpdocumentor-signature__visibility">protected</span>
@@ -833,7 +833,7 @@ <h4 class="phpdocumentor-element__name" id="property_refreshToken">
 
     </aside>
 
-        <p class="phpdocumentor-summary">an optional refresh token (OAuth2)</p>
+        <p class="phpdocumentor-summary">An optional refresh token (OAuth2)</p>
 
     <code class="phpdocumentor-code phpdocumentor-signature ">
     <span class="phpdocumentor-signature__visibility">protected</span>
@@ -904,25 +904,26 @@ <h4 class="phpdocumentor-element__name" id="method___construct">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Core/AccessToken.php"><a href="files/src-core-accesstoken.html"><abbr title="src/Core/AccessToken.php">AccessToken.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">94</span>
+    <span class="phpdocumentor-element-found-in__line">92</span>
 
     </aside>
 
         <p class="phpdocumentor-summary">AccessToken constructor.</p>
 
     <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>[</span><span class="phpdocumentor-signature__argument__return-type">iteratable&lt;string|int, mixed&gt;|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$properties</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>[</span><span class="phpdocumentor-signature__argument__return-type">iteratable&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$properties</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>
 
 
         <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
     <dl class="phpdocumentor-argument-list">
                     <dt class="phpdocumentor-argument-list__entry">
                 <span class="phpdocumentor-signature__argument__name">$properties</span>
-                : <span class="phpdocumentor-signature__argument__return-type">iteratable&lt;string|int, mixed&gt;|null</span>
+                : <span class="phpdocumentor-signature__argument__return-type">iteratable&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>
 
@@ -947,11 +948,12 @@ <h4 class="phpdocumentor-element__name" id="method_isExpired">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Core/AccessToken.php"><a href="files/src-core-accesstoken.html"><abbr title="src/Core/AccessToken.php">AccessToken.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">136</span>
+    <span class="phpdocumentor-element-found-in__line">130</span>
 
     </aside>
 
-
+        <p class="phpdocumentor-summary">Checks whether this token is expired</p>
+
     <code class="phpdocumentor-code phpdocumentor-signature ">
     <span class="phpdocumentor-signature__visibility">public</span>
                     <span class="phpdocumentor-signature__name">isExpired</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
@@ -979,24 +981,26 @@ <h4 class="phpdocumentor-element__name" id="method_setExpiry">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Core/AccessToken.php"><a href="files/src-core-accesstoken.html"><abbr title="src/Core/AccessToken.php">AccessToken.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">114</span>
+    <span class="phpdocumentor-element-found-in__line">108</span>
 
     </aside>
 
-
+        <p class="phpdocumentor-summary">Sets the expiration for this token</p>
+
     <code class="phpdocumentor-code phpdocumentor-signature ">
     <span class="phpdocumentor-signature__visibility">public</span>
-                    <span class="phpdocumentor-signature__name">setExpiry</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">int|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$expires</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"><a href="classes/chillerlan-OAuth-Core-AccessToken.html"><abbr title="\chillerlan\OAuth\Core\AccessToken">AccessToken</abbr></a></span></code>
+                    <span class="phpdocumentor-signature__name">setExpiry</span><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">$expires</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"><a href="classes/chillerlan-OAuth-Core-AccessToken.html"><abbr title="\chillerlan\OAuth\Core\AccessToken">AccessToken</abbr></a></span></code>
 
 
         <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
     <dl class="phpdocumentor-argument-list">
                     <dt class="phpdocumentor-argument-list__entry">
                 <span class="phpdocumentor-signature__argument__name">$expires</span>
-                : <span class="phpdocumentor-signature__argument__return-type">int|null</span>
+                : <span class="phpdocumentor-signature__argument__return-type">int</span>
                  = <span class="phpdocumentor-signature__argument__default-value">null</span>            </dt>
             <dd class="phpdocumentor-argument-list__definition">
-
+                    <section class="phpdocumentor-description"></section>
+
             </dd>
             </dl>
 
@@ -1021,24 +1025,26 @@ <h4 class="phpdocumentor-element__name" id="method_set_expires">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Core/AccessToken.php"><a href="files/src-core-accesstoken.html"><abbr title="src/Core/AccessToken.php">AccessToken.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">105</span>
+    <span class="phpdocumentor-element-found-in__line">101</span>
 
     </aside>
 
-
+        <p class="phpdocumentor-summary">Expiry setter</p>
+
     <code class="phpdocumentor-code phpdocumentor-signature ">
     <span class="phpdocumentor-signature__visibility">protected</span>
-                    <span class="phpdocumentor-signature__name">set_expires</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">int|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$expires</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">void</span></code>
+                    <span class="phpdocumentor-signature__name">set_expires</span><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">$expires</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">void</span></code>
 
 
         <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
     <dl class="phpdocumentor-argument-list">
                     <dt class="phpdocumentor-argument-list__entry">
                 <span class="phpdocumentor-signature__argument__name">$expires</span>
-                : <span class="phpdocumentor-signature__argument__return-type">int|null</span>
+                : <span class="phpdocumentor-signature__argument__return-type">int</span>
                  = <span class="phpdocumentor-signature__argument__default-value">null</span>            </dt>
             <dd class="phpdocumentor-argument-list__definition">
-
+                    <section class="phpdocumentor-description"></section>
+
             </dd>
             </dl>