Merge pull request #7 from nekernel-org/dev

feat: new documented codebase and improvements.

1 files changed, 12 insertions, 6 deletions

diff --git a/dev/BuildKit/JSONManifestBuilder.h b/dev/BuildKit/JSONManifestBuilder.h
index 81643e3..438bdab 100644
--- a/dev/BuildKit/JSONManifestBuilder.h
+++ b/dev/BuildKit/JSONManifestBuilder.h
@@ -22,12 +22,18 @@ class JSONManifestBuilder final NEBUILD_MANIFEST_BUILDER {
   JSONManifestBuilder(const JSONManifestBuilder&)            = default;
 
  public:
-  /// @brief Builds a JSON target.
-  /// @param arg_sz filename size
-  /// @param arg_val filename path.
-  /// @retval true build succeeded.
-  /// @retval false failed to build.
-  bool        BuildTarget(const std::string& arg_val, const bool dry_run = false) override;
+  /// =========================================================== ///
+  /// @brief Builds a JSON target from a JSON file.
+  /// @param arg_sz filename size (must be 1 or greater).
+  /// @param arg_val filename path (must be a valid JSON file).
+  /// @retval true building has succeeded.
+  /// @retval false fail to build, see error message.
+  /// =========================================================== ///
+  bool BuildTarget(const std::string& arg_val, const bool dry_run = false) override;
+
+  /// =========================================================== ///
+  /// @brief Returns the build system name.
+  /// =========================================================== ///
   const char* BuildSystem() override;
 };
 }  // namespace NeBuild
\ No newline at end of file