From 0d4be18524e50e69bc5a3579ecbaa6c19d1e623f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Th=C3=A9ophile=20Bastian?= Date: Mon, 8 May 2017 17:01:11 +0200 Subject: [PATCH] Bugreport minimal example --- .gitignore | 1 + Doxyfile | 13 +++++++++++++ minimal.h | 30 ++++++++++++++++++++++++++++++ minimal_works.h | 31 +++++++++++++++++++++++++++++++ 4 files changed, 75 insertions(+) create mode 100644 .gitignore create mode 100644 Doxyfile create mode 100644 minimal.h create mode 100644 minimal_works.h diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..a40510e --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +_docs diff --git a/Doxyfile b/Doxyfile new file mode 100644 index 0000000..0ba6900 --- /dev/null +++ b/Doxyfile @@ -0,0 +1,13 @@ +PROJECT_NAME = "minimal_example" + +OUTPUT_DIRECTORY = "_docs" +OUTPUT_LANGUAGE = English +WARNINGS = YES +EXTRACT_ALL = YES +FILE_PATTERNS = *.h *.cpp *.c +RECURSIVE = YES + +GENERATE_HTML = YES +GENERATE_LATEX = NO +GENERATE_MAN = NO +QUIET = NO diff --git a/minimal.h b/minimal.h new file mode 100644 index 0000000..a103b2d --- /dev/null +++ b/minimal.h @@ -0,0 +1,30 @@ +#pragma once + +/** + * @brief C API header file for something + * + * General purpose notes on this API: + * + * - Blah blah + * - Blah? Foobar. + **/ + +#include + +#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 diff --git a/minimal_works.h b/minimal_works.h new file mode 100644 index 0000000..b0b8dc2 --- /dev/null +++ b/minimal_works.h @@ -0,0 +1,31 @@ +#pragma once + +/** + * @brief C API header file for something + * @file minimal_works.h + * + * General purpose notes on this API: + * + * - Blah blah + * - Blah? Foobar. + **/ + +#include + +#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