diff options
| author | Alexander Levin <al.le@rockbox.org> | 2010-12-25 21:31:54 +0000 |
|---|---|---|
| committer | Alexander Levin <al.le@rockbox.org> | 2010-12-25 21:31:54 +0000 |
| commit | de317d46dc02ef3660ce2480998f9fbe4ef4e677 (patch) | |
| tree | 94f145a9dd571048574a66dd2fddf3cdb2252960 /apps/plugins/disktidy.c | |
| parent | 82daaae45513184df5e34b428391d869d9cf12e1 (diff) | |
disktidy: add a comment to the function
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@28896 a1c6a512-1295-4272-9138-f99709370657
Diffstat (limited to 'apps/plugins/disktidy.c')
| -rw-r--r-- | apps/plugins/disktidy.c | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/apps/plugins/disktidy.c b/apps/plugins/disktidy.c index a85e8274c0..141773aa17 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 */ |