deavmi/birchwood
deavmi/birchwood
1
0
Fork 0
mirror of https://github.com/deavmi/birchwood synced 2024-09-20 11:43:22 +02:00
Code Issues Releases Activity

Merge branch 'master' into bugfix/improve_snoosy

Browse Source
This commit is contained in:
Tristan B. Velloza Kildaire 2023-06-25 17:37:08 +02:00
commit 466337ec75
1 changed files with 18 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
source/birchwood/client/client.d
View File

@ -211,7 +211,7 @@ public class Client : Thread
* Params: * Params:
* nickname = the nickname to request * nickname = the nickname to request
* Throws: * Throws:
* BirchwoodException on invalid nickname * `BirchwoodException` on invalid nickname
*/ */
public void nick(string nickname) public void nick(string nickname)
{ {
@ -246,7 +246,7 @@ public class Client : Thread
* Params: * Params:
* channel = the channel to join * channel = the channel to join
* Throws: * Throws:
* BirchwoodException on invalid channel name * `BirchwoodException` on invalid channel name
*/ */
public void joinChannel(string channel) public void joinChannel(string channel)
{ {
@ -277,7 +277,8 @@ public class Client : Thread
* Params: * Params:
* channels = the channels to join * channels = the channels to join
* Throws: * Throws:
* BirchwoodException on invalid channel name * `BirchwoodException` on invalid channel name or
* if the list is empty
*/ */
public void joinChannel(string[] channels) public void joinChannel(string[] channels)
{ {
@ -346,7 +347,8 @@ public class Client : Thread
* Params: * Params:
* channels = the list of channels to part from * channels = the list of channels to part from
* Throws: * Throws:
* BirchwoodException if the channels list is empty * `BirchwoodException` if the channels list is empty
* or there are illegal characters present
*/ */
public void leaveChannel(string[] channels) public void leaveChannel(string[] channels)
{ {
@ -433,7 +435,8 @@ public class Client : Thread
* message = The message to send * message = The message to send
* recipients = The receipients of the message * recipients = The receipients of the message
* Throws: * Throws:
* BirchwoodException if the recipients list is empty * `BirchwoodException` if the recipients list is empty
* or illegal characters are present
*/ */
public void directMessage(string message, string[] recipients) public void directMessage(string message, string[] recipients)
{ {
@ -506,6 +509,9 @@ public class Client : Thread
* Params: * Params:
* message = The message to send * message = The message to send
* recipients = The receipient of the message * recipients = The receipient of the message
* Throws:
* `BirchwoodException` if the receipient's nickname
* is invalid or there are illegal characters present
*/ */
public void directMessage(string message, string recipient) public void directMessage(string message, string recipient)
{ {
@ -539,7 +545,7 @@ public class Client : Thread
* message = The message to send * message = The message to send
* recipients = The receipients of the message * recipients = The receipients of the message
* Throws: * Throws:
* BirchwoodException if the channels list is empty * `BirchwoodException` if the channels list is empty
*/ */
public void channelMessage(string message, string[] channels) public void channelMessage(string message, string[] channels)
{ {
@ -612,6 +618,9 @@ public class Client : Thread
* Params: * Params:
* message = The message to send * message = The message to send
* channel = The channel to send the message to * channel = The channel to send the message to
* Throws:
* `BirchwoodException` if the message or channel name
* contains illegal characters
*/ */
public void channelMessage(string message, string channel) public void channelMessage(string message, string channel)
{ {
@ -888,11 +897,11 @@ public class Client : Thread
* Sends a message to the server by enqueuing it on * Sends a message to the server by enqueuing it on
* the client-side send queue. * the client-side send queue.
* *
* A BirchwoodException is thrown if the messages
* final length exceeds 512 bytes
*
* Params: * Params:
* message = the message to send * message = the message to send
* Throws:
* `BirchwoodException` if the message's length
* exceeds 512 bytes
*/ */
private void sendMessage(Message message) private void sendMessage(Message message)
{ {