FindDirectory docs: clarify where the functions are located

Only the C++ interface is in libbe. The C functions as well as the new
find_path functions are all in libroot.

Fixes #16749
This commit is contained in:
Adrien Destugues
2021-01-13 12:57:00 +01:00
parent 2aa5a0353d
commit 0e061f0903
+8 -1
View File
@@ -16,7 +16,6 @@
/*! /*!
\file FindDirectory.h \file FindDirectory.h
\ingroup storage \ingroup storage
\ingroup libbe
\brief Provides the find_directory(), find_path(), find_paths() functions \brief Provides the find_directory(), find_path(), find_paths() functions
as well as the \c directory_which constants. as well as the \c directory_which constants.
@@ -1203,6 +1202,7 @@
/*! /*!
\fn status_t find_directory(directory_which which, dev_t volume, \fn status_t find_directory(directory_which which, dev_t volume,
bool createIt, char* pathString, int32 length) bool createIt, char* pathString, int32 length)
\ingroup libroot
\brief C interface to find_directory \brief C interface to find_directory
Fills up to \a length characters of \a pathString with the path to \a which Fills up to \a length characters of \a pathString with the path to \a which
@@ -1216,6 +1216,7 @@
/*! /*!
\fn status_t find_directory(directory_which which, BPath* path, bool createIt, \fn status_t find_directory(directory_which which, BPath* path, bool createIt,
BVolume* volume) BVolume* volume)
\ingroup libbe
\brief C++ interface to find_directory \brief C++ interface to find_directory
Set \a path to \a which on \a volume. Set \a path to \a which on \a volume.
@@ -1228,6 +1229,7 @@
\fn status_t find_path(const void* codePointer, \fn status_t find_path(const void* codePointer,
path_base_directory baseDirectory, const char* subPath, path_base_directory baseDirectory, const char* subPath,
char* pathBuffer, size_t bufferSize) char* pathBuffer, size_t bufferSize)
\ingroup libroot
\brief Retrieves a path in the file system layout based on a loaded image \brief Retrieves a path in the file system layout based on a loaded image
file. file.
@@ -1272,6 +1274,7 @@
\fn status_t find_path_etc(const void* codePointer, const char* dependency, \fn status_t find_path_etc(const void* codePointer, const char* dependency,
const char* architecture, path_base_directory baseDirectory, const char* architecture, path_base_directory baseDirectory,
const char* subPath, uint32 flags, char* pathBuffer, size_t bufferSize) const char* subPath, uint32 flags, char* pathBuffer, size_t bufferSize)
\ingroup libroot
\brief Retrieves a path in the file system layout based on a loaded image \brief Retrieves a path in the file system layout based on a loaded image
file. file.
@@ -1337,6 +1340,7 @@
\fn status_t find_path_for_path(const char* path, \fn status_t find_path_for_path(const char* path,
path_base_directory baseDirectory, const char* subPath, path_base_directory baseDirectory, const char* subPath,
char* pathBuffer, size_t bufferSize) char* pathBuffer, size_t bufferSize)
\ingroup libroot
\brief Retrieves a path in the file system layout based on a given path. \brief Retrieves a path in the file system layout based on a given path.
Based on the given path \a path the function evaluates \a baseDirectory. In Based on the given path \a path the function evaluates \a baseDirectory. In
@@ -1376,6 +1380,7 @@
const char* dependency, const char* architecture, const char* dependency, const char* architecture,
path_base_directory baseDirectory, const char* subPath, uint32 flags, path_base_directory baseDirectory, const char* subPath, uint32 flags,
char* pathBuffer, size_t bufferSize) char* pathBuffer, size_t bufferSize)
\ingroup libroot
\brief Retrieves a path in the file system layout based on a given path. \brief Retrieves a path in the file system layout based on a given path.
Based on the given path \a path the function evaluates \a baseDirectory. In Based on the given path \a path the function evaluates \a baseDirectory. In
@@ -1435,6 +1440,7 @@
/*! /*!
\fn status_t find_paths(path_base_directory baseDirectory, \fn status_t find_paths(path_base_directory baseDirectory,
const char* subPath, char*** _paths, size_t* _pathCount) const char* subPath, char*** _paths, size_t* _pathCount)
\ingroup libroot
\brief Retrieves a list of paths in the file system layout. \brief Retrieves a list of paths in the file system layout.
For each installation location -- in the order most specific to most For each installation location -- in the order most specific to most
@@ -1472,6 +1478,7 @@
\fn status_t find_paths_etc(const char* architecture, \fn status_t find_paths_etc(const char* architecture,
path_base_directory baseDirectory, const char* subPath, uint32 flags, path_base_directory baseDirectory, const char* subPath, uint32 flags,
char*** _paths, size_t* _pathCount) char*** _paths, size_t* _pathCount)
\ingroup libroot
\brief Retrieves a list of paths in the file system layout. \brief Retrieves a list of paths in the file system layout.
For each installation location -- in the order most specific to most For each installation location -- in the order most specific to most