refs: document _next_name()

If it's not documented, it doesn't show up in the docs (and we really
should document, anyway).

1 files changed, 11 insertions, 0 deletions

diff --git a/include/git2/refs.h b/include/git2/refs.h
index 6a1db65a8..ae2d379d9 100644
--- a/include/git2/refs.h
+++ b/include/git2/refs.h
@@ -525,6 +525,17 @@ GIT_EXTERN(int) git_reference_iterator_glob_new(
  */
 GIT_EXTERN(int) git_reference_next(git_reference **out, git_reference_iterator *iter);
 
+/**
+ * Get the next reference's name
+ *
+ * This function is provided for convenience in case only the names
+ * are interesting as it avoids the allocation of the `git_reference`
+ * object which `git_reference_next()` needs.
+ *
+ * @param out pointer in which to store the string
+ * @param iter the iterator
+ * @return 0, GIT_ITEROVER if there are no more; or an error code
+ */
 GIT_EXTERN(int) git_reference_next_name(const char **out, git_reference_iterator *iter);
 
 /**