1
0
mirror of https://github.com/deavmi/birchwood synced 2024-09-20 13:43:19 +02:00
- Documented `getKVPairs()`, `getTrailing()` and `getPairs()`
This commit is contained in:
Tristan B. Velloza Kildaire 2023-03-17 09:20:54 +02:00
parent 0e9c042d21
commit d982205b1b

View File

@ -279,17 +279,35 @@ public final class Message
return params; return params;
} }
/**
* Retrieves the trailing text in the paramaters
* (if any)
*
* Returns: the trailing text
*/
public string getTrailing() public string getTrailing()
{ {
return ppTrailing; return ppTrailing;
} }
/**
* Returns the parameters excluding the trailing text
* which are seperated by spaces but only those
* which are key-value pairs
*
* Returns: the key-value pair parameters
*/
public string[string] getKVPairs() public string[string] getKVPairs()
{ {
return ppKVPairs; return ppKVPairs;
} }
/**
* Returns the parameters excluding the trailing text
* which are seperated by spaces
*
* Returns: the parameters
*/
public string[] getPairs() public string[] getPairs()
{ {
return ppPairs; return ppPairs;