summaryrefslogtreecommitdiff
path: root/include/git2/net.h
diff options
context:
space:
mode:
authorCarlos Martín Nieto <cmn@dwim.me>2014-12-06 03:36:18 +0100
committerCarlos Martín Nieto <cmn@dwim.me>2014-12-06 03:44:40 +0100
commita295bd2dc4a1ac2b15b9c39089d148499e6e9e00 (patch)
treee9d3a1bffdaf0a3469943956f32a06d507c8dcf0 /include/git2/net.h
parentd43c7bd050cd461b13f4b5aa30f14010c5b2b611 (diff)
downloadlibgit2-cmn/doc-all.tar.gz
doc: add documentation to all the public structs and enumscmn/doc-all
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
Diffstat (limited to 'include/git2/net.h')
-rw-r--r--include/git2/net.h5
1 files changed, 3 insertions, 2 deletions
diff --git a/include/git2/net.h b/include/git2/net.h
index 8cffa18dc..04dff34bc 100644
--- a/include/git2/net.h
+++ b/include/git2/net.h
@@ -21,12 +21,13 @@ GIT_BEGIN_DECL
#define GIT_DEFAULT_PORT "9418"
-/*
+/**
+ * Direction of the connection.
+ *
* We need this because we need to know whether we should call
* git-upload-pack or git-receive-pack on the remote end when get_refs
* gets called.
*/
-
typedef enum {
GIT_DIRECTION_FETCH = 0,
GIT_DIRECTION_PUSH = 1