Skip to content

Commit 6cb43af

Browse files
authored
Merge pull request #188 from jacobhylen/jacobhylen/change-links
Update api.md
2 parents 9e63d97 + 2998f47 commit 6cb43af

File tree

1 file changed

+36
-36
lines changed

1 file changed

+36
-36
lines changed

docs/api.md

Lines changed: 36 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -872,7 +872,7 @@ void loop()
872872
}
873873
```
874874

875-
### `begin()`
875+
### `server.begin()`
876876

877877
#### Description
878878

@@ -931,7 +931,7 @@ void loop()
931931
}
932932
```
933933

934-
### `accept()`
934+
### `server.accept()`
935935

936936
#### Description
937937

@@ -1015,7 +1015,7 @@ void loop() {
10151015
}
10161016
```
10171017

1018-
### `available()`
1018+
### `server.available()`
10191019

10201020
#### Description
10211021

@@ -1130,7 +1130,7 @@ void loop() {
11301130
}
11311131
```
11321132

1133-
### `write()`
1133+
### `server.write()`
11341134

11351135
#### Description
11361136

@@ -1197,7 +1197,7 @@ void loop()
11971197
}
11981198
```
11991199

1200-
### `print()`
1200+
### `server.print()`
12011201

12021202
#### Description
12031203

@@ -1222,7 +1222,7 @@ byte
12221222
print() will return the number of bytes written, though reading that number is optional
12231223

12241224

1225-
### `println()`
1225+
### `server.println()`
12261226

12271227
#### Description
12281228

@@ -1390,7 +1390,7 @@ void loop()
13901390
13911391
```
13921392

1393-
### `connected()`
1393+
### `client.connected()`
13941394

13951395
#### Description
13961396

@@ -1457,7 +1457,7 @@ void loop()
14571457
}
14581458
```
14591459

1460-
### `connect()`
1460+
### `client.connect()`
14611461

14621462
#### Description
14631463

@@ -1535,7 +1535,7 @@ void loop()
15351535
}
15361536
```
15371537

1538-
### `localPort()`
1538+
### `client.localPort()`
15391539

15401540
#### Description
15411541

@@ -1592,7 +1592,7 @@ void loop() {
15921592
}
15931593
```
15941594

1595-
### `remoteIP()`
1595+
### `client.remoteIP()`
15961596

15971597
#### Description
15981598

@@ -1649,7 +1649,7 @@ void loop() {
16491649
}
16501650
```
16511651

1652-
### `remotePort()`
1652+
### `client.remotePort()`
16531653

16541654
#### Description
16551655

@@ -1706,7 +1706,7 @@ void loop() {
17061706
}
17071707
```
17081708

1709-
### `setConnectionTimeout()`
1709+
### `client.setConnectionTimeout()`
17101710

17111711
#### Description
17121712

@@ -1761,7 +1761,7 @@ void loop() {
17611761
}
17621762
```
17631763

1764-
### `write()`
1764+
### `client.write()`
17651765

17661766
#### Description
17671767

@@ -1809,7 +1809,7 @@ BASE (optional): the base in which to print numbers: DEC for decimal (base 10),
18091809
#### Returns
18101810
byte: returns the number of bytes written, though reading that number is optional
18111811

1812-
### `println()`
1812+
### `client.println()`
18131813

18141814
#### Description
18151815

@@ -1834,7 +1834,7 @@ BASE (optional): the base in which to print numbers: DEC for decimal (base 10),
18341834
byte: return the number of bytes written, though reading that number is optional
18351835

18361836

1837-
### `available()`
1837+
### `client.available()`
18381838

18391839
#### Description
18401840

@@ -1903,7 +1903,7 @@ void loop()
19031903
}
19041904
```
19051905

1906-
### `read()`
1906+
### `client.read()`
19071907

19081908
#### Description
19091909

@@ -1925,7 +1925,7 @@ none
19251925
#### Returns
19261926
The next byte (or character), or -1 if none is available.
19271927

1928-
flush()
1928+
### `client.flush()`
19291929
Waits until all outgoing characters in buffer have been sent.
19301930

19311931
flush() inherits from the Stream utility class.
@@ -1944,7 +1944,7 @@ none
19441944
#### Returns
19451945
none
19461946

1947-
### `stop()`
1947+
### `client.stop()`
19481948

19491949
#### Description
19501950

@@ -1964,9 +1964,9 @@ none
19641964
#### Returns
19651965
none
19661966

1967-
# EthernetUDP Class
1967+
## EthernetUDP Class
19681968

1969-
### `UDP.begin()`
1969+
### `EthernetUDP.begin()`
19701970

19711971
#### Description
19721972
Initializes the ethernet UDP library and network settings.
@@ -2038,7 +2038,7 @@ void loop() {
20382038
20392039
```
20402040

2041-
### `UDP.read()`
2041+
### `EthernetUDP.read()`
20422042

20432043
#### Description
20442044
Reads UDP data from the specified buffer. If no arguments are given, it will return the next character in the buffer.
@@ -2049,8 +2049,8 @@ This function can only be successfully called after UDP.parsePacket().
20492049
#### Syntax
20502050

20512051
```
2052-
UDP.read();
2053-
UDP.read(packetBuffer, MaxSize);
2052+
EthernetUDP.read();
2053+
EthernetUDP.read(packetBuffer, MaxSize);
20542054
```
20552055

20562056
#### Parameters
@@ -2115,7 +2115,7 @@ void loop() {
21152115
}
21162116
```
21172117

2118-
### `UDP.write()`
2118+
### `EthernetUDP.write()`
21192119

21202120
#### Description
21212121
Writes UDP data to the remote connection. Must be wrapped between beginPacket() and endPacket(). beginPacket() initializes the packet of data, it is not sent until endPacket() is called.
@@ -2124,8 +2124,8 @@ Writes UDP data to the remote connection. Must be wrapped between beginPacket()
21242124
#### Syntax
21252125

21262126
```
2127-
UDP.write(message);
2128-
UDP.write(buffer, size);
2127+
EthernetUDP.write(message);
2128+
EthernetUDP.write(buffer, size);
21292129
21302130
```
21312131

@@ -2199,7 +2199,7 @@ void loop() {
21992199
22002200
```
22012201

2202-
### `UDP.beginPacket()`
2202+
### `EthernetUDP.beginPacket()`
22032203

22042204
#### Description
22052205
Starts a connection to write UDP data to the remote connection
@@ -2208,7 +2208,7 @@ Starts a connection to write UDP data to the remote connection
22082208
#### Syntax
22092209

22102210
```
2211-
UDP.beginPacket(remoteIP, remotePort);
2211+
EthernetUDP.beginPacket(remoteIP, remotePort);
22122212
```
22132213

22142214
#### Parameters
@@ -2251,7 +2251,7 @@ void loop() {
22512251
}
22522252
```
22532253

2254-
### `UDP.endPacket()`
2254+
### `EthernetUDP.endPacket()`
22552255

22562256
#### Description
22572257
Called after writing UDP data to the remote connection.
@@ -2260,7 +2260,7 @@ Called after writing UDP data to the remote connection.
22602260
#### Syntax
22612261

22622262
```
2263-
UDP.endPacket();
2263+
EthernetUDP.endPacket();
22642264
```
22652265

22662266
#### Parameters
@@ -2303,7 +2303,7 @@ void loop() {
23032303
}
23042304
```
23052305

2306-
### `UDP.parsePacket()`
2306+
### `EthernetUDP.parsePacket()`
23072307

23082308
#### Description
23092309
Checks for the presence of a UDP packet, and reports the size. parsePacket() must be called before reading the buffer with UDP.read().
@@ -2312,7 +2312,7 @@ Checks for the presence of a UDP packet, and reports the size. parsePacket() mus
23122312
#### Syntax
23132313

23142314
```
2315-
UDP.parsePacket();
2315+
EthernetUDP.parsePacket();
23162316
```
23172317

23182318
#### Parameters
@@ -2361,7 +2361,7 @@ void loop() {
23612361
}
23622362
```
23632363

2364-
### `UDP.available()`
2364+
### `EthernetUDP.available()`
23652365

23662366
#### Description
23672367

@@ -2375,7 +2375,7 @@ available() inherits from the Stream utility class.
23752375
#### Syntax
23762376

23772377
```
2378-
UDP.available()
2378+
EthernetUDP.available()
23792379
23802380
```
23812381

@@ -2442,7 +2442,7 @@ void loop() {
24422442

24432443
## UDP class
24442444

2445-
### `EthernetUDP.stop()`
2445+
### `UDP.stop()`
24462446

24472447
#### Description
24482448

@@ -2452,7 +2452,7 @@ Disconnect from the server. Release any resource being used during the UDP sessi
24522452
#### Syntax
24532453

24542454
```
2455-
EthernetUDP.stop()
2455+
UDP.stop()
24562456
24572457
```
24582458

0 commit comments

Comments
 (0)