Updated the API reference

cedx · May 3, 2022 · 3928cd0 · 3928cd0
1 parent 091d1c4
commit 3928cd0
Show file tree

Hide file tree

Showing 33 changed files with 1,880 additions and 3,173 deletions.
diff --git a/docs/classes/Lcov-BranchCoverage.html b/docs/classes/Lcov-BranchCoverage.html
diff --git a/docs/classes/Lcov-BranchData.html b/docs/classes/Lcov-BranchData.html
diff --git a/docs/classes/Lcov-FunctionCoverage.html b/docs/classes/Lcov-FunctionCoverage.html
diff --git a/docs/classes/Lcov-FunctionData.html b/docs/classes/Lcov-FunctionData.html
diff --git a/docs/classes/Lcov-LcovException.html b/docs/classes/Lcov-LcovException.html
diff --git a/docs/classes/Lcov-LineCoverage.html b/docs/classes/Lcov-LineCoverage.html
diff --git a/docs/classes/Lcov-LineData.html b/docs/classes/Lcov-LineData.html
diff --git a/docs/classes/Lcov-Report.html b/docs/classes/Lcov-Report.html
diff --git a/docs/classes/Lcov-Record.html → docs/classes/Lcov-SourceFile.html b/docs/classes/Lcov-Record.html → docs/classes/Lcov-SourceFile.html
diff --git a/docs/classes/Lcov-Token.html b/docs/classes/Lcov-Token.html
diff --git a/docs/css/base.css b/docs/css/base.css
@@ -21,21 +21,23 @@
     --text-xxxxxl: calc(var(--text-base-size) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio));
 
     /* Colors */
-    --primary-color: hsl(96, 57%, 60%);
-    --primary-color-darken: hsl(96, 57%, 40%);
-    --primary-color-darker: hsl(96, 57%, 20%);
-    --primary-color-darkest: hsl(96, 57%, 10%);
-    --primary-color-lighten: hsl(96, 57%, 80%);
-    --primary-color-lighter: hsl(96, 57%, 99%);
+    --primary-color-hue: 96;
+    --primary-color-saturation: 57%;
+    --primary-color: hsl(var(--primary-color-hue), var(--primary-color-saturation), 60%);
+    --primary-color-darken: hsl(var(--primary-color-hue), var(--primary-color-saturation), 40%);
+    --primary-color-darker: hsl(var(--primary-color-hue), var(--primary-color-saturation), 20%);
+    --primary-color-darkest: hsl(var(--primary-color-hue), var(--primary-color-saturation), 10%);
+    --primary-color-lighten: hsl(var(--primary-color-hue), var(--primary-color-saturation), 80%);
+    --primary-color-lighter: hsl(var(--primary-color-hue), var(--primary-color-saturation), 99%);
     --dark-gray: #d1d1d1;
     --light-gray: #f0f0f0;
 
     --text-color: var(--primary-color-darkest);
 
     --header-height: var(--spacing-xxxxl);
     --header-bg-color: var(--primary-color);
-    --code-background-color: #f7faf5;
-    --code-border-color: #d6e7cb;
+    --code-background-color: var(--primary-color-lighter);
+    --code-border-color: --primary-color-lighten;
     --button-border-color: var(--primary-color-darken);
     --button-color: transparent;
     --button-color-primary: var(--primary-color);
@@ -82,6 +84,7 @@ body {
     font-size: var(--text-md);
     letter-spacing: var(--letter-spacing--primary);
     line-height: var(--line-height--primary);
+    width: 100%;
 }
 
 .phpdocumentor h1,
@@ -173,6 +176,11 @@ body {
     font-style: italic;
     font-size: 80%;
 }
+
+.phpdocumentor-uml-diagram svg {
+    max-width: 100%;
+    height: auto !important;
+}
 .phpdocumentor-line {
     border-top: 1px solid #E1E1E1;
     border-width: 0;
@@ -432,27 +440,33 @@ input[type="checkbox"].phpdocumentor-field,
 input[type="radio"].phpdocumentor-field {
     display: inline;
 }
+.phpdocumentor-column ul,
 div.phpdocumentor-list > ul,
 ul.phpdocumentor-list {
-    list-style: circle inside;
+    list-style: circle;
 }
 
+.phpdocumentor-column ol,
+div.phpdocumentor-list > ol,
 ol.phpdocumentor-list {
-    list-style: decimal inside;
+    list-style: decimal;
 }
 
+
+.phpdocumentor-column ul,
 div.phpdocumentor-list > ul,
 ol.phpdocumentor-list,
 ul.phpdocumentor-list {
     margin-top: 0;
-    padding-left: 0;
+    padding-left: 1rem;
     margin-bottom: var(--spacing-md);
 }
 
 dl {
     margin-bottom: var(--spacing-md);
 }
 
+.phpdocumentor-column ul ul,
 div.phpdocumentor-list > ul ul,
 ul.phpdocumentor-list ul.phpdocumentor-list,
 ul.phpdocumentor-list ol.phpdocumentor-list,
@@ -462,8 +476,9 @@ ol.phpdocumentor-list ul.phpdocumentor-list {
     margin: var(--spacing-xs) 0 var(--spacing-xs) calc(var(--spacing-xs) * 2);
 }
 
-li.phpdocumentor-list {
-    margin-bottom: var(--spacing-md);
+.phpdocumentor-column ul li,
+.phpdocumentor-list li {
+    padding-bottom: var(--spacing-xs);
 }
 
 .phpdocumentor dl dt {
@@ -732,7 +747,8 @@ td.phpdocumentor-cell:last-child {
     transition: padding-left .4s ease-out;
 }
 
-.phpdocumentor .phpdocumentor-sidebar a:hover {
+.phpdocumentor .phpdocumentor-sidebar a:hover,
+.phpdocumentor .phpdocumentor-sidebar a.-active {
     padding-left: 5px;
     font-weight: 600;
 }
@@ -1058,6 +1074,8 @@ td.phpdocumentor-cell:last-child {
     background: #fff;
     position: relative;
     padding: 2em;
+    box-sizing: border-box;
+    max-width:100vw;
 }
 
 .phpdocumentor-modal__close {

diff --git a/docs/css/template.css b/docs/css/template.css
@@ -142,6 +142,10 @@
     content: 'P'
 }
 
+.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-enum:before {
+    content: 'E'
+}
+
 .phpdocumentor-table-of-contents dd {
     font-style: italic;
     margin-left: 2rem;

diff --git a/docs/files/src-branchcoverage.html → docs/files/lib-branchcoverage.html b/docs/files/src-branchcoverage.html → docs/files/lib-branchcoverage.html
@@ -2,7 +2,8 @@
 <html lang="en">
 <head>
     <meta charset="utf-8">
-    <title>LCOV Reports for PHP</title>
+            <title>LCOV Reports for PHP</title>
+
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <base href="../">
     <link rel="icon" href="images/favicon.ico"/>
@@ -54,12 +55,16 @@ <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">LCO
 <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/lcov.html">Lcov</a></h4>
+                                    <h4 class="phpdocumentor-sidebar__root-namespace">
+    <a href="namespaces/lcov.html" class="">Lcov</a>
+</h4>
 
                         </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">Application</a></h4>
+                                    <h4 class="phpdocumentor-sidebar__root-namespace">
+    <a href="packages/Application.html" class="">Application</a>
+</h4>
 
                         </section>
 
@@ -92,7 +97,7 @@ <h2 class="phpdocumentor-content__title">BranchCoverage.php</h2>
 
 
 <h3 id="interfaces_class_traits">
-    Interfaces, Classes and Traits
+    Interfaces, Classes, Traits and Enums
     <a href="#interfaces_class_traits" class="headerlink"><i class="fas fa-link"></i></a>
 </h3>
 
@@ -101,6 +106,7 @@ <h3 id="interfaces_class_traits">
             <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Lcov-BranchCoverage.html"><abbr title="\Lcov\BranchCoverage">BranchCoverage</abbr></a></dt>
         <dd>Provides the coverage data of branches.</dd>
 
+
     </dl>
 
 
@@ -124,7 +130,7 @@ <h2 class="phpdocumentor-search-results__title">Search results</h2>
 </section>
             </div>
         </div>
-        <a href="files/src-branchcoverage.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
+        <a href="files/lib-branchcoverage.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
 
     </main>
 

diff --git a/docs/files/src-branchdata.html → docs/files/lib-branchdata.html b/docs/files/src-branchdata.html → docs/files/lib-branchdata.html
@@ -2,7 +2,8 @@
 <html lang="en">
 <head>
     <meta charset="utf-8">
-    <title>LCOV Reports for PHP</title>
+            <title>LCOV Reports for PHP</title>
+
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <base href="../">
     <link rel="icon" href="images/favicon.ico"/>
@@ -54,12 +55,16 @@ <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">LCO
 <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/lcov.html">Lcov</a></h4>
+                                    <h4 class="phpdocumentor-sidebar__root-namespace">
+    <a href="namespaces/lcov.html" class="">Lcov</a>
+</h4>
 
                         </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">Application</a></h4>
+                                    <h4 class="phpdocumentor-sidebar__root-namespace">
+    <a href="packages/Application.html" class="">Application</a>
+</h4>
 
                         </section>
 
@@ -92,7 +97,7 @@ <h2 class="phpdocumentor-content__title">BranchData.php</h2>
 
 
 <h3 id="interfaces_class_traits">
-    Interfaces, Classes and Traits
+    Interfaces, Classes, Traits and Enums
     <a href="#interfaces_class_traits" class="headerlink"><i class="fas fa-link"></i></a>
 </h3>
 
@@ -101,6 +106,7 @@ <h3 id="interfaces_class_traits">
             <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Lcov-BranchData.html"><abbr title="\Lcov\BranchData">BranchData</abbr></a></dt>
         <dd>Provides details for branch coverage.</dd>
 
+
     </dl>
 
 
@@ -124,7 +130,7 @@ <h2 class="phpdocumentor-search-results__title">Search results</h2>
 </section>
             </div>
         </div>
-        <a href="files/src-branchdata.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
+        <a href="files/lib-branchdata.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
 
     </main>
 

diff --git a/docs/files/src-functioncoverage.html → docs/files/lib-functioncoverage.html b/docs/files/src-functioncoverage.html → docs/files/lib-functioncoverage.html
@@ -2,7 +2,8 @@
 <html lang="en">
 <head>
     <meta charset="utf-8">
-    <title>LCOV Reports for PHP</title>
+            <title>LCOV Reports for PHP</title>
+
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <base href="../">
     <link rel="icon" href="images/favicon.ico"/>
@@ -54,12 +55,16 @@ <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">LCO
 <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/lcov.html">Lcov</a></h4>
+                                    <h4 class="phpdocumentor-sidebar__root-namespace">
+    <a href="namespaces/lcov.html" class="">Lcov</a>
+</h4>
 
                         </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">Application</a></h4>
+                                    <h4 class="phpdocumentor-sidebar__root-namespace">
+    <a href="packages/Application.html" class="">Application</a>
+</h4>
 
                         </section>
 
@@ -92,7 +97,7 @@ <h2 class="phpdocumentor-content__title">FunctionCoverage.php</h2>
 
 
 <h3 id="interfaces_class_traits">
-    Interfaces, Classes and Traits
+    Interfaces, Classes, Traits and Enums
     <a href="#interfaces_class_traits" class="headerlink"><i class="fas fa-link"></i></a>
 </h3>
 
@@ -101,6 +106,7 @@ <h3 id="interfaces_class_traits">
             <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Lcov-FunctionCoverage.html"><abbr title="\Lcov\FunctionCoverage">FunctionCoverage</abbr></a></dt>
         <dd>Provides the coverage data of functions.</dd>
 
+
     </dl>
 
 
@@ -124,7 +130,7 @@ <h2 class="phpdocumentor-search-results__title">Search results</h2>
 </section>
             </div>
         </div>
-        <a href="files/src-functioncoverage.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
+        <a href="files/lib-functioncoverage.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
 
     </main>
 

diff --git a/docs/files/src-functiondata.html → docs/files/lib-functiondata.html b/docs/files/src-functiondata.html → docs/files/lib-functiondata.html
@@ -2,7 +2,8 @@
 <html lang="en">
 <head>
     <meta charset="utf-8">
-    <title>LCOV Reports for PHP</title>
+            <title>LCOV Reports for PHP</title>
+
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <base href="../">
     <link rel="icon" href="images/favicon.ico"/>
@@ -54,12 +55,16 @@ <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">LCO
 <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/lcov.html">Lcov</a></h4>
+                                    <h4 class="phpdocumentor-sidebar__root-namespace">
+    <a href="namespaces/lcov.html" class="">Lcov</a>
+</h4>
 
                         </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">Application</a></h4>
+                                    <h4 class="phpdocumentor-sidebar__root-namespace">
+    <a href="packages/Application.html" class="">Application</a>
+</h4>
 
                         </section>
 
@@ -92,7 +97,7 @@ <h2 class="phpdocumentor-content__title">FunctionData.php</h2>
 
 
 <h3 id="interfaces_class_traits">
-    Interfaces, Classes and Traits
+    Interfaces, Classes, Traits and Enums
     <a href="#interfaces_class_traits" class="headerlink"><i class="fas fa-link"></i></a>
 </h3>
 
@@ -101,6 +106,7 @@ <h3 id="interfaces_class_traits">
             <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Lcov-FunctionData.html"><abbr title="\Lcov\FunctionData">FunctionData</abbr></a></dt>
         <dd>Provides details for function coverage.</dd>
 
+
     </dl>
 
 
@@ -124,7 +130,7 @@ <h2 class="phpdocumentor-search-results__title">Search results</h2>
 </section>
             </div>
         </div>
-        <a href="files/src-functiondata.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
+        <a href="files/lib-functiondata.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
 
     </main>