From 1dab3f4bc7f98ad8976f1086975d4316ffed7189 Mon Sep 17 00:00:00 2001 From: Pascal Serrarens Date: Thu, 1 May 2025 14:39:13 +0200 Subject: [PATCH] Added participants documentation --- RoboidControl/Participant.py | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/RoboidControl/Participant.py b/RoboidControl/Participant.py index 69cec37..c30b815 100644 --- a/RoboidControl/Participant.py +++ b/RoboidControl/Participant.py @@ -69,6 +69,12 @@ class Participant: @staticmethod def GetParticipant(arg1: Union[str, int], port: Optional[int] = None) -> Optional['Participant']: + """! Retrieve a participant + @param arg1 Either: + - str: The IP address of the participant + - int: The network ID of the participant + @param port The port number of the participant + """ if port is not None: ip_address = str(arg1) for participant in Participant.participants: @@ -83,6 +89,12 @@ class Participant: return None def AddParticipant(arg1: Union[str, 'Participant'], port: Optional[int] = None) -> 'Participant': + """! Add a participant + @param arg1 Either: + - str: The IP address of the participant + - Participant: The participant to add + @param port The port number of the participant + """ if port is not None: ip_address = str(arg1) participant = Participant(ip_address, port)