mirror of
https://github.com/chillerlan/php-qrcode.git
synced 2026-08-24 20:27:56 +00:00
🚿 removed html tags and javadoc remnants from docblocks
This commit is contained in:
+11
-11
@@ -38,7 +38,7 @@ final class BitMatrix{
|
||||
}
|
||||
|
||||
/**
|
||||
* <p>Sets the given bit to true.</p>
|
||||
* Sets the given bit to true.
|
||||
*
|
||||
* @param int $x ; The horizontal component (i.e. which column)
|
||||
* @param int $y ; The vertical component (i.e. which row)
|
||||
@@ -53,7 +53,7 @@ final class BitMatrix{
|
||||
}
|
||||
|
||||
/**
|
||||
* <p>Flips the given bit. 1 << (0xf9 & 0x1f)</p>
|
||||
* Flips the given bit. 1 << (0xf9 & 0x1f)
|
||||
*
|
||||
* @param int $x ; The horizontal component (i.e. which column)
|
||||
* @param int $y ; The vertical component (i.e. which row)
|
||||
@@ -67,7 +67,7 @@ final class BitMatrix{
|
||||
}
|
||||
|
||||
/**
|
||||
* <p>Sets a square region of the bit matrix to true.</p>
|
||||
* Sets a square region of the bit matrix to true.
|
||||
*
|
||||
* @param int $left ; The horizontal position to begin at (inclusive)
|
||||
* @param int $top ; The vertical position to begin at (inclusive)
|
||||
@@ -127,7 +127,7 @@ final class BitMatrix{
|
||||
}
|
||||
|
||||
/**
|
||||
* <p>Gets the requested bit, where true means black.</p>
|
||||
* Gets the requested bit, where true means black.
|
||||
*
|
||||
* @param int $x The horizontal component (i.e. which column)
|
||||
* @param int $y The vertical component (i.e. which row)
|
||||
@@ -224,9 +224,9 @@ final class BitMatrix{
|
||||
|
||||
/**
|
||||
* Prepare the parser for a mirrored operation.
|
||||
* This flag has effect only on the {@link #readFormatInformation()} and the
|
||||
* {@link #readVersion()}. Before proceeding with {@link #readCodewords()} the
|
||||
* {@link #mirror()} method should be called.
|
||||
* This flag has effect only on the #readFormatInformation() and the
|
||||
* #readVersion(). Before proceeding with #readCodewords() the
|
||||
* #mirror() method should be called.
|
||||
*
|
||||
* @param bool $mirror Whether to read version and format information mirrored.
|
||||
*/
|
||||
@@ -251,9 +251,9 @@ final class BitMatrix{
|
||||
}
|
||||
|
||||
/**
|
||||
* <p>Reads the bits in the {@link BitMatrix} representing the finder pattern in the
|
||||
* Reads the bits in the BitMatrix representing the finder pattern in the
|
||||
* correct order in order to reconstruct the codewords bytes contained within the
|
||||
* QR Code.</p>
|
||||
* QR Code.
|
||||
*
|
||||
* @return array bytes encoded within the QR Code
|
||||
* @throws \RuntimeException if the exact number of bytes expected is not read
|
||||
@@ -315,7 +315,7 @@ final class BitMatrix{
|
||||
}
|
||||
|
||||
/**
|
||||
* <p>Reads format information from one of its two locations within the QR Code.</p>
|
||||
* Reads format information from one of its two locations within the QR Code.
|
||||
*
|
||||
* @return \chillerlan\QRCode\Common\FormatInformation encapsulating the QR Code's format info
|
||||
* @throws \RuntimeException if both format information locations cannot be parsed as
|
||||
@@ -422,7 +422,7 @@ final class BitMatrix{
|
||||
}
|
||||
|
||||
/**
|
||||
* <p>Reads version information from one of its two locations within the QR Code.</p>
|
||||
* Reads version information from one of its two locations within the QR Code.
|
||||
*
|
||||
* @return \chillerlan\QRCode\Common\Version encapsulating the QR Code's version
|
||||
* @throws \RuntimeException if both version information locations cannot be parsed as
|
||||
|
||||
@@ -18,8 +18,8 @@ use chillerlan\QRCode\Detector\Detector;
|
||||
use function count, array_fill, mb_convert_encoding, mb_detect_encoding;
|
||||
|
||||
/**
|
||||
* <p>The main class which implements QR Code decoding -- as opposed to locating and extracting
|
||||
* the QR Code from an image.</p>
|
||||
* The main class which implements QR Code decoding -- as opposed to locating and extracting
|
||||
* the QR Code from an image.
|
||||
*
|
||||
* @author Sean Owen
|
||||
*/
|
||||
@@ -28,8 +28,8 @@ final class Decoder{
|
||||
# private const GB2312_SUBSET = 1;
|
||||
|
||||
/**
|
||||
* <p>Decodes a QR Code represented as a {@link \chillerlan\QRCode\Decoder\BitMatrix}.
|
||||
* A 1 or "true" is taken to mean a black module.</p>
|
||||
* Decodes a QR Code represented as a BitMatrix.
|
||||
* A 1 or "true" is taken to mean a black module.
|
||||
*
|
||||
* @param \chillerlan\QRCode\Decoder\LuminanceSourceInterface $source
|
||||
*
|
||||
@@ -105,9 +105,9 @@ final class Decoder{
|
||||
}
|
||||
|
||||
/**
|
||||
* <p>When QR Codes use multiple data blocks, they are actually interleaved.
|
||||
* When QR Codes use multiple data blocks, they are actually interleaved.
|
||||
* That is, the first byte of data block 1 to n is written, then the second bytes, and so on. This
|
||||
* method will separate the data into original blocks.</p>
|
||||
* method will separate the data into original blocks.
|
||||
*
|
||||
* @param array $rawCodewords bytes as read directly from the QR Code
|
||||
* @param \chillerlan\QRCode\Common\Version $version version of the QR Code
|
||||
@@ -187,8 +187,8 @@ final class Decoder{
|
||||
}
|
||||
|
||||
/**
|
||||
* <p>Given data and error-correction codewords received, possibly corrupted by errors, attempts to
|
||||
* correct the errors in-place using Reed-Solomon error correction.</p>
|
||||
* Given data and error-correction codewords received, possibly corrupted by errors, attempts to
|
||||
* correct the errors in-place using Reed-Solomon error correction.
|
||||
*/
|
||||
private function correctErrors(array $codewordBytes, int $numDataCodewords):array{
|
||||
// First read into an array of ints
|
||||
|
||||
@@ -16,7 +16,7 @@ interface LuminanceSourceInterface{
|
||||
|
||||
/**
|
||||
* Fetches luminance data for the underlying bitmap. Values should be fetched using:
|
||||
* {@code int luminance = array[y * width + x] & 0xff}
|
||||
* `int luminance = array[y * width + x] & 0xff`
|
||||
*
|
||||
* @return array A row-major 2D array of luminance values. Do not use result.length as it may be
|
||||
* larger than width * height bytes on some platforms. Do not modify the contents
|
||||
|
||||
Reference in New Issue
Block a user