From de317d46dc02ef3660ce2480998f9fbe4ef4e677 Mon Sep 17 00:00:00 2001 From: Alexander Levin Date: Sat, 25 Dec 2010 21:31:54 +0000 Subject: disktidy: add a comment to the function git-svn-id: svn://svn.rockbox.org/rockbox/trunk@28896 a1c6a512-1295-4272-9138-f99709370657 --- apps/plugins/disktidy.c | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/apps/plugins/disktidy.c b/apps/plugins/disktidy.c index a85e827..141773a 100644 --- a/apps/plugins/disktidy.c +++ b/apps/plugins/disktidy.c @@ -228,7 +228,10 @@ void tidy_path_remove_entry(char *path, int old_path_length, int *path_length) *path_length = old_path_length; } -/* path is assumed to be array of size MAX_PATH */ +/* Removes the directory specified by 'path'. This includes recursively + removing all files and directories in that directory. + path is assumed to be array of size MAX_PATH. +*/ enum tidy_return tidy_removedir(char *path, int *path_length) { /* delete directory */ -- cgit v1.1