Refactoring code for better documentation.

Signed-off-by: Amlal EL Mahrouss <amlalelmahrouss@icloud.com>

6 files changed, 23 insertions, 15 deletions

diff --git a/dev/ToolchainKit/AAL/Asm.h b/dev/ToolchainKit/AAL/AssemblyInterface.h
index 88173f4..8a7eb9d 100644
--- a/dev/ToolchainKit/AAL/Asm.h
+++ b/dev/ToolchainKit/AAL/AssemblyInterface.h
@@ -12,9 +12,8 @@
 
 namespace ToolchainKit
 {
-	//
-	//	@brief Frontend to Assembly mountpoint.
-	//
+	///	@brief Assembly to binary generator class.
+	/// @note This interface creates according to the CPU target of the child class.
 	class AssemblyInterface
 	{
 	public:
@@ -23,8 +22,8 @@ namespace ToolchainKit
 
 		TOOLCHAINKIT_COPY_DEFAULT(AssemblyInterface);
 
-		//@ brief compile to object file.
-		// Example C++ -> MASM -> AE object.
+		/// @brief compile to object file.
+		/// @note Example C++ -> MASM -> AE object.
 		virtual Int32 CompileToFormat(std::string& src, Int32 arch) = 0;
 	};
 
@@ -57,17 +56,20 @@ namespace ToolchainKit
 		AssemblyInterface* fMounted{nullptr};
 	};
 
-	union NumberCastBase {
+	union NumberCastBase
+	{
 		NumberCastBase()  = default;
 		~NumberCastBase() = default;
 	};
 
-	union NumberCast64 final {
+	union NumberCast64 final
+	{
 		NumberCast64() = default;
 		explicit NumberCast64(UInt64 raw)
 			: raw(raw)
 		{
 		}
+
 		~NumberCast64()
 		{
 			raw = 0;
@@ -77,12 +79,14 @@ namespace ToolchainKit
 		UInt64	 raw;
 	};
 
-	union NumberCast32 final {
+	union NumberCast32 final
+	{
 		NumberCast32() = default;
 		explicit NumberCast32(UInt32 raw)
 			: raw(raw)
 		{
 		}
+
 		~NumberCast32()
 		{
 			raw = 0;
@@ -92,12 +96,14 @@ namespace ToolchainKit
 		UInt32	 raw;
 	};
 
-	union NumberCast16 final {
+	union NumberCast16 final
+	{
 		NumberCast16() = default;
 		explicit NumberCast16(UInt16 raw)
 			: raw(raw)
 		{
 		}
+
 		~NumberCast16()
 		{
 			raw = 0;
@@ -107,12 +113,14 @@ namespace ToolchainKit
 		UInt16	 raw;
 	};
 
-	union NumberCast8 final {
+	union NumberCast8 final
+	{
 		NumberCast8() = default;
 		explicit NumberCast8(UInt8 raw)
 			: raw(raw)
 		{
 		}
+
 		~NumberCast8()
 		{
 			raw = 0;
diff --git a/dev/ToolchainKit/Parser.h b/dev/ToolchainKit/Parser.h
index c8d6f2a..a8631e9 100644
--- a/dev/ToolchainKit/Parser.h
+++ b/dev/ToolchainKit/Parser.h
@@ -6,7 +6,7 @@
 
 #pragma once
 
-#include <ToolchainKit/AAL/Asm.h>
+#include <ToolchainKit/AAL/AssemblyInterface.h>
 #include <vector>
 
 namespace ToolchainKit
diff --git a/dev/ToolchainKit/src/AssemblyFactory.cc b/dev/ToolchainKit/src/AssemblyFactory.cc
index f6916ba..884ad22 100644
--- a/dev/ToolchainKit/src/AssemblyFactory.cc
+++ b/dev/ToolchainKit/src/AssemblyFactory.cc
@@ -4,7 +4,7 @@
 
 ------------------------------------------- */
 
-#include <ToolchainKit/AAL/Asm.h>
+#include <ToolchainKit/AAL/AssemblyInterface.h>
 #include <ToolchainKit/NFC/ErrorID.h>
 
 /**
diff --git a/dev/ToolchainKit/src/Detail/AsmUtils.h b/dev/ToolchainKit/src/Detail/AsmUtils.h
index dcd7834..19d863f 100644
--- a/dev/ToolchainKit/src/Detail/AsmUtils.h
+++ b/dev/ToolchainKit/src/Detail/AsmUtils.h
@@ -6,7 +6,7 @@
 
 #pragma once
 
-#include <ToolchainKit/AAL/Asm.h>
+#include <ToolchainKit/AAL/AssemblyInterface.h>
 #include <ToolchainKit/Parser.h>
 
 using namespace ToolchainKit;
diff --git a/dev/ToolchainKit/src/Detail/ClUtils.h b/dev/ToolchainKit/src/Detail/ClUtils.h
index 2bf17f2..ca209f2 100644
--- a/dev/ToolchainKit/src/Detail/ClUtils.h
+++ b/dev/ToolchainKit/src/Detail/ClUtils.h
@@ -6,7 +6,7 @@
 
 #pragma once
 
-#include <ToolchainKit/AAL/Asm.h>
+#include <ToolchainKit/AAL/AssemblyInterface.h>
 #include <ToolchainKit/Parser.h>
 
 #define kZero64Section ".zero64"
diff --git a/dev/ToolchainKit/src/DynamicLinker64PEF.cc b/dev/ToolchainKit/src/DynamicLinker64PEF.cc
index d127376..0b5749d 100644
--- a/dev/ToolchainKit/src/DynamicLinker64PEF.cc
+++ b/dev/ToolchainKit/src/DynamicLinker64PEF.cc
@@ -19,7 +19,7 @@
 #include <ToolchainKit/NFC/ErrorID.h>
 
 //! Assembler Kit
-#include <ToolchainKit/AAL/Asm.h>
+#include <ToolchainKit/AAL/AssemblyInterface.h>
 
 //! Preferred Executable Format
 #include <ToolchainKit/NFC/PEF.h>