Show
Ignore:
Timestamp:
08/13/08 12:48:09 (5 months ago)
Author:
liamstask
Message:

- updated struct documentation: much better xbee doc

Files:
1 modified

Legend:

Unmodified
Added
Removed
  • firmware/trunk/libraries/webserver/webserver.h

    r755 r815  
    4141/** 
    4242  A structure that represents a key-value pair in an HTML form. 
     43  This structure only points at the data received by the web server - it does not copy it.  So be sure 
     44  to note that this structure becomes invalid as soon as the data used to create is gone. 
    4345  \ingroup webserver 
    4446*/ 
    4547typedef struct 
    4648{ 
    47   char *key; 
    48   char *value; 
     49  char *key;   /**< A pointer to the key of this element. */  
     50  char *value; /**< A pointer to the value of this element. */ 
    4951} HtmlFormElement; 
    5052 
    5153/** 
    5254  A structure that represents a collection of HtmlFormElement structures. 
     55  If you need a larger form, you can adjust \b MAX_FORM_ELEMENTS in webserver.h it accommodates 10 by default. 
    5356  \ingroup webserver 
    5457*/ 
    5558typedef struct 
    5659{ 
    57   HtmlFormElement elements[MAX_FORM_ELEMENTS]; 
    58   int count; 
     60  HtmlFormElement elements[MAX_FORM_ELEMENTS]; /**< An array of form elements. */ 
     61  int count;                                   /**< The number of form elements contained in this form. */ 
    5962} HtmlForm; 
    6063