summaryrefslogtreecommitdiffhomepage
path: root/dev/BuildKit/IManifestBuilder.h
diff options
context:
space:
mode:
Diffstat (limited to 'dev/BuildKit/IManifestBuilder.h')
-rw-r--r--dev/BuildKit/IManifestBuilder.h24
1 files changed, 16 insertions, 8 deletions
diff --git a/dev/BuildKit/IManifestBuilder.h b/dev/BuildKit/IManifestBuilder.h
index 8f9b2cf..abb389f 100644
--- a/dev/BuildKit/IManifestBuilder.h
+++ b/dev/BuildKit/IManifestBuilder.h
@@ -7,11 +7,13 @@
#include <BuildKit/Defines.h>
-#define NEBUILD_MANIFEST_BUILDER : public NeBuild::IManifestBuilder
+#define NEBUILD_MANIFEST_BUILDER : public ::NeBuild::IManifestBuilder
namespace NeBuild {
+/// =========================================================== ///
/// @brief Builder interface class.
/// @note This class is meant to be used as an interface.
+/// =========================================================== ///
class IManifestBuilder {
public:
IManifestBuilder() = default;
@@ -20,12 +22,18 @@ class IManifestBuilder {
IManifestBuilder& operator=(const IManifestBuilder&) = default;
IManifestBuilder(const IManifestBuilder&) = default;
- /// @brief Builds a target using the implemented laguage.
- /// @param arg_sz filename size
- /// @param arg_val filename path.
- /// @retval true succeeded.
- /// @retval false failed.
- virtual bool BuildTarget(const std::string& arg, const bool dry_run = false) = 0;
- virtual const char* BuildSystem() = 0;
+ /// =========================================================== ///
+ /// @brief Builds a TOML target from a file.
+ /// @param arg_sz filename size (must be 1 or greater).
+ /// @param arg_val filename path (must be a valid language file).
+ /// @retval true building has succeeded.
+ /// @retval false fail to build, see error message.
+ /// =========================================================== ///
+ virtual bool BuildTarget(const std::string& arg, const bool dry_run = false) = 0;
+
+ /// =========================================================== ///
+ /// @brief Returns the build system name.
+ /// =========================================================== ///
+ virtual const char* BuildSystem() = 0;
};
} // namespace NeBuild \ No newline at end of file