Add documentation for file dialog and resource path functions

This commit is contained in:
scawful
2024-11-08 21:02:24 -05:00
parent e1a9d40c4b
commit e21bdb3f44
2 changed files with 14 additions and 1 deletions

View File

@@ -10,7 +10,16 @@ namespace core {
class FileDialogWrapper { class FileDialogWrapper {
public: public:
/**
* @brief ShowOpenFileDialog opens a file dialog and returns the selected
* filepath.
*/
static std::string ShowOpenFileDialog(); static std::string ShowOpenFileDialog();
/**
* @brief ShowOpenFolderDialog opens a file dialog and returns the selected
* folder path.
*/
static std::string ShowOpenFolderDialog(); static std::string ShowOpenFolderDialog();
static std::vector<std::string> GetSubdirectoriesInFolder( static std::vector<std::string> GetSubdirectoriesInFolder(
const std::string& folder_path); const std::string& folder_path);

View File

@@ -7,9 +7,13 @@ namespace yaze {
namespace app { namespace app {
namespace core { namespace core {
/**
* @brief GetBundleResourcePath returns the path to the bundle resource
* directory. Specific to MacOS.
*/
std::string GetBundleResourcePath(); std::string GetBundleResourcePath();
} } // namespace core
} // namespace app } // namespace app
} // namespace yaze } // namespace yaze