Show
Ignore:
Timestamp:
08/12/08 16:01:38 (5 months ago)
Author:
liamstask
Message:

- add doc for IP_ADDRESS macro

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • firmware/trunk/core/makingthings/network.h

    r792 r814  
    1616*********************************************************************************/ 
    1717 
    18 /* 
    19   NETWORK.h 
    20  
    21   MakingThings 
     18/** 
     19  @file 
     20  Network system defines. 
    2221*/ 
    2322 
    … …  
    2524#define NETWORK_H 
    2625 
     26/** 
     27  \def IP_ADDRESS( a, b, c, d ) 
     28  Generate an address appropriate for Socket functions from 4 integers. 
     29  \b Example 
     30  \code 
     31  void* sock = Socket( IP_ADDRESS( 192, 168, 0, 200 ), 80 ); 
     32  \endcode 
     33  \ingroup Sockets 
     34*/ 
    2735// lwIP socket addresses are formatted this way... 
    2836#define IP_ADDRESS( a, b, c, d ) ( ( (int)a << 24 ) + ( (int)b << 16 ) + ( (int)c << 8 ) + (int)d )