Skip to content

Commit

Permalink
feature: Created documentations
Browse files Browse the repository at this point in the history
  • Loading branch information
@dogukanoksuz
dogukanoksuz committed Jan 30, 2023
1 parent d45f0bd commit a1079b7
Show file tree
Hide file tree
Showing 48 changed files with 14,017 additions and 0 deletions.
577 changes: 577 additions & 0 deletions docs/classes/Liman-Toolkit-Formatter.html
View file

Large diffs are not rendered by default.

828 changes: 828 additions & 0 deletions docs/classes/Liman-Toolkit-OS-Distro.html
View file

Large diffs are not rendered by default.

724 changes: 724 additions & 0 deletions docs/classes/Liman-Toolkit-OS-DistroInfo.html
View file

Large diffs are not rendered by default.

783 changes: 783 additions & 0 deletions docs/classes/Liman-Toolkit-RemoteTask-Task.html
View file

Large diffs are not rendered by default.

461 changes: 461 additions & 0 deletions docs/classes/Liman-Toolkit-RemoteTask-TaskCheckStatus.html
View file

Large diffs are not rendered by default.

346 changes: 346 additions & 0 deletions docs/classes/Liman-Toolkit-RemoteTask-TaskCheckStatusEnum.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,346 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Documentation</title>

<meta name="viewport" content="width=device-width, initial-scale=1.0">
<base href="../">
<link rel="icon" href="images/favicon.ico"/>
<link rel="stylesheet" href="css/normalize.css">
<link rel="stylesheet" href="css/base.css">
<link rel="preconnect" href="https://fonts.gstatic.com">
<link href="https://fonts.googleapis.com/css2?family=Source+Sans+Pro:wght@400;600;700&display=swap" rel="stylesheet">
<link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
<link rel="stylesheet" href="css/template.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
<script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
<script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
<script src="js/search.js"></script>
<script defer src="js/searchIndex.js"></script>
</head>
<body id="top">
<header class="phpdocumentor-header phpdocumentor-section">
<h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
<input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
<label class="phpdocumentor-header__menu-icon" for="menu-button">
<i class="fas fa-bars"></i>
</label>
<section data-search-form class="phpdocumentor-search">
<label>
<span class="visually-hidden">Search for</span>
<svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
<circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
<line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
</svg>
<input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
</label>
</section>

<nav class="phpdocumentor-topnav">
<ul class="phpdocumentor-topnav__menu">
</ul>
</nav>
</header>

<main class="phpdocumentor">
<div class="phpdocumentor-section">
<input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
<label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
Menu
</label>
<aside class="phpdocumentor-column -four phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="namespaces/liman.html" class="">Liman</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="namespaces/liman-toolkit.html" class="">Toolkit</a>

</li>
</ul>

</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="packages/Application.html" class="">Application</a>
</h4>

</section>

<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
</section>

<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
</section>
</aside>

<div class="phpdocumentor-column -eight phpdocumentor-content">
<ul class="phpdocumentor-breadcrumbs">
<li class="phpdocumentor-breadcrumb"><a href="namespaces/liman.html">Liman</a></li>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/liman-toolkit.html">Toolkit</a></li>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/liman-toolkit-remotetask.html">RemoteTask</a></li>
</ul>

<article class="phpdocumentor-element -class">
<h2 class="phpdocumentor-content__title">
TaskCheckStatusEnum


<div class="phpdocumentor-element__package">
in package
<ul class="phpdocumentor-breadcrumbs">
<li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
</ul>
</div>


</h2>

<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/RemoteTask/TaskCheckStatusEnum.php"><a href="files/src-remotetask-taskcheckstatusenum.html"><abbr title="src/RemoteTask/TaskCheckStatusEnum.php">TaskCheckStatusEnum.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">4</span>

</aside>


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








<h3 id="toc">
Table of Contents
<a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
</h3>

<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a href="classes/Liman-Toolkit-RemoteTask-TaskCheckStatusEnum.html#constant_Failed">Failed</a>
<span>
&nbsp;= &#039;failed&#039; </span>
</dt>
<dd></dd>

<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a href="classes/Liman-Toolkit-RemoteTask-TaskCheckStatusEnum.html#constant_Pending">Pending</a>
<span>
&nbsp;= &#039;pending&#039; </span>
</dt>
<dd></dd>

<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a href="classes/Liman-Toolkit-RemoteTask-TaskCheckStatusEnum.html#constant_Success">Success</a>
<span>
&nbsp;= &#039;success&#039; </span>
</dt>
<dd></dd>

</dl>




<section class="phpdocumentor-constants">
<h3 class="phpdocumentor-elements__header" id="constants">
Constants
<a href="classes/Liman-Toolkit-RemoteTask-TaskCheckStatusEnum.html#constants" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_Failed">
Failed
<a href="classes/Liman-Toolkit-RemoteTask-TaskCheckStatusEnum.html#constant_Failed" 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/RemoteTask/TaskCheckStatusEnum.php"><a href="files/src-remotetask-taskcheckstatusenum.html"><abbr title="src/RemoteTask/TaskCheckStatusEnum.php">TaskCheckStatusEnum.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">7</span>

</aside>


<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">Failed</span>
= <span class="phpdocumentor-signature__default-value">&#039;failed&#039;</span>
</code>


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

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



</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_Pending">
Pending
<a href="classes/Liman-Toolkit-RemoteTask-TaskCheckStatusEnum.html#constant_Pending" 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/RemoteTask/TaskCheckStatusEnum.php"><a href="files/src-remotetask-taskcheckstatusenum.html"><abbr title="src/RemoteTask/TaskCheckStatusEnum.php">TaskCheckStatusEnum.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">6</span>

</aside>


<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">Pending</span>
= <span class="phpdocumentor-signature__default-value">&#039;pending&#039;</span>
</code>


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

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



</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_Success">
Success
<a href="classes/Liman-Toolkit-RemoteTask-TaskCheckStatusEnum.html#constant_Success" 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/RemoteTask/TaskCheckStatusEnum.php"><a href="files/src-remotetask-taskcheckstatusenum.html"><abbr title="src/RemoteTask/TaskCheckStatusEnum.php">TaskCheckStatusEnum.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">8</span>

</aside>


<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">Success</span>
= <span class="phpdocumentor-signature__default-value">&#039;success&#039;</span>
</code>


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

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



</article>
</section>





<script type="text/javascript">
function loadExternalCodeSnippets(line) {
Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
var src = pre.getAttribute('data-src').replace( /\\/g, '/');
var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
var language = 'php';

var code = document.createElement('code');
code.className = 'language-' + language;

pre.textContent = '';

pre.setAttribute('data-line', line)
code.textContent = 'Loading…';

pre.appendChild(code);

var xhr = new XMLHttpRequest();

xhr.open('GET', src, true);

xhr.onreadystatechange = function () {
if (xhr.readyState == 4) {

if (xhr.status < 400 && xhr.responseText) {
code.textContent = xhr.responseText;

Prism.highlightElement(code);
}
else if (xhr.status >= 400) {
code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
}
else {
code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
}
}
};

xhr.send(null);
});
}

var modals = document.querySelectorAll("[data-modal]");

modals.forEach(function (trigger) {
trigger.addEventListener("click", function (event) {
//event.preventDefault();
const modal = document.getElementById(trigger.dataset.modal);
modal.classList.add("phpdocumentor-modal__open");
loadExternalCodeSnippets(trigger.dataset.line)
const exits = modal.querySelectorAll("[data-exit-button]");
exits.forEach(function (exit) {
exit.addEventListener("click", function (event) {
event.preventDefault();
modal.classList.remove("phpdocumentor-modal__open");
});
});
});
});
</script>

</article>
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
<section class="phpdocumentor-search-results__dialog">
<header class="phpdocumentor-search-results__header">
<h2 class="phpdocumentor-search-results__title">Search results</h2>
<button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
</header>
<section class="phpdocumentor-search-results__body">
<ul class="phpdocumentor-search-results__entries"></ul>
</section>
</section>
</section>
</div>
</div>
<a href="classes/Liman-Toolkit-RemoteTask-TaskCheckStatusEnum.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>

</main>

<script>
cssVars({});
</script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
</body>
</html>
Loading

0 comments on commit a1079b7

Please sign in to comment.