Index: DialityCoreCanProtocol.py =================================================================== diff -u -raad702e781289fac6ea772855905467b66ce35b3 -r77d8532cf4fb0bb8bffbd816e170264e68995681 --- DialityCoreCanProtocol.py (.../DialityCoreCanProtocol.py) (revision aad702e781289fac6ea772855905467b66ce35b3) +++ DialityCoreCanProtocol.py (.../DialityCoreCanProtocol.py) (revision 77d8532cf4fb0bb8bffbd816e170264e68995681) @@ -65,8 +65,8 @@ def buildBasicMessage(channel_id=0, message=None): """ build a message using channel_id and dialin message - /return channel_id: integer with channel id - /return message: array of int with message + \param channel_id: integer with channel id + \param message: array of int with message \return: dictionary with channel_id and message keys """ if message is None: @@ -78,9 +78,9 @@ """ buildPacket builds a Diality Packet - /return channel_id: is an integer with channel ID - /return message_id: is an integer indicating request ID - /return payload: list with payload. It does not include length + \param channel_id: is an integer with channel ID + \param message_id: is an integer indicating request ID + \param payload: list with payload. It does not include length \return dictionary with channel_id and 8-byte padded message """ @@ -124,7 +124,7 @@ def crc8(message_list): """ returns the calculated crc from a message list - /return message_list: is a list of integer numbers containing the message + \param message_list: is a list of integer numbers containing the message \return: integer containing a unsigned byte """ crc = 0 @@ -138,7 +138,7 @@ def __padMessageWithZeros(message): """ returns a packet padded with zeros that guarantees that the packet is a multiple of 8 bytes. - /return message: packet that may or may not be multiple of 8 bytes + \param message: packet that may or may not be multiple of 8 bytes \return: packet that is 8-byte multiple