aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarc Schink <swo-dev@marcschink.de>2017-01-13 13:00:06 +0100
committerMarc Schink <swo-dev@marcschink.de>2017-01-13 13:00:06 +0100
commit5cebf609f95f103dd7d3c008d1b221f536fcb1fa (patch)
treef7fcf479eff8f1054d2f3ec33539aa687a8fa1e1
parent58a50bd54f355941a4ace2d34e995db810531127 (diff)
Doxygen: Add @since tags
-rw-r--r--libswo/core.c4
-rw-r--r--libswo/decoder.c6
-rw-r--r--libswo/error.c3
-rw-r--r--libswo/log.c10
-rw-r--r--libswo/version.c16
5 files changed, 39 insertions, 0 deletions
diff --git a/libswo/core.c b/libswo/core.c
index 7bdea8a..75dd85c 100644
--- a/libswo/core.c
+++ b/libswo/core.c
@@ -41,6 +41,8 @@
* @retval LIBSWO_OK Success.
* @retval LIBSWO_ERR_ARG Invalid arguments.
* @retval LIBSWO_ERR_MALLOC Memory allocation error.
+ *
+ * @since 0.1.0
*/
LIBSWO_API int libswo_init(struct libswo_context **ctx, uint8_t *buffer,
size_t buffer_size)
@@ -104,6 +106,8 @@ LIBSWO_API int libswo_init(struct libswo_context **ctx, uint8_t *buffer,
*
* @retval LIBSWO_OK Success.
* @retval LIBSWO_ERR_ARG Invalid arguments.
+ *
+ * @since 0.1.0
*/
LIBSWO_API int libswo_exit(struct libswo_context *ctx)
{
diff --git a/libswo/decoder.c b/libswo/decoder.c
index 0888eef..c115d1b 100644
--- a/libswo/decoder.c
+++ b/libswo/decoder.c
@@ -516,6 +516,8 @@ static int handle_packet(struct libswo_context *ctx)
* @retval LIBSWO_OK Success.
* @retval LIBSWO_ERR Other error conditions.
* @retval LIBSWO_ERR_ARG Invalid arguments.
+ *
+ * @since 0.1.0
*/
LIBSWO_API int libswo_feed(struct libswo_context *ctx, const uint8_t *buffer,
size_t length)
@@ -538,6 +540,8 @@ LIBSWO_API int libswo_feed(struct libswo_context *ctx, const uint8_t *buffer,
* @retval LIBSWO_OK Success.
* @retval LIBSWO_ERR Other error conditions.
* @retval LIBSWO_ERR_ARG Invalid arguments.
+ *
+ * @since 0.1.0
*/
LIBSWO_API int libswo_decode(struct libswo_context *ctx, uint32_t flags)
{
@@ -623,6 +627,8 @@ LIBSWO_API int libswo_decode(struct libswo_context *ctx, uint32_t flags)
*
* @retval LIBSWO_OK Success.
* @retval LIBSWO_ERR_ARG Invalid argument.
+ *
+ * @since 0.1.0
*/
LIBSWO_API int libswo_set_callback(struct libswo_context *ctx,
libswo_decoder_callback callback, void *user_data)
diff --git a/libswo/error.c b/libswo/error.c
index ef8cd61..4e2ba6d 100644
--- a/libswo/error.c
+++ b/libswo/error.c
@@ -33,6 +33,7 @@
* @return A string which contains a description of the given error code, or
* the string <i>unknown error</i> if the error code is not known. The
* string is null-terminated and must not be free'd by the caller.
+ * @since 0.1.0
*/
LIBSWO_API const char *libswo_strerror(int error_code)
{
@@ -58,6 +59,8 @@ LIBSWO_API const char *libswo_strerror(int error_code)
* @return A string which contains the name of the given error code, or the
* string <i>unknown error code</i> if the error code is not known. The
* string is null-terminated and must not be free'd by the caller.
+ *
+ * @since 0.1.0
*/
LIBSWO_API const char *libswo_strerror_name(int error_code)
{
diff --git a/libswo/log.c b/libswo/log.c
index f945839..8feeffc 100644
--- a/libswo/log.c
+++ b/libswo/log.c
@@ -41,6 +41,8 @@
*
* @retval LIBSWO_OK Success.
* @retval LIBSWO_ERR_ARG Invalid arguments.
+ *
+ * @since 0.1.0
*/
LIBSWO_API int libswo_log_set_level(struct libswo_context *ctx,
enum libswo_log_level level)
@@ -64,6 +66,8 @@ LIBSWO_API int libswo_log_set_level(struct libswo_context *ctx,
*
* @retval LIBSWO_OK Success.
* @retval LIBSWO_ERR_ARG Invalid arguments.
+ *
+ * @since 0.1.0
*/
LIBSWO_API int libswo_log_get_level(const struct libswo_context *ctx,
enum libswo_log_level *level)
@@ -86,6 +90,8 @@ LIBSWO_API int libswo_log_get_level(const struct libswo_context *ctx,
*
* @retval LIBSWO_OK Success.
* @retval LIBSWO_ERR_ARG Invalid arguments.
+ *
+ * @since 0.1.0
*/
LIBSWO_API int libswo_log_set_callback(struct libswo_context *ctx,
libswo_log_callback callback, void *user_data)
@@ -121,6 +127,8 @@ LIBSWO_API int libswo_log_set_callback(struct libswo_context *ctx,
* @retval LIBSWO_OK Success.
* @retval LIBSWO_ERR Other error conditions.
* @retval LIBSWO_ERR_ARG Invalid arguments.
+ *
+ * @since 0.1.0
*/
LIBSWO_API int libswo_log_set_domain(struct libswo_context *ctx,
const char *domain)
@@ -147,6 +155,8 @@ LIBSWO_API int libswo_log_set_domain(struct libswo_context *ctx,
* @return A string which contains the current log domain on success, or NULL
* on failure. The string is null-terminated and must not be free'd by
* the caller.
+ *
+ * @since 0.1.0
*/
LIBSWO_API const char *libswo_log_get_domain(const struct libswo_context *ctx)
{
diff --git a/libswo/version.c b/libswo/version.c
index badbd8e..fe8f110 100644
--- a/libswo/version.c
+++ b/libswo/version.c
@@ -30,6 +30,8 @@
* Get the major version number of the libswo package.
*
* @return The major version number of the libswo package.
+ *
+ * @since 0.1.0
*/
LIBSWO_API int libswo_version_package_get_major(void)
{
@@ -40,6 +42,8 @@ LIBSWO_API int libswo_version_package_get_major(void)
* Get the minor version number of the libswo package.
*
* @return The minor version number of the libswo package.
+ *
+ * @since 0.1.0
*/
LIBSWO_API int libswo_version_package_get_minor(void)
{
@@ -50,6 +54,8 @@ LIBSWO_API int libswo_version_package_get_minor(void)
* Get the micro version number of the libswo package.
*
* @return The micro version number of the libswo package.
+ *
+ * @since 0.1.0
*/
LIBSWO_API int libswo_version_package_get_micro(void)
{
@@ -61,6 +67,8 @@ LIBSWO_API int libswo_version_package_get_micro(void)
*
* @return A string which contains the version number of the libswo package.
* The string is null-terminated and must not be free'd by the caller.
+ *
+ * @since 0.1.0
*/
LIBSWO_API const char *libswo_version_package_get_string(void)
{
@@ -71,6 +79,8 @@ LIBSWO_API const char *libswo_version_package_get_string(void)
* Get the <i>current</i> version number of the libswo libtool interface.
*
* @return The <i>current</i> version number of the libswo libtool interface.
+ *
+ * @since 0.1.0
*/
LIBSWO_API int libswo_version_library_get_current(void)
{
@@ -81,6 +91,8 @@ LIBSWO_API int libswo_version_library_get_current(void)
* Get the <i>revision</i> version number of the libswo libtool interface.
*
* @return The <i>revision</i> version number of the libswo libtool interface.
+ *
+ * @since 0.1.0
*/
LIBSWO_API int libswo_version_library_get_revision(void)
{
@@ -91,6 +103,8 @@ LIBSWO_API int libswo_version_library_get_revision(void)
* Get the <i>age</i> version number of the libswo libtool interface.
*
* @return The <i>age</i> version number of the libswo libtool interface.
+ *
+ * @since 0.1.0
*/
LIBSWO_API int libswo_version_library_get_age(void)
{
@@ -103,6 +117,8 @@ LIBSWO_API int libswo_version_library_get_age(void)
* @return A string which contains the version number of the libswo libtool
* interface. The string is null-terminated and must not be free'd by
* the caller.
+ *
+ * @since 0.1.0
*/
LIBSWO_API const char *libswo_version_library_get_string(void)
{