Improve method documentation
This commit is contained in:
parent
e8e13239c8
commit
918109f010
|
@ -35,7 +35,7 @@ namespace carla {
|
|||
const std::string &wildcard_pattern) {
|
||||
fs::path root(folder_path);
|
||||
if (!fs::exists(root) || !fs::is_directory(root)) {
|
||||
throw_exception(std::invalid_argument(folder_path + ": not such folder"));
|
||||
throw_exception(std::invalid_argument(folder_path + ": no such folder"));
|
||||
}
|
||||
|
||||
std::vector<std::string> results;
|
||||
|
|
|
@ -26,6 +26,12 @@ namespace carla {
|
|||
std::string &filepath,
|
||||
const std::string &default_extension = "");
|
||||
|
||||
/// List (not recursively) regular files at @a folder_path matching
|
||||
/// @a wildcard_pattern.
|
||||
///
|
||||
/// @throw std::invalid_argument if folder does not exist.
|
||||
///
|
||||
/// @todo Do permission check.
|
||||
static std::vector<std::string> ListFolder(
|
||||
const std::string &folder_path,
|
||||
const std::string &wildcard_pattern);
|
||||
|
|
Loading…
Reference in New Issue