From a295bd2dc4a1ac2b15b9c39089d148499e6e9e00 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Carlos=20Mart=C3=ADn=20Nieto?= <cmn@dwim.me>
Date: Sat, 6 Dec 2014 03:36:18 +0100
Subject: doc: add documentation to all the public structs and enums

This makes them show up in the reference, even if the text itself isn't
the most descriptive.

These have been found with

    grep -Przon '\n\ntypedef struct.*?\{' -- include
    grep -Przon '\n\ntypedef enum.*?\{' -- include
---
 include/git2/index.h | 3 +++
 1 file changed, 3 insertions(+)

(limited to 'include/git2/index.h')

diff --git a/include/git2/index.h b/include/git2/index.h
index 0b4476b4e..4382c2f9e 100644
--- a/include/git2/index.h
+++ b/include/git2/index.h
@@ -75,6 +75,9 @@ typedef struct git_index_entry {
 #define GIT_IDXENTRY_STAGEMASK (0x3000)
 #define GIT_IDXENTRY_STAGESHIFT 12
 
+/**
+ * Flags for index entries
+ */
 typedef enum {
 	GIT_IDXENTRY_EXTENDED  = (0x4000),
 	GIT_IDXENTRY_VALID     = (0x8000),
-- 
cgit v1.2.1