Francois Gouget : testbot/TestAgent: Add documentation for new().

[Alexandre Julliard]

Module: tools
Branch: master
Commit: 27b649ec0706da07a62e5cbb5c20abf3c99c0d50
URL:    https://source.winehq.org/git/tools.git/?a=commit;h=27b649ec0706da07a62e5cbb...

Author: Francois Gouget <fgouget(a)codeweavers.com>
Date:   Mon Mar 15 10:29:38 2021 +0100

testbot/TestAgent: Add documentation for new().

Signed-off-by: Francois Gouget <fgouget(a)codeweavers.com>
Signed-off-by: Alexandre Julliard <julliard(a)winehq.org>

---

 testbot/lib/WineTestBot/TestAgent.pm | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/testbot/lib/WineTestBot/TestAgent.pm b/testbot/lib/WineTestBot/TestAgent.pm
index 6c4e644..0aa59da 100644
--- a/testbot/lib/WineTestBot/TestAgent.pm
+++ b/testbot/lib/WineTestBot/TestAgent.pm
@@ -95,6 +95,19 @@ sub trace_speed($$)
     }
 }
 
+=pod
+=over 12
+
+=item C<new()>
+
+Creates a connection to a TestAgent server.
+
+Note that the resources, including the network connection and ssh tunnel,
+are automatically released when this object goes out of scope.
+
+=back
+=cut
+
 sub new($$$;$)
 {
   my ($class, $Hostname, $Port, $Tunnel) = @_;