Show
Ignore:
Timestamp:
11/13/09 15:37:02 (14 years ago)
Author:
bhilburn
Message:

Added Doxygen documentation to headers in the include/vtcross directory.

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • vtcross/trunk/src/include/vtcross/socketcomm.h

    r411 r518  
    1515*/ 
    1616 
    17 /* TODO DESCRIPTION OF FILE. 
     17/*! This file describes the interface to libsocketcomm, which is the internal 
     18 * socket communication library that CROSS radios use to communicate between 
     19 * components. 
    1820 */ 
    1921 
    … …  
    2628 
    2729 
    28 /* TODO 
     30/*! TODO 
    2931 */ 
    3032int32_t ReadMessage(int32_t socketFD, char *msgBuffer); 
    3133 
    32 /* TODO 
     34/*! TODO 
    3335 */ 
    3436int32_t SendMessage(int32_t socketFD, const char *message) ; 
    3537 
    36 /* TODO 
     38/*! TODO 
    3739 */ 
    3840int32_t GetParameter(int32_t socketFD, struct Parameter pList[], \ 
    3941        struct Radio_Info *radio_info); 
    4042 
    41 /* TODO 
     43/*! TODO 
    4244 */ 
    4345int32_t GetRequest(int32_t socketFD, struct Parameter pList[], \ 
    4446        struct Radio_Info *radio_info); 
    4547 
    46 /* This is the original function that does what the above function is supposed 
     48/*! This is the original function that does what the above function is supposed 
    4749 * to do. 
    4850 */ 
    4951int32_t ClientSocket(const char  *serverName, const char *portNumber); 
    5052 
    51 /* TODO 
     53/*! TODO 
    5254 */ 
    5355int32_t  AcceptTCPConnection(int32_t servSock); 
    5456 
    55 /* TODO 
     57/*! TODO 
    5658 */ 
    5759int32_t CreateTCPServerSocket(uint16_t port); 
    5860 
    59 /* TODO 
     61/*! TODO 
    6062 */ 
    6163int32_t InitializeTCPServerPort(int32_t servSock);