Deploying to gh-pages from @ chillerlan/php-qrcode@d0a862c56b903b287aabb7638313227205b61b3b 🚀

files/src-qroptionstrait.html

@@ -117,6 +117,8 @@
 
             <p class="phpdocumentor-summary">Trait QROptionsTrait</p>
 
+    <section class="phpdocumentor-description"><p>Note: the docblocks in this file are optimized for readability in PhpStorm ond on readthedocs.io</p>
+</section>
 
 
     <h5 class="phpdocumentor-tag-list__heading" id="tags">

js/searchIndex.js

@@ -3338,7 +3338,7 @@ Search.appendIndex(
         },                {
             "fqsen": "\\chillerlan\\QRCode\\QROptionsTrait\u003A\u003A\u0024outputInterface",
             "name": "outputInterface",
-            "summary": "The\u0020FQCN\u0020of\u0020the\u0020custom\u0020QROutputInterface\u0020if\u0020\u0024outputType\u0020is\u0020set\u0020to\u0020QRCode\u003A\u003AOUTPUT_CUSTOM",
+            "summary": "The\u0020FQCN\u0020of\u0020the\u0020custom\u0020\u0060QROutputInterface\u0060",
             "url": "classes/chillerlan-QRCode-QROptionsTrait.html#property_outputInterface"
         },                {
             "fqsen": "\\chillerlan\\QRCode\\QROptionsTrait\u003A\u003A\u0024returnResource",
@@ -3383,12 +3383,12 @@ Search.appendIndex(
         },                {
             "fqsen": "\\chillerlan\\QRCode\\QROptionsTrait\u003A\u003A\u0024circleRadius",
             "name": "circleRadius",
-            "summary": "Specifies\u0020the\u0020radius\u0020of\u0020the\u0020modules\u0020when\u0020\u0024drawCircularModules\u0020is\u0020set\u0020to\u0020true",
+            "summary": "Specifies\u0020the\u0020radius\u0020of\u0020the\u0020modules\u0020when\u0020\u0060QROptions\u003A\u003A\u0024drawCircularModules\u0060\u0020is\u0020set\u0020to\u0020\u0060true\u0060",
             "url": "classes/chillerlan-QRCode-QROptionsTrait.html#property_circleRadius"
         },                {
             "fqsen": "\\chillerlan\\QRCode\\QROptionsTrait\u003A\u003A\u0024keepAsSquare",
             "name": "keepAsSquare",
-            "summary": "Specifies\u0020which\u0020module\u0020types\u0020to\u0020exclude\u0020when\u0020\u0024drawCircularModules\u0020is\u0020set\u0020to\u0020true",
+            "summary": "Specifies\u0020which\u0020module\u0020types\u0020to\u0020exclude\u0020when\u0020\u0060QROptions\u003A\u003A\u0024drawCircularModules\u0060\u0020is\u0020set\u0020to\u0020\u0060true\u0060",
             "url": "classes/chillerlan-QRCode-QROptionsTrait.html#property_keepAsSquare"
         },                {
             "fqsen": "\\chillerlan\\QRCode\\QROptionsTrait\u003A\u003A\u0024connectPaths",
@@ -3398,7 +3398,7 @@ Search.appendIndex(
         },                {
             "fqsen": "\\chillerlan\\QRCode\\QROptionsTrait\u003A\u003A\u0024excludeFromConnect",
             "name": "excludeFromConnect",
-            "summary": "Specify\u0020which\u0020paths\/patterns\u0020to\u0020exclude\u0020from\u0020connecting\u0020if\u0020\u0024connectPaths\u0020is\u0020set\u0020to\u0020true",
+            "summary": "Specify\u0020which\u0020paths\/patterns\u0020to\u0020exclude\u0020from\u0020connecting\u0020if\u0020\u0060QROptions\u003A\u003A\u0024connectPaths\u0060\u0020is\u0020set\u0020to\u0020\u0060true\u0060",
             "url": "classes/chillerlan-QRCode-QROptionsTrait.html#property_excludeFromConnect"
         },                {
             "fqsen": "\\chillerlan\\QRCode\\QROptionsTrait\u003A\u003A\u0024moduleValues",
@@ -3443,7 +3443,7 @@ Search.appendIndex(
         },                {
             "fqsen": "\\chillerlan\\QRCode\\QROptionsTrait\u003A\u003A\u0024transparencyColor",
             "name": "transparencyColor",
-            "summary": "Sets\u0020a\u0020transparency\u0020color\u0020for\u0020when\u0020\u007B\u0040see\u0020\\chillerlan\\QRCode\\QROptions\u003A\u003A\u0024imageTransparent\u0020QROptions\u003A\u003A\u0024imageTransparent\u007D\u0020is\u0020set\u0020to\u0020true.",
+            "summary": "Sets\u0020a\u0020transparency\u0020color\u0020for\u0020when\u0020\u0060QROptions\u003A\u003A\u0024imageTransparent\u0060\u0020is\u0020set\u0020to\u0020\u0060true\u0060.",
             "url": "classes/chillerlan-QRCode-QROptionsTrait.html#property_transparencyColor"
         },                {
             "fqsen": "\\chillerlan\\QRCode\\QROptionsTrait\u003A\u003A\u0024quality",
@@ -3478,12 +3478,12 @@ Search.appendIndex(
         },                {
             "fqsen": "\\chillerlan\\QRCode\\QROptionsTrait\u003A\u003A\u0024svgOpacity",
             "name": "svgOpacity",
-            "summary": "SVG\u0020opacity",
+            "summary": "SVG\u0020path\u0020opacity",
             "url": "classes/chillerlan-QRCode-QROptionsTrait.html#property_svgOpacity"
         },                {
             "fqsen": "\\chillerlan\\QRCode\\QROptionsTrait\u003A\u003A\u0024svgDefs",
             "name": "svgDefs",
-            "summary": "Anything\u0020in\u0020the\u0020\u003Cdefs\u003E\u0020tag",
+            "summary": "Anything\u0020in\u0020the\u0020SVG\u0020\u0060\u003Cdefs\u003E\u0060\u0020tag",
             "url": "classes/chillerlan-QRCode-QROptionsTrait.html#property_svgDefs"
         },                {
             "fqsen": "\\chillerlan\\QRCode\\QROptionsTrait\u003A\u003A\u0024svgViewBoxSize",
@@ -3493,7 +3493,7 @@ Search.appendIndex(
         },                {
             "fqsen": "\\chillerlan\\QRCode\\QROptionsTrait\u003A\u003A\u0024svgPreserveAspectRatio",
             "name": "svgPreserveAspectRatio",
-            "summary": "",
+            "summary": "Sets\u0020the\u0020value\u0020for\u0020the\u0020\u0022preserveAspectRatio\u0022\u0020on\u0020the\u0020\u0060\u003Csvg\u003E\u0060\u0020element",
             "url": "classes/chillerlan-QRCode-QROptionsTrait.html#property_svgPreserveAspectRatio"
         },                {
             "fqsen": "\\chillerlan\\QRCode\\QROptionsTrait\u003A\u003A\u0024textDark",
@@ -3513,12 +3513,12 @@ Search.appendIndex(
         },                {
             "fqsen": "\\chillerlan\\QRCode\\QROptionsTrait\u003A\u003A\u0024jsonAsBooleans",
             "name": "jsonAsBooleans",
-            "summary": "Whether\u0020to\u0020return\u0020matrix\u0020values\u0020in\u0020JSON\u0020as\u0020booleans\u0020or\u0020\u0024M_TYPE\u0020integers",
+            "summary": "Whether\u0020to\u0020return\u0020matrix\u0020values\u0020in\u0020JSON\u0020as\u0020booleans\u0020or\u0020\u0060\u0024M_TYPE\u0060\u0020integers",
             "url": "classes/chillerlan-QRCode-QROptionsTrait.html#property_jsonAsBooleans"
         },                {
             "fqsen": "\\chillerlan\\QRCode\\QROptionsTrait\u003A\u003A\u0024fpdfMeasureUnit",
             "name": "fpdfMeasureUnit",
-            "summary": "Measurement\u0020unit\u0020for\u0020FPDF\u0020output\u003A\u0020pt,\u0020mm,\u0020cm,\u0020in\u0020\u0028defaults\u0020to\u0020\u0022pt\u0022\u0029",
+            "summary": "Measurement\u0020unit\u0020for\u0020\u0060FPDF\u0060\u0020output\u003A\u0020pt,\u0020mm,\u0020cm,\u0020in\u0020\u0028defaults\u0020to\u0020\u0022pt\u0022\u0029",
             "url": "classes/chillerlan-QRCode-QROptionsTrait.html#property_fpdfMeasureUnit"
         },                {
             "fqsen": "\\chillerlan\\QRCode\\QROptionsTrait\u003A\u003A\u0024readerUseImagickIfAvailable",

reports/deprecated.html

@@ -319,97 +319,97 @@
                         <th class="phpdocumentor-heading">Reason</th>
                     </tr>
                                                                         <tr>
-                                <td class="phpdocumentor-cell">541</td>
+                                <td class="phpdocumentor-cell">607</td>
                                 <td class="phpdocumentor-cell"><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_imageBase64"><abbr title="\chillerlan\QRCode\QROptionsTrait::set_imageBase64()">QROptionsTrait::set_imageBase64()</abbr></a></td>
                                 <td class="phpdocumentor-cell"><p>use QROptions::$outputBase64 instead</p>
 </td>
                             </tr>
                                                                                                 <tr>
-                                <td class="phpdocumentor-cell">552</td>
+                                <td class="phpdocumentor-cell">618</td>
                                 <td class="phpdocumentor-cell"><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_get_imageBase64"><abbr title="\chillerlan\QRCode\QROptionsTrait::get_imageBase64()">QROptionsTrait::get_imageBase64()</abbr></a></td>
                                 <td class="phpdocumentor-cell"><p>use QROptions::$outputBase64 instead</p>
 </td>
                             </tr>
                                                                                                 <tr>
-                                <td class="phpdocumentor-cell">567</td>
+                                <td class="phpdocumentor-cell">633</td>
                                 <td class="phpdocumentor-cell"><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_jpegQuality"><abbr title="\chillerlan\QRCode\QROptionsTrait::set_jpegQuality()">QROptionsTrait::set_jpegQuality()</abbr></a></td>
                                 <td class="phpdocumentor-cell"><p>use QROptions::$quality instead</p>
 </td>
                             </tr>
                                                                                                 <tr>
-                                <td class="phpdocumentor-cell">576</td>
+                                <td class="phpdocumentor-cell">642</td>
                                 <td class="phpdocumentor-cell"><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_get_jpegQuality"><abbr title="\chillerlan\QRCode\QROptionsTrait::get_jpegQuality()">QROptionsTrait::get_jpegQuality()</abbr></a></td>
                                 <td class="phpdocumentor-cell"><p>use QROptions::$quality instead</p>
 </td>
                             </tr>
                                                                                                 <tr>
-                                <td class="phpdocumentor-cell">591</td>
+                                <td class="phpdocumentor-cell">657</td>
                                 <td class="phpdocumentor-cell"><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_pngCompression"><abbr title="\chillerlan\QRCode\QROptionsTrait::set_pngCompression()">QROptionsTrait::set_pngCompression()</abbr></a></td>
                                 <td class="phpdocumentor-cell"><p>use QROptions::$quality instead</p>
 </td>
                             </tr>
                                                                                                 <tr>
-                                <td class="phpdocumentor-cell">600</td>
+                                <td class="phpdocumentor-cell">666</td>
                                 <td class="phpdocumentor-cell"><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_get_pngCompression"><abbr title="\chillerlan\QRCode\QROptionsTrait::get_pngCompression()">QROptionsTrait::get_pngCompression()</abbr></a></td>
                                 <td class="phpdocumentor-cell"><p>use QROptions::$quality instead</p>
 </td>
                             </tr>
                                                                                                 <tr>
-                                <td class="phpdocumentor-cell">615</td>
+                                <td class="phpdocumentor-cell">681</td>
                                 <td class="phpdocumentor-cell"><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_imageTransparencyBG"><abbr title="\chillerlan\QRCode\QROptionsTrait::set_imageTransparencyBG()">QROptionsTrait::set_imageTransparencyBG()</abbr></a></td>
                                 <td class="phpdocumentor-cell"><p>use QROptions::$transparencyColor instead</p>
 </td>
                             </tr>
                                                                                                 <tr>
-                                <td class="phpdocumentor-cell">624</td>
+                                <td class="phpdocumentor-cell">690</td>
                                 <td class="phpdocumentor-cell"><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_get_imageTransparencyBG"><abbr title="\chillerlan\QRCode\QROptionsTrait::get_imageTransparencyBG()">QROptionsTrait::get_imageTransparencyBG()</abbr></a></td>
                                 <td class="phpdocumentor-cell"><p>use QROptions::$transparencyColor instead</p>
 </td>
                             </tr>
                                                                                                 <tr>
-                                <td class="phpdocumentor-cell">639</td>
+                                <td class="phpdocumentor-cell">705</td>
                                 <td class="phpdocumentor-cell"><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_set_imagickBG"><abbr title="\chillerlan\QRCode\QROptionsTrait::set_imagickBG()">QROptionsTrait::set_imagickBG()</abbr></a></td>
                                 <td class="phpdocumentor-cell"><p>use QROptions::$bgColor instead</p>
 </td>
                             </tr>
                                                                                                 <tr>
-                                <td class="phpdocumentor-cell">648</td>
+                                <td class="phpdocumentor-cell">714</td>
                                 <td class="phpdocumentor-cell"><a href="classes/chillerlan-QRCode-QROptionsTrait.html#method_get_imagickBG"><abbr title="\chillerlan\QRCode\QROptionsTrait::get_imagickBG()">QROptionsTrait::get_imagickBG()</abbr></a></td>
                                 <td class="phpdocumentor-cell"><p>use QROptions::$bgColor instead</p>
 </td>
                             </tr>
                                                                                                 <tr>
-                                <td class="phpdocumentor-cell">350</td>
+                                <td class="phpdocumentor-cell">414</td>
                                 <td class="phpdocumentor-cell"><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_svgViewBoxSize"><abbr title="\chillerlan\QRCode\QROptionsTrait::$svgViewBoxSize">QROptionsTrait::$svgViewBoxSize</abbr></a></td>
                                 <td class="phpdocumentor-cell"><p>use QRMarkupSVG::getViewBox() instead</p>
 </td>
                             </tr>
                                                                                                 <tr>
-                                <td class="phpdocumentor-cell">532</td>
+                                <td class="phpdocumentor-cell">598</td>
                                 <td class="phpdocumentor-cell"><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imageBase64"><abbr title="\chillerlan\QRCode\QROptionsTrait::$imageBase64">QROptionsTrait::$imageBase64</abbr></a></td>
                                 <td class="phpdocumentor-cell"><p>use QROptions::$outputBase64 instead</p>
 </td>
                             </tr>
                                                                                                 <tr>
-                                <td class="phpdocumentor-cell">560</td>
+                                <td class="phpdocumentor-cell">626</td>
                                 <td class="phpdocumentor-cell"><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_jpegQuality"><abbr title="\chillerlan\QRCode\QROptionsTrait::$jpegQuality">QROptionsTrait::$jpegQuality</abbr></a></td>
                                 <td class="phpdocumentor-cell"><p>use QROptions::$quality instead</p>
 </td>
                             </tr>
                                                                                                 <tr>
-                                <td class="phpdocumentor-cell">584</td>
+                                <td class="phpdocumentor-cell">650</td>
                                 <td class="phpdocumentor-cell"><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_pngCompression"><abbr title="\chillerlan\QRCode\QROptionsTrait::$pngCompression">QROptionsTrait::$pngCompression</abbr></a></td>
                                 <td class="phpdocumentor-cell"><p>use QROptions::$quality instead</p>
 </td>
                             </tr>
                                                                                                 <tr>
-                                <td class="phpdocumentor-cell">608</td>
+                                <td class="phpdocumentor-cell">674</td>
                                 <td class="phpdocumentor-cell"><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imageTransparencyBG"><abbr title="\chillerlan\QRCode\QROptionsTrait::$imageTransparencyBG">QROptionsTrait::$imageTransparencyBG</abbr></a></td>
                                 <td class="phpdocumentor-cell"><p>use QROptions::$transparencyColor instead</p>
 </td>
                             </tr>
                                                                                                 <tr>
-                                <td class="phpdocumentor-cell">632</td>
+                                <td class="phpdocumentor-cell">698</td>
                                 <td class="phpdocumentor-cell"><a href="classes/chillerlan-QRCode-QROptionsTrait.html#property_imagickBG"><abbr title="\chillerlan\QRCode\QROptionsTrait::$imagickBG">QROptionsTrait::$imagickBG</abbr></a></td>
                                 <td class="phpdocumentor-cell"><p>use QROptions::$bgColor instead</p>
 </td>