doxygen-bugreport-headcomment/minimal_works.h

32 lines
706 B
C

#pragma once
/**
* @brief C API header file for something
* @file minimal_works.h
*
* General purpose notes on this API:
*
* - Blah blah
* - Blah? Foobar.
**/
#include <stdint.h>
#ifdef __cplusplus
extern "C" {
#endif
/*****************************************************************************/
/* Return values (aka error codes) */
/*****************************************************************************/
#define RC_NULLPTR 1 ///< One of the parameters was a null pointer
#define RC_DOMAIN 2 ///< One of the parameters has the wrong pointer type
#define RC_ERROR 255 ///< An undefined error occurred
// ...
#ifdef __cplusplus
}
#endif