Fix outdated comments in ScanDirectoryTree

This commit is contained in:
JosJuice 2016-12-25 21:57:33 +01:00
parent 09c6148aba
commit e56bec9c87
2 changed files with 3 additions and 5 deletions

View File

@ -439,12 +439,10 @@ bool CreateEmptyFile(const std::string& filename)
return true; return true;
} }
// Scans the directory tree gets, starting from _Directory and adds the // Recursive or non-recursive list of files and directories under directory.
// results into parentEntry. Returns the number of files+directories found
FSTEntry ScanDirectoryTree(const std::string& directory, bool recursive) FSTEntry ScanDirectoryTree(const std::string& directory, bool recursive)
{ {
INFO_LOG(COMMON, "ScanDirectoryTree: directory %s", directory.c_str()); INFO_LOG(COMMON, "ScanDirectoryTree: directory %s", directory.c_str());
// How many files + directories we found
FSTEntry parent_entry; FSTEntry parent_entry;
parent_entry.physicalName = directory; parent_entry.physicalName = directory;
parent_entry.isDirectory = true; parent_entry.isDirectory = true;
@ -505,7 +503,7 @@ FSTEntry ScanDirectoryTree(const std::string& directory, bool recursive)
} }
closedir(dirp); closedir(dirp);
#endif #endif
// Return number of entries found.
return parent_entry; return parent_entry;
} }

View File

@ -112,7 +112,7 @@ bool Copy(const std::string& srcFilename, const std::string& destFilename);
// creates an empty file filename, returns true on success // creates an empty file filename, returns true on success
bool CreateEmptyFile(const std::string& filename); bool CreateEmptyFile(const std::string& filename);
// Recursive or non-recursive list of files under directory. // Recursive or non-recursive list of files and directories under directory.
FSTEntry ScanDirectoryTree(const std::string& directory, bool recursive); FSTEntry ScanDirectoryTree(const std::string& directory, bool recursive);
// deletes the given directory and anything under it. Returns true on success. // deletes the given directory and anything under it. Returns true on success.