Commit fe1f47776f7fffbb31fd8de067aed9eca25e0b4b

Carlos Martín Nieto 2016-03-31T11:35:53

Add a no-op size_t typedef for the doc parser Clang's documentation parser, which we use in our documentation system does not report any comments for functions which use size_t as a type. The root cause is buried somewhere in libclang but we can work around it by defining the type ourselves. This typedef makes sure that libclang sees it and that we do not change its size.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
diff --git a/include/git2/common.h b/include/git2/common.h
index 0629abb..d7428d8 100644
--- a/include/git2/common.h
+++ b/include/git2/common.h
@@ -29,6 +29,14 @@
 # include <inttypes.h>
 #endif
 
+#ifdef DOCURIUM
+/*
+ * This is so clang's doc parser acknowledges comments on functions
+ * with size_t parameters.
+ */
+typedef size_t size_t;
+#endif
+
 /** Declare a public function exported for application use. */
 #if __GNUC__ >= 4
 # define GIT_EXTERN(type) extern \