- Added documentation for `decodeMessage(byte[])`
- Added documentation for `encodeMessage(byte[])`
This commit is contained in:
Tristan B. Velloza Kildaire 2023-03-25 21:50:33 +02:00
parent f8f0803c98
commit bcd29bac3d
1 changed files with 9 additions and 6 deletions

View File

@ -1,10 +1,12 @@
module bformat.marshall;
/**
*
* Decodes the provided bformat message into the
* message itself
*
* Params:
* bformatBytes =
* Returns:
* bformatBytes = the bformat payload the decode
* Returns: the decoded message
*/
public byte[] decodeMessage(byte[] bformatBytes)
{
@ -45,10 +47,11 @@ public byte[] decodeMessage(byte[] bformatBytes)
}
/**
*
* Encodes the provided message into the bformat format
*
* Params:
* message =
* Returns:
* message = the buffer containing bytes to encode
* Returns: the encoded payload
*/
public byte[] encodeBformat(byte[] message)
{