git_libgit2_opts: document GIT_OPT_SET_USER_AGENT

Edward Thomson · Edward Thomson · commit 5bc93eaea0ce · 2016-02-22T22:26:01.000-05:00
diff --git a/include/git2/common.h b/include/git2/common.h
@@ -245,6 +245,12 @@ typedef enum {
  *
  *	* opts(GIT_OPT_SET_USER_AGENT, const char *user_agent)
  *
+ *		> Set the value of the User-Agent header.  This value will be
+ *		> appended to "git/1.0", for compatibility with other git clients.
+ *		>
+ *		> - `user_agent` is the value that will be delivered as the
+ *		>   User-Agent header on HTTP requests.
+ *
  * @param option Option key
  * @param ... value to set the option
  * @return 0 on success, <0 on failure

Original file line number	Diff line number	Diff line change
`@@ -245,6 +245,12 @@ typedef enum {`
`245`	`245`	`*`
`246`	`246`	`* * opts(GIT_OPT_SET_USER_AGENT, const char *user_agent)`
`247`	`247`	`*`
	`248`	`+ * > Set the value of the User-Agent header. This value will be`
	`249`	`+ * > appended to "git/1.0", for compatibility with other git clients.`
	`250`	`+ * >`
	`251`	+ * > - `user_agent` is the value that will be delivered as the
	`252`	`+ * > User-Agent header on HTTP requests.`
	`253`	`+ *`
`248`	`254`	`* @param option Option key`
`249`	`255`	`* @param ... value to set the option`
`250`	`256`	`* @return 0 on success, <0 on failure`