Skip to content

Commit

Permalink
add doxygen docs to restclient structs
Browse files Browse the repository at this point in the history
  • Loading branch information
mrtazz committed Dec 26, 2015
1 parent b8d8260 commit 6f63635
Showing 1 changed file with 19 additions and 3 deletions.
22 changes: 19 additions & 3 deletions include/restclient-cpp/restclient.h
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,30 @@ class RestClient
*/
typedef std::map<std::string, std::string> headermap;

/** response struct for queries */
/** @struct response
* @brief This structure represents the HTTP response data
* @var response::code
* Member 'code' contains the HTTP response code
* @var response::body
* Member 'body' contains the HTTP response body
* @var response::headers
* Member 'headers' contains the HTTP response headers
*/
typedef struct
{
int code;
std::string body;
headermap headers;
} response;
/** struct used for uploading data */

/** @struct upload_object
* @brief This structure represents the payload to upload on POST
* requests
* @var upload_object::data
* Member 'data' contains the data to upload
* @var upload_object::length
* Member 'length' contains the length of the data to upload
*/
typedef struct
{
const char* data;
Expand Down Expand Up @@ -70,7 +86,7 @@ class RestClient

// header callback function
static size_t header_callback(void *ptr, size_t size, size_t nmemb,
void *userdata);
void *userdata);
// read callback function
static size_t read_callback(void *ptr, size_t size, size_t nmemb,
void *userdata);
Expand Down

0 comments on commit 6f63635

Please sign in to comment.