Commit b4117e19b7a968f8e6b878d81c58a462093cf1b3
2013-04-24T20:09:42
docs: formatting fixes
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 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101
diff --git a/include/git2/attr.h b/include/git2/attr.h
index dea44f0..f099245 100644
--- a/include/git2/attr.h
+++ b/include/git2/attr.h
@@ -228,7 +228,7 @@ GIT_EXTERN(void) git_attr_cache_flush(
* function allows you to add others. For example, to add the default
* macro, you would call:
*
- * git_attr_add_macro(repo, "binary", "-diff -crlf");
+ * git_attr_add_macro(repo, "binary", "-diff -crlf");
*/
GIT_EXTERN(int) git_attr_add_macro(
git_repository *repo,
diff --git a/include/git2/common.h b/include/git2/common.h
index 6101e13..f9e9929 100644
--- a/include/git2/common.h
+++ b/include/git2/common.h
@@ -142,34 +142,42 @@ enum {
*
* Available options:
*
- * opts(GIT_OPT_GET_MWINDOW_SIZE, size_t *):
- * Get the maximum mmap window size
+ * * opts(GIT_OPT_GET_MWINDOW_SIZE, size_t *):
*
- * opts(GIT_OPT_SET_MWINDOW_SIZE, size_t):
- * Set the maximum mmap window size
+ * > Get the maximum mmap window size
*
- * opts(GIT_OPT_GET_MWINDOW_MAPPED_LIMIT, size_t *):
- * Get the maximum memory that will be mapped in total by the library
+ * * opts(GIT_OPT_SET_MWINDOW_SIZE, size_t):
*
- * opts(GIT_OPT_SET_MWINDOW_MAPPED_LIMIT, size_t):
- * Set the maximum amount of memory that can be mapped at any time
+ * > Set the maximum mmap window size
+ *
+ * * opts(GIT_OPT_GET_MWINDOW_MAPPED_LIMIT, size_t *):
+ *
+ * > Get the maximum memory that will be mapped in total by the library
+ *
+ * * opts(GIT_OPT_SET_MWINDOW_MAPPED_LIMIT, size_t):
+ *
+ * >Set the maximum amount of memory that can be mapped at any time
* by the library
*
- * opts(GIT_OPT_GET_SEARCH_PATH, int level, char *out, size_t len)
- * Get the search path for a given level of config data. "level" must
- * be one of GIT_CONFIG_LEVEL_SYSTEM, GIT_CONFIG_LEVEL_GLOBAL, or
- * GIT_CONFIG_LEVEL_XDG. The search path is written to the `out`
- * buffer up to size `len`. Returns GIT_EBUFS if buffer is too small.
- *
- * opts(GIT_OPT_SET_SEARCH_PATH, int level, const char *path)
- * Set the search path for a level of config data. The search path
- * applied to shared attributes and ignore files, too.
- * - `path` lists directories delimited by GIT_PATH_LIST_SEPARATOR.
- * Pass NULL to reset to the default (generally based on environment
- * variables). Use magic path `$PATH` to include the old value
- * of the path (if you want to prepend or append, for instance).
- * - `level` must be GIT_CONFIG_LEVEL_SYSTEM, GIT_CONFIG_LEVEL_GLOBAL,
- * or GIT_CONFIG_LEVEL_XDG.
+ * * opts(GIT_OPT_GET_SEARCH_PATH, int level, char *out, size_t len)
+ *
+ * > Get the search path for a given level of config data. "level" must
+ * > be one of `GIT_CONFIG_LEVEL_SYSTEM`, `GIT_CONFIG_LEVEL_GLOBAL`, or
+ * > `GIT_CONFIG_LEVEL_XDG`. The search path is written to the `out`
+ * > buffer up to size `len`. Returns GIT_EBUFS if buffer is too small.
+ *
+ * * opts(GIT_OPT_SET_SEARCH_PATH, int level, const char *path)
+ *
+ * > Set the search path for a level of config data. The search path
+ * > applied to shared attributes and ignore files, too.
+ * >
+ * > - `path` lists directories delimited by GIT_PATH_LIST_SEPARATOR.
+ * > Pass NULL to reset to the default (generally based on environment
+ * > variables). Use magic path `$PATH` to include the old value
+ * > of the path (if you want to prepend or append, for instance).
+ * >
+ * > - `level` must be GIT_CONFIG_LEVEL_SYSTEM, GIT_CONFIG_LEVEL_GLOBAL,
+ * > or GIT_CONFIG_LEVEL_XDG.
*
* @param option Option key
* @param ... value to set the option
diff --git a/include/git2/cred_helpers.h b/include/git2/cred_helpers.h
index e3eb91d..5d93cf4 100644
--- a/include/git2/cred_helpers.h
+++ b/include/git2/cred_helpers.h
@@ -30,11 +30,11 @@ typedef struct git_cred_userpass_payload {
/**
* Stock callback usable as a git_cred_acquire_cb. This calls
* git_cred_userpass_plaintext_new unless the protocol has not specified
- * GIT_CREDTYPE_USERPASS_PLAINTEXT as an allowed type.
+ * `GIT_CREDTYPE_USERPASS_PLAINTEXT` as an allowed type.
*
* @param cred The newly created credential object.
* @param url The resource for which we are demanding a credential.
- * @param username_from_url The username that was embedded in a "user@host"
+ * @param user_from_url The username that was embedded in a "user@host"
* remote url, or NULL if not included.
* @param allowed_types A bitmask stating which cred types are OK to return.
* @param payload The payload provided when specifying this callback. (This is