Updated and synchronized documentation comments for QrCode's instance methods, in all languages.

This commit is contained in:
Project Nayuki
2018-10-06 03:26:54 +00:00
parent 76f97dd0b8
commit f011e52770
7 changed files with 39 additions and 37 deletions
+4 -4
View File
@@ -163,16 +163,16 @@ class QrCode final {
/*
* Returns the color of the module (pixel) at the given coordinates, which is either
* false for white or true for black. The top left corner has the coordinates (x=0, y=0).
* Returns the color of the module (pixel) at the given coordinates, which is false
* for white or true for black. The top left corner has the coordinates (x=0, y=0).
* If the given coordinates are out of bounds, then false (white) is returned.
*/
public: bool getModule(int x, int y) const;
/*
* Returns a string of SVG XML code representing an image of this QR Code with the given
* number of border modules. Note that Unix newlines (\n) are always used, regardless of the platform.
* Returns a string of SVG code for an image depicting this QR Code, with the given number
* of border modules. The string always uses Unix newlines (\n), regardless of the platform.
*/
public: std::string toSvgString(int border) const;