summaryrefslogtreecommitdiffhomepage
path: root/dev/BuildKit/TOMLManifestBuilder.h
diff options
context:
space:
mode:
Diffstat (limited to 'dev/BuildKit/TOMLManifestBuilder.h')
-rw-r--r--dev/BuildKit/TOMLManifestBuilder.h18
1 files changed, 12 insertions, 6 deletions
diff --git a/dev/BuildKit/TOMLManifestBuilder.h b/dev/BuildKit/TOMLManifestBuilder.h
index 6baa9f5..7c508fc 100644
--- a/dev/BuildKit/TOMLManifestBuilder.h
+++ b/dev/BuildKit/TOMLManifestBuilder.h
@@ -22,12 +22,18 @@ class TOMLManifestBuilder final NEBUILD_MANIFEST_BUILDER {
TOMLManifestBuilder(const TOMLManifestBuilder&) = default;
public:
- /// @brief Builds a TOML 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 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.
+ /// =========================================================== ///
+ 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