From 0e061f0903ef57f6877aa4695a651425bf9c2e33 Mon Sep 17 00:00:00 2001
From: Adrien Destugues <adrien.destugues@opensource.viveris.fr>
Date: Wed, 13 Jan 2021 12:47:28 +0100
Subject: [PATCH] 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
---
 docs/user/storage/FindDirectory.dox | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

diff --git a/docs/user/storage/FindDirectory.dox b/docs/user/storage/FindDirectory.dox
index 3f9c760b90..1ba33a7b3f 100644
--- a/docs/user/storage/FindDirectory.dox
+++ b/docs/user/storage/FindDirectory.dox
@@ -16,7 +16,6 @@
 /*!
 	\file FindDirectory.h
 	\ingroup storage
-	\ingroup libbe
 	\brief Provides the find_directory(), find_path(), find_paths() functions
 	       as well as the \c directory_which constants.
 
@@ -1203,6 +1202,7 @@
 /*!
 	\fn status_t find_directory(directory_which which, dev_t volume,
 		bool createIt, char* pathString, int32 length)
+	\ingroup libroot
 	\brief C interface to find_directory
 
 	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,
 		BVolume* volume)
+	\ingroup libbe
 	\brief C++ interface to find_directory
 
 	Set \a path to \a which on \a volume.
@@ -1228,6 +1229,7 @@
 	\fn status_t find_path(const void* codePointer,
 		path_base_directory baseDirectory, const char* subPath,
 		char* pathBuffer, size_t bufferSize)
+	\ingroup libroot
 	\brief Retrieves a path in the file system layout based on a loaded image
 	       file.
 
@@ -1272,6 +1274,7 @@
 	\fn status_t find_path_etc(const void* codePointer, const char* dependency,
 		const char* architecture, path_base_directory baseDirectory,
 		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
 	       file.
 
@@ -1337,6 +1340,7 @@
 	\fn status_t find_path_for_path(const char* path,
 		path_base_directory baseDirectory, const char* subPath,
 		char* pathBuffer, size_t bufferSize)
+	\ingroup libroot
 	\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
@@ -1376,6 +1380,7 @@
 		const char* dependency, const char* architecture,
 		path_base_directory baseDirectory, const char* subPath, uint32 flags,
 		char* pathBuffer, size_t bufferSize)
+	\ingroup libroot
 	\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
@@ -1435,6 +1440,7 @@
 /*!
 	\fn status_t find_paths(path_base_directory baseDirectory,
 		const char* subPath, char*** _paths, size_t* _pathCount)
+	\ingroup libroot
 	\brief Retrieves a list of paths in the file system layout.
 
 	For each installation location -- in the order most specific to most
@@ -1472,6 +1478,7 @@
 	\fn status_t find_paths_etc(const char* architecture,
 		path_base_directory baseDirectory, const char* subPath, uint32 flags,
 		char*** _paths, size_t* _pathCount)
+	\ingroup libroot
 	\brief Retrieves a list of paths in the file system layout.
 
 	For each installation location -- in the order most specific to most