smiley 2 лет назад
Родитель
Сommit
91975f191f
3 измененных файлов с 13 добавлено и 9 удалено
  1. 4 2
      docs/API-QROptions.md
  2. 4 4
      docs/API-QROutputInterface.md
  3. 5 3
      docs/Appendix-URI-Content.md

+ 4 - 2
docs/API-QROptions.md

@@ -70,8 +70,10 @@ Inherited from [`SettingsContainerAbstract`](https://github.com/chillerlan/php-s
 | `$svgPreserveAspectRatio`      | `string`       | `'xMidYMid'`                    | *                                       | See [preserveAspectRatio on MDN](https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/preserveAspectRatio)                                                                        |
 | `$svgWidth`                    | `string\|null` | `null`                          | *                                       | Optional "width" attribute with the specified value (note that the value is not checked!)                                                                                               |
 | `$svgHeight`                   | `string\|null` | `null`                          | *                                       | Optional "height" attribute with the specified value (note that the value is not checked!)                                                                                              |
-| `$textDark`                    | `string`       | `'🔴'`                          | *                                       | String substitute for dark                                                                                                                                                              |
-| `$textLight`                   | `string`       | `'⭕'`                           | *                                       | String substitute for light                                                                                                                                                             |
+| `$textDark`                    | `string`       | `'██'`                          | *                                       | String substitute for dark                                                                                                                                                              |
+| `$textLight`                   | `string`       | `'░░'`                          | *                                       | String substitute for light                                                                                                                                                             |
+| `$textLineStart`               | `string`       | `''`                            | *                                       | An optional line prefix, e.g. empty space to align the QR Code in a console                                                                                                             |
+| `$jsonAsBooleans`              | `bool`         | `false`                         | *                                       | Whether to return matrix values in JSON as booleans or $M_TYPE integers                                                                                                                 |
 | `$fpdfMeasureUnit`             | `string`       | `'pt'`                          | *                                       | Measurement unit for FPDF output: pt, mm, cm, in                                                                                                                                        |
 | `$readerUseImagickIfAvailable` | `bool`         | `false`                         | *                                       | Use Imagick (if available) when reading QR Codes                                                                                                                                        |
 | `$readerGrayscale`             | `bool`         | `false`                         | *                                       | Grayscale the image before reading                                                                                                                                                      |

+ 4 - 4
docs/API-QROutputInterface.md

@@ -5,10 +5,10 @@ The full phpDocumentor API documentation can be found at [chillerlan.github.io/p
 
 ##  Methods
 <!-- using non-breaking spaces chr(255) in the longest method signature to force the silly table to stretch -->
-| method                                | return  | description                                                         |
-|---------------------------------------|---------|---------------------------------------------------------------------|
-| (static) `moduleValueIsValid($value)` | `bool`  | Determines whether the given value is valid                         |
-| `dump(string $file = null)`           | `mixed` | Generates the output, optionally dumps it to a file, and returns it |
+| method                                | return  | description                                                          |
+|---------------------------------------|---------|----------------------------------------------------------------------|
+| (static) `moduleValueIsValid($value)` | `bool`  | Checks whether the given value is valid for the current output class |
+| `dump(string $file = null)`           | `mixed` | Generates the output, optionally dumps it to a file, and returns it  |
 
 
 ##  Constants

+ 5 - 3
docs/Appendix-URI-Content.md

@@ -20,8 +20,8 @@ https://www.youtube.com/watch?v=dQw4w9WgXcQ
 
 **See also:**
 
-  - [What is a URL? (Mozilla MDN)](https://developer.mozilla.org/en-US/docs/Learn/Common_questions/Web_mechanics/What_is_a_URL)
-  - [URL (Wikipedia)](https://en.wikipedia.org/wiki/URL)
+- [What is a URL? (Mozilla MDN)](https://developer.mozilla.org/en-US/docs/Learn/Common_questions/Web_mechanics/What_is_a_URL)
+- [URL (Wikipedia)](https://en.wikipedia.org/wiki/URL)
 
 
 ## E-Mail `mailto`
@@ -84,7 +84,7 @@ geo:<latitude>,<longitude>[,<altitude>;crs=<crs>;u=<num>]
 ```
 
 The default coordinate system is WGS-84, for which latitude and longitude should be supplied as decimal degrees, the optional altitude in meters.
-Te parameter `u` can be used to specify an *uncertainty* value (in meters), a different *coordinate reference system* may be supplied with `crs`.
+The parameter `u` can be used to specify an *uncertainty* value (in meters), a different *coordinate reference system* may be supplied with `crs`.
 
 Some applications support an additional query string with values of `z` for *zoom* level and `q` for a local search *query* (URL-encoded):
 ```
@@ -243,6 +243,8 @@ END:VEVENT
 END:VCALENDAR
 ```
 
+**See also:**
+
 - [RFC 5545 - Internet Calendaring and Scheduling Core Object Specification (iCalendar)](https://datatracker.ietf.org/doc/html/rfc5545)
 - [iCalendar (Wikipedia)](https://en.wikipedia.org/wiki/ICalendar)
 - [vobject library for PHP (GitHub)](https://github.com/sabre-io/vobject)