summaryrefslogtreecommitdiff
path: root/include/git2/net.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/git2/net.h')
-rw-r--r--include/git2/net.h38
1 files changed, 36 insertions, 2 deletions
diff --git a/include/git2/net.h b/include/git2/net.h
index 4bef90509..01b307dae 100644
--- a/include/git2/net.h
+++ b/include/git2/net.h
@@ -1,3 +1,27 @@
+/*
+ * This file is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License, version 2,
+ * as published by the Free Software Foundation.
+ *
+ * In addition to the permissions in the GNU General Public License,
+ * the authors give you unlimited permission to link the compiled
+ * version of this file into combinations with other programs,
+ * and to distribute those combinations without any restriction
+ * coming from the use of this file. (The General Public License
+ * restrictions do apply in other respects; for example, they cover
+ * modification of the file, and distribution when not linked into
+ * a combined executable.)
+ *
+ * This file is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; see the file COPYING. If not, write to
+ * the Free Software Foundation, 51 Franklin Street, Fifth Floor,
+ * Boston, MA 02110-1301, USA.
+ */
#ifndef INCLUDE_net_h__
#define INCLUDE_net_h__
@@ -16,15 +40,25 @@
#define GIT_DIR_FETCH 0
#define GIT_DIR_PUSH 1
-/*
- * This is what we give out on ->ls()
+/**
+ * @file git2/net.h
+ * @brief Git networking declarations
+ * @ingroup Git
+ * @{
*/
+GIT_BEGIN_DECL
+/**
+ * Remote head description, given out on `ls` calls.
+ */
struct git_remote_head {
git_oid oid;
char *name;
};
+/**
+ * Array of remote heads
+ */
struct git_headarray {
unsigned int len;
struct git_remote_head **heads;