feat: better documentation of builder objects.

Signed-off-by: Amlal El Mahrouss <amlal@nekernel.org>

2 files changed, 2 insertions, 4 deletions

diff --git a/src/lib/JSONManifestBuilder.cc b/src/lib/JSONManifestBuilder.cc
index 8cb126f..bda523c 100644
--- a/src/lib/JSONManifestBuilder.cc
+++ b/src/lib/JSONManifestBuilder.cc
@@ -15,8 +15,7 @@ namespace FS = std::filesystem;
 /// @brief Builds a nlohmann::json target from a nlohmann::json file.
 /// @param arg_sz filename size (must be 1 or greater).
 /// @param arg_val filename path (must be a valid nlohmann::json file).
-/// @retval true building has succeeded.
-/// @retval false fail to build, see error message.
+/// @return bool: whether the build has succeeded or not.
 /// =========================================================== ///
 bool JSONManifestBuilder::BuildTarget(BuildConfig& config) {
   std::string path;
diff --git a/src/lib/TOMLManifestBuilder.cc b/src/lib/TOMLManifestBuilder.cc
index 81814b8..a7eb0de 100644
--- a/src/lib/TOMLManifestBuilder.cc
+++ b/src/lib/TOMLManifestBuilder.cc
@@ -15,8 +15,7 @@ namespace FS = std::filesystem;
 /// @brief Builds a TOML target from a TOML file.
 /// @param arg_sz filename size (must be 1 or greater).
 /// @param arg_val filename path (must be a valid TOML file).
-/// @retval true building has succeeded.
-/// @retval false fail to build, see error message.
+/// @return bool: whether the build has succeeded or not.
 /// =========================================================== ///
 bool TOMLManifestBuilder::BuildTarget(BuildConfig& config) {
   std::string path;