Skip to content

Commit 4fe9da5

Browse files
committed
Merge remote-tracking branch 'origin/master'
2 parents b4eac73 + 98017df commit 4fe9da5

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

js/README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
QR Code Generator
22
===
33

4-
##Getting Started
4+
## Getting Started
55

66
1. Include qrcode.js in your html.
77
2. Prepare a place holder.
@@ -21,19 +21,19 @@ qr.addData('Hi!');
2121
qr.make();
2222
document.getElementById('placeHolder').innerHTML = qr.createImgTag();
2323
```
24-
##API Documentation
24+
## API Documentation
2525

26-
###QRCodeFactory
26+
### QRCodeFactory
2727

28-
####qrcode(typeNumber, errorCorrectionLevel) => <code>QRCode</code>
28+
#### qrcode(typeNumber, errorCorrectionLevel) => <code>QRCode</code>
2929
Create a QRCode Object.
3030

3131
| Param | Type | Description |
3232
| ---------------------| ------------------- | ------------------------------------------- |
3333
| typeNumber | <code>number</code> | Type number (1 ~ 40) |
3434
| errorCorrectionLevel | <code>string</code> | Error correction level ('L', 'M', 'Q', 'H') |
3535

36-
####qrcode.stringToBytes(s) : <code>number[]</code>
36+
#### qrcode.stringToBytes(s) : <code>number[]</code>
3737
Encodes a string into an array of number(byte) using any charset.
3838
This function is used by internal.
3939
Overwrite this function to encode using a multibyte charset.
@@ -42,24 +42,24 @@ Overwrite this function to encode using a multibyte charset.
4242
| -------| ------------------- | ---------------- |
4343
| s | <code>string</code> | string to encode |
4444

45-
###QRCode
45+
### QRCode
4646

47-
####addData(data, mode) => <code>void</code>
47+
#### addData(data, mode) => <code>void</code>
4848
Add a data to encode.
4949

5050
| Param | Type | Description |
5151
| -------| ------------------- | ---------------------------------------------------------- |
5252
| data | <code>string</code> | string to encode |
5353
| mode | <code>string</code> | Mode ('Numeric', 'Alphanumeric', 'Byte'(default), 'Kanji') |
5454

55-
####make() => <code>void</code>
55+
#### make() => <code>void</code>
5656
Make a QR Code.
5757

58-
####getModuleCount() => <code>number</code>
58+
#### getModuleCount() => <code>number</code>
5959
The number of modules(cells) for each orientation.
6060
_[Note] call make() before this function._
6161

62-
####isDark(row, col) => <code>boolean</code>
62+
#### isDark(row, col) => <code>boolean</code>
6363
The module at row and col is dark or not.
6464
_[Note] call make() before this function._
6565

@@ -68,9 +68,9 @@ _[Note] call make() before this function._
6868
| row | <code>number</code> | 0 ~ moduleCount - 1 |
6969
| col | <code>number</code> | 0 ~ moduleCount - 1 |
7070

71-
####createImgTag(cellSize, margin) => <code>string</code>
72-
####createSvgTag(cellSize, margin) => <code>string</code>
73-
####createTableTag(cellSize, margin) => <code>string</code>
71+
#### createImgTag(cellSize, margin) => <code>string</code>
72+
#### createSvgTag(cellSize, margin) => <code>string</code>
73+
#### createTableTag(cellSize, margin) => <code>string</code>
7474
Helper functions for HTML.
7575
_[Note] call make() before these functions._
7676

0 commit comments

Comments
 (0)