g-socket.ads (Send_Socket): Fix misleading comment.

2009-04-20  Thomas Quinot  <quinot@adacore.com>

	* g-socket.ads (Send_Socket): Fix misleading comment.

From-SVN: r146384

diff --git a/gcc/ada/ChangeLog b/gcc/ada/ChangeLog
index 204592b0b53ca6ac00b0aa9e6aa08d4f6493bfd7..d5a0cd7ad48b72503e5e12a68f8c928cd7ddb00e 100644 (file)
--- a/gcc/ada/ChangeLog
+++ b/gcc/ada/ChangeLog
@@ -1,3 +1,7 @@
+2009-04-20  Thomas Quinot  <quinot@adacore.com>
+
+       * g-socket.ads (Send_Socket): Fix misleading comment.
+
 2009-04-20  Arnaud Charlet  <charlet@adacore.com>
 
        * switch-c.adb (Scan_Front_End_Switches): Disable inspector mode in

diff --git a/gcc/ada/g-socket.ads b/gcc/ada/g-socket.ads
index 8de8f02fe7eb2e870f0b7c248ec2a815b8417271..96d3428261de8554658f99ea0a224290a2ea7411 100644 (file)
--- a/gcc/ada/g-socket.ads
+++ b/gcc/ada/g-socket.ads
@@ -935,10 +935,9 @@ package GNAT.Sockets is
       Item   : Ada.Streams.Stream_Element_Array;
       Last   : out Ada.Streams.Stream_Element_Offset;
       Flags  : Request_Flag_Type := No_Request_Flag);
-   --  Transmit a message over a socket. Note that Last is set to
-   --  Item'First-1 when socket has been closed by peer. This is not
-   --  considered an error and no exception is raised. Flags allows to control
-   --  the transmission. Raises Socket_Error on any other error condition.
+   --  Transmit a message over a socket. Upon return, Last is set to the index
+   --  within Item of the last element transmitted. Flags allows to control
+   --  the transmission. Raises Socket_Error on any detected error condition.
 
    procedure Send_Socket
      (Socket : Socket_Type;
@@ -975,14 +974,13 @@ package GNAT.Sockets is
    --  Same interface as Ada.Streams.Stream_IO
 
    function Stream (Socket : Socket_Type) return Stream_Access;
-   --  Create a stream associated with a stream-based socket that is
-   --  already connected.
+   --  Create a stream associated with an already connected stream-based socket
 
    function Stream
      (Socket  : Socket_Type;
       Send_To : Sock_Addr_Type) return Stream_Access;
-   --  Create a stream associated with a datagram-based socket that is already
-   --  bound. Send_To is the socket address to which messages are being sent.
+   --  Create a stream associated with an already bound datagram-based socket.
+   --  Send_To is the destination address to which messages are being sent.
 
    function Get_Address
      (Stream : not null Stream_Access) return Sock_Addr_Type;
@@ -996,9 +994,10 @@ package GNAT.Sockets is
 
    type Socket_Set_Type is limited private;
    --  This type allows to manipulate sets of sockets. It allows to wait for
-   --  events on multiple endpoints at one time. This type used to contain
-   --  a pointer to dynamically allocated storage, but this is not the case
-   --  anymore, and no special precautions are required to avoid memory leaks.
+   --  events on multiple endpoints at one time.
+   --  Note: This type used to contain a pointer to dynamically allocated
+   --  storage, but this is not the case anymore, and no special precautions
+   --  are required to avoid memory leaks.
 
    procedure Clear (Item : in out Socket_Set_Type; Socket : Socket_Type);
    --  Remove Socket from Item