tweak comment for breaddir()

diff --git a/bacula/src/win32/compat/compat.cpp b/bacula/src/win32/compat/compat.cpp
index 0e04c80f5f03b351ddc696245a4193f3d326a8be..65417a16f11cf85430178598f032c3e9e24d3509 100644 (file)
--- a/bacula/src/win32/compat/compat.cpp
+++ b/bacula/src/win32/compat/compat.cpp
@@ -1733,6 +1733,12 @@ closedir(DIR *dirp)
 } WIN32_FIND_DATA, *PWIN32_FIND_DATA;
 */
 
+/* breaddir() is a a Bacula's replacement for readdir() using POOLMEM
+ * return:
+ *  0: returned the next filename in dname
+ * -1: end of directory reached
+ * >0: an error appends, the value is the errno
+ */
 int breaddir(DIR *dirp, POOLMEM *&dname)
 {
    _dir *dp = (_dir *)dirp;