Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
stefangabos committed Dec 4, 2024
1 parent d9d0c48 commit a9e18c2
Show file tree
Hide file tree
Showing 5 changed files with 30 additions and 8 deletions.
10 changes: 4 additions & 6 deletions docs/Zebra_cURL/Zebra_cURL.html
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ <h4>Author(s):</h4>
</ul>
<h4>Version:</h4>
<ul>
<li>1.6.3 (last revision: September 14, 2024)<br>See <a href="https://github.com/stefangabos/Zebra_cURL/blob/master/CHANGELOG.md" class="projects-homepage">CHANGELOG</a></li>
<li>1.6.3 (last revision: December 04, 2024)<br>See <a href="https://github.com/stefangabos/Zebra_cURL/blob/master/CHANGELOG.md" class="projects-homepage">CHANGELOG</a></li>
</ul>
<h4>License:</h4>
<ul>
Expand All @@ -76,8 +76,6 @@ <h4>Copyright:</h4>
<li>© 2013 - 2024 Stefan Gabos</li>
</ul>
<div id="top" class="doc_toc">
</div>
<div id="top" class="doc_toc">
<div class="left">
<h3>Properties</h3>
<ul>
Expand Down Expand Up @@ -114,7 +112,7 @@ <h3>Methods</h3>
<div class="clear"></div>
</div>
<h3 id="class_vars">Class properties</h3>
<h4 id="var$pause_interval" class="variable"><span><em>integer</em></span> $pause_interval <span class="value"></span></h4>
<h4 id="var$pause_interval" class="variable"><span><em>integer</em></span> $pause_interval <span class="value"></span><span class="access public">public</span></h4>
<div class="doc_block">
<p>The number of seconds to wait between processing batches of requests.</p>
<p>If the value of this property is greater than <code>0</code>, the library will process as many requests as defined by the <a href="../Zebra_cURL/Zebra_cURL.html#var$threads">threads</a> property and then wait for <a href="../Zebra_cURL/Zebra_cURL.html#var$pause_interval">pause_interval</a> seconds before processing the next batch of requests.</p><p>Default is <code>0</code> (the library will keep as many parallel threads as defined by <a href="../Zebra_cURL/Zebra_cURL.html#var$threads">threads</a> running at all times until there are no more requests to process).</p>
Expand All @@ -128,7 +126,7 @@ <h5>Tags</h5>
<a href="#top" class="top">top</a>
<div class="clear"></div>
</div>
<h4 id="var$threads" class="variable"><span><em>integer</em></span> $threads <span class="value"></span></h4>
<h4 id="var$threads" class="variable"><span><em>integer</em></span> $threads <span class="value"></span><span class="access public">public</span></h4>
<div class="doc_block">
<p>The number of parallel, asynchronous requests to be processed by the library, at once.</p>
<p><ol class="code"><li><div class="src-line"><span class="src-comm">//&nbsp;process&nbsp;30&nbsp;simultaneous&nbsp;requests&nbsp;at&nbsp;once</span></div></li>
Expand Down Expand Up @@ -1614,7 +1612,7 @@ <h5>Tags</h5>
</tr>
</table>
<div id="doc_footer">
Documentation generated on <span>Sat, 14 September 2024</span>
Documentation generated on <span>Wed, 04 December 2024</span>
</div>
</div>
<!-- Google tag (gtag.js) --><script async src="https://www.googletagmanager.com/gtag/js?id=G-0301ZD47Q7"></script><script>window.dataLayer = window.dataLayer || [];function gtag(){dataLayer.push(arguments);}gtag('js', new Date());gtag('config', 'G-0301ZD47Q7');</script></body>
Expand Down
2 changes: 1 addition & 1 deletion docs/elementindex_Zebra_cURL.html
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,7 @@ <h3 id="z">z</h3>
</tr>
</table>
<div id="doc_footer">
Documentation generated on <span>Sat, 14 September 2024</span>
Documentation generated on <span>Wed, 04 December 2024</span>
</div>
</div>
<!-- Google tag (gtag.js) --><script async src="https://www.googletagmanager.com/gtag/js?id=G-0301ZD47Q7"></script><script>window.dataLayer = window.dataLayer || [];function gtag(){dataLayer.push(arguments);}gtag('js', new Date());gtag('config', 'G-0301ZD47Q7');</script></body>
Expand Down
2 changes: 1 addition & 1 deletion docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ <h2>Zebra cURL - a high performance cURL PHP library allowing the running of mul
</tr>
</table>
<div id="doc_footer">
Documentation generated on <span>Sat, 14 September 2024</span>
Documentation generated on <span>Wed, 04 December 2024</span>
</div>
</div>
<!-- Google tag (gtag.js) --><script async src="https://www.googletagmanager.com/gtag/js?id=G-0301ZD47Q7"></script><script>window.dataLayer = window.dataLayer || [];function gtag(){dataLayer.push(arguments);}gtag('js', new Date());gtag('config', 'G-0301ZD47Q7');</script></body>
Expand Down
Binary file added docs/media/padlock.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
24 changes: 24 additions & 0 deletions docs/media/style.css
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,24 @@ h4.variable span.value {
color: #C40000;
}

h4.variable span.access {
position: absolute;
right: 0;
font-size: 70%;
padding: 2px .5em;
border: 1px solid #fafafa;
color: #FFF;
border-radius: 5px;
}

h4.variable span.access.public {
background: #009688;
}

h4.variable span.access.protected {
background: #3f51b5;
}

.doc_block,
.doc_index {
/* padding: 1em; */
Expand Down Expand Up @@ -297,6 +315,12 @@ a.top:before:hover {

.clear { clear: both }

.access-icon {
position: relative;
top: 2px;
opacity: .5;
}

/* SYNTAX HIGHLIGHTING */
.src-code {
background-color: #F5F5F5;
Expand Down

0 comments on commit a9e18c2

Please sign in to comment.