diff options
Diffstat (limited to 'src/filesystem.hpp')
| -rw-r--r-- | src/filesystem.hpp | 23 |
1 files changed, 14 insertions, 9 deletions
diff --git a/src/filesystem.hpp b/src/filesystem.hpp index 5b2334a..1975bc5 100644 --- a/src/filesystem.hpp +++ b/src/filesystem.hpp @@ -1,3 +1,9 @@ +/** + * @file filesystem.hpp + * @author Felix Morgner (felix.morgner@gmail.com) + * @since 1.0.0 + */ + #ifndef WANDA_FILESYSTEM_HPP #define WANDA_FILESYSTEM_HPP @@ -8,27 +14,26 @@ namespace wanda { /** - * @brief Covenience alias for path lists - */ + * @brief Covenience alias for path lists + */ using path_list = std::vector<std::filesystem::path>; /** - * @brief The default scan filter, allowing only regular files to pass - */ + * @brief The default scan filter, allowing only regular files to pass + */ constexpr inline auto default_filter = [](std::filesystem::path const & path) { return is_regular_file(path); }; /** - * @brief Scan the given folder for files - */ + * @brief Scan the given folder for files + */ std::optional<path_list> scan(std::filesystem::path folder, bool(filter)(std::filesystem::path const &) = default_filter); /** - * @brief Pick a random path from the given list - */ + * @brief Pick a random path from the given list + */ std::filesystem::path random_pick(path_list const & paths); - } // namespace wanda #endif
\ No newline at end of file |