Add a brief overview of each file to the docs.

This commit is contained in:
Eric Haszlakiewicz
2017-12-06 00:20:59 -05:00
parent d6d81e6ece
commit f2f103b986
21 changed files with 109 additions and 0 deletions

View File

@@ -5,6 +5,10 @@
* it under the terms of the MIT license. See COPYING for details.
*/
/**
* @file
* @brief Methods for retrieving the json-c version.
*/
#ifndef _json_c_version_h_
#define _json_c_version_h_
@@ -16,7 +20,21 @@
JSON_C_MICRO_VERSION)
#define JSON_C_VERSION "0.12.99"
/**
* @see JSON_C_VERSION
* @return the version of the json-c library as a string
*/
const char *json_c_version(void); /* Returns JSON_C_VERSION */
/**
* The json-c version encoded into an int, with the low order 8 bits
* being the micro version, the next higher 8 bits being the minor version
* and the next higher 8 bits being the major version.
* For example, 7.12.99 would be 0x00070B63.
*
* @see JSON_C_VERSION_NUM
* @return the version of the json-c library as an int
*/
int json_c_version_num(void); /* Returns JSON_C_VERSION_NUM */
#endif