Commit 18eb6ec8233cb3cb607abdf289da6a57cc252bb2
2014-07-08T09:56:16
Documentation fixes Fixup git_attr_value's comment to be recognised as documentation, and include the definitions needed for clang to parse reset.h such that it shows up in the documentation. This fixes #2430.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61
diff --git a/include/git2/attr.h b/include/git2/attr.h
index 3adbb2c..0238f3d 100644
--- a/include/git2/attr.h
+++ b/include/git2/attr.h
@@ -76,25 +76,28 @@ GIT_BEGIN_DECL
*/
#define GIT_ATTR_HAS_VALUE(attr) (git_attr_value(attr) == GIT_ATTR_VALUE_T)
+/**
+ * Possible states for an attribute
+ */
typedef enum {
- GIT_ATTR_UNSPECIFIED_T = 0,
- GIT_ATTR_TRUE_T,
- GIT_ATTR_FALSE_T,
- GIT_ATTR_VALUE_T,
+ GIT_ATTR_UNSPECIFIED_T = 0, /**< The attribute has been left unspecified */
+ GIT_ATTR_TRUE_T, /**< The attribute has been set */
+ GIT_ATTR_FALSE_T, /**< The attribute has been unset */
+ GIT_ATTR_VALUE_T, /**< This attribute has a value */
} git_attr_t;
-/*
- * Return the value type for a given attribute.
+/**
+ * Return the value type for a given attribute.
*
- * This can be either `TRUE`, `FALSE`, `UNSPECIFIED` (if the attribute
- * was not set at all), or `VALUE`, if the attribute was set to
- * an actual string.
+ * This can be either `TRUE`, `FALSE`, `UNSPECIFIED` (if the attribute
+ * was not set at all), or `VALUE`, if the attribute was set to an
+ * actual string.
*
- * If the attribute has a `VALUE` string, it can be accessed normally
- * as a NULL-terminated C string.
+ * If the attribute has a `VALUE` string, it can be accessed normally
+ * as a NULL-terminated C string.
*
- * @param attr The attribute
- * @return the value type for the attribute
+ * @param attr The attribute
+ * @return the value type for the attribute
*/
GIT_EXTERN(git_attr_t) git_attr_value(const char *attr);
diff --git a/include/git2/reset.h b/include/git2/reset.h
index b8c5803..ea7217e 100644
--- a/include/git2/reset.h
+++ b/include/git2/reset.h
@@ -7,6 +7,10 @@
#ifndef INCLUDE_git_reset_h__
#define INCLUDE_git_reset_h__
+#include "common.h"
+#include "types.h"
+#include "strarray.h"
+
/**
* @file git2/reset.h
* @brief Git reset management routines