Add documentation_style to with short and full options

This commit is contained in:
Sean McArthur
2021-09-15 17:25:12 -07:00
committed by Emilio Cobos Álvarez
parent 24c130bd9c
commit 0e3f9bd9cb
11 changed files with 133 additions and 2 deletions
+14
View File
@@ -0,0 +1,14 @@
#include <stdarg.h>
#include <stdbool.h>
#include <stdint.h>
#include <stdlib.h>
/**
* The root of all evil.
*/
void root(void);
/**
* A little above the root, and a lot more visible, with a run-on sentence
*/
void trunk(void);
@@ -0,0 +1,22 @@
#include <stdarg.h>
#include <stdbool.h>
#include <stdint.h>
#include <stdlib.h>
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
/**
* The root of all evil.
*/
void root(void);
/**
* A little above the root, and a lot more visible, with a run-on sentence
*/
void trunk(void);
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus
+15
View File
@@ -0,0 +1,15 @@
#include <cstdarg>
#include <cstdint>
#include <cstdlib>
#include <ostream>
#include <new>
extern "C" {
/// The root of all evil.
void root();
/// A little above the root, and a lot more visible, with a run-on sentence
void trunk();
} // extern "C"
+20
View File
@@ -0,0 +1,20 @@
from libc.stdint cimport int8_t, int16_t, int32_t, int64_t, intptr_t
from libc.stdint cimport uint8_t, uint16_t, uint32_t, uint64_t, uintptr_t
cdef extern from *:
ctypedef bint bool
ctypedef struct va_list
cdef extern from *:
# The root of all evil.
#
# But at least it contains some more documentation as someone would expect
# from a simple test case like this. Though, this shouldn't appear in the
# output.
void root();
# A little above the root, and a lot more visible, with a run-on sentence
# to test going over the first line.
#
# Still not here, though.
void trunk();
+16
View File
@@ -0,0 +1,16 @@
/// The root of all evil.
///
/// But at least it contains some more documentation as someone would expect
/// from a simple test case like this. Though, this shouldn't appear in the
/// output.
#[no_mangle]
pub extern "C" fn root() {
}
/// A little above the root, and a lot more visible, with a run-on sentence
/// to test going over the first line.
///
/// Still not here, though.
#[no_mangle]
pub extern "C" fn trunk() {
}
+1
View File
@@ -0,0 +1 @@
documentation_length = "short"
+4
View File
@@ -208,6 +208,10 @@ fn run_compile_test(
cbindgen_outputs.insert(cbindgen_output);
if env::var_os("CBINDGEN_TEST_NO_COMPILE").is_some() {
return;
}
compile(
&generated_file,
&tests_path,