do_for_each_ref(): move docstring to the header file

diff --git a/refs/files-backend.c b/refs/files-backend.c
index bbf96ad83a5abc494fbbd99d2bd9cceef6252e97..8fa897b3b873e5d58a12fb51665d806bbd1476b6 100644 (file)
--- a/refs/files-backend.c
+++ b/refs/files-backend.c
@@ -1878,15 +1878,6 @@ static int do_for_each_entry(struct ref_cache *refs, const char *base,
        return retval;
 }
 
-/*
- * Call fn for each reference in the specified ref_cache for which the
- * refname begins with base.  If trim is non-zero, then trim that many
- * characters off the beginning of each refname before passing the
- * refname to fn.  flags can be DO_FOR_EACH_INCLUDE_BROKEN to include
- * broken references in the iteration.  If fn ever returns a non-zero
- * value, stop the iteration and return that value; otherwise, return
- * 0.
- */
 int do_for_each_ref(const char *submodule, const char *base,
                    each_ref_fn fn, int trim, int flags, void *cb_data)
 {