Version 2.0.0

- Changed CLI option --mode,-m to --algorithm,-a
- Fix check for updates bug reports false new version
- Proceeded Doxygen Documentation (~0.60% Documented)

CHANGELOG.md

@@ -1,5 +1,7 @@
 # 2.0.0
 - Changed CLI option --mode,-m to --algorithm,-a
+- Fix check for updates bug
+- Proceeded Doxygen Documentation (~0.60% Documented)
 
 
 # 1.4.0

Source/Algorithm/Algorithm.hpp

@@ -54,8 +54,8 @@ class ENIGMA_API Algorithm
 	/**
 	*	Intention of creating an instance of an Algorithm.
 	* 
-	*	to not initialize resources not needed for an operation.
-	*	(like when encrypting, we initialize a random seeder which is not needed
+	*	helps to avoid initializing resources not needed for an specific operation.
+	*	(for example when encrypting, we initialize a random seeder which is not needed
 	*   when decrypting)
 	*/
 	enum class Intent : byte

Source/Core/Macros.hpp

@@ -182,19 +182,19 @@ do { \
 ///
 
 
-//void TimedFunction(
+//static void TimedFunction(
 //	const std::function<void()>& onStart,
 //	const std::function<void()>& func,
-//	const std::function<void(double)>& onFinish)
+//	const std::function<void(::Enigma::f64)>& onFinish)
 //{
 //	onStart();
 //	ENIGMA_BEGIN_TIMER(t1);
 //		func();
-//	auto elapsed = ENIGMA_END_TIMER(t1, double, std::milli) / 1000.0;
+//	::Enigma::f64 elapsed = ENIGMA_END_TIMER(t1, double, std::milli) / 1000.0;
 //	onFinish(elapsed);
 //}
-//
-//
+
+
 
 
 #endif // !ENIGMA_MACROS_H

Source/Core/Platform.hpp

@@ -2,7 +2,7 @@
 #ifndef ENIGMA_PLATFORM_H
 #define ENIGMA_PLATFORM_H
 
-/*
+/**
 *	Detects current platform
 */
 

Source/Core/Version.hpp

@@ -2,11 +2,11 @@
 #ifndef ENIGMA_VERSION_H
 #define ENIGMA_VERSION_H
 
-// major, minor, patch string (needed for Enigma.rc)
-#define ENIGMA_VERSION_STR "1.4.0"
+/** major, minor, patch string(needed for Enigma.rc) */
+#define ENIGMA_VERSION_STR "2.0.0"
 
-// major, minor, patch divided (needed for Enigma.rc)
-#define ENIGMA_VERSION_DIV 1, 4, 0
+/**  major, minor, patch divided (needed for Enigma.rc) */
+#define ENIGMA_VERSION_DIV 2, 0, 0
 
 #define ENIGMA_VERSION ENIGMA_VERSION_STR
 

Source/Database/Database.hpp

@@ -17,7 +17,8 @@
 
 
 NS_ENIGMA_BEGIN
-/*
+
+/**
 * Enigma SQLite database to store and retrieve encryption records
 * User can export and import Database file to clouds or drives
 * Database file will store Encrypted Text and Encrypted Files ciphers and other info
@@ -27,6 +28,7 @@ class ENIGMA_API Database final
 	ENIGMA_STATIC_CLASS(Database);
 
  public:
+	/** Encryption Table order by column */
 	enum class OrderBy : byte
 	{
 		ID,
@@ -36,7 +38,8 @@ class ENIGMA_API Database final
 
 		ENIGMA_ENUM_DECLARE_BEGIN_END(ID)
 	};
-	friend const char* operator *(OrderBy order_by) // operator* to stringify enum OrderBy
+	/** To help stringify enum OrderBy */
+	friend const char* operator *(OrderBy order_by) 
 	{
 #define CASE_STR(e) case OrderBy::e: return #e
 		switch (order_by)
@@ -60,14 +63,16 @@ class ENIGMA_API Database final
 		}
 		return os;
 	}
+	/** Encryption Table order column */
 	enum class Order : byte
 	{
 		Ascending,
 		Descending,
 
 		ENIGMA_ENUM_DECLARE_BEGIN_END(Ascending)
 	};
-	friend const char* operator *(Order order) // operator* to stringify enum Order
+	/** To help stringify enum Order */
+	friend const char* operator *(Order order)
 	{
 #define CASE_STR(e) case Order::e: return #e
 		switch (order)
@@ -84,23 +89,25 @@ class ENIGMA_API Database final
 	}
 
 public:
+	/** Initializes SQLite database connection */
 	static void Initialize();
+	/** Shuts down SQLite connection */
 	static void Shutdown();
 
 public: // Encryption Operations
-	// Add Encryption to Encryptions table, returns true on success
+	/** Add Encryption to Encryptions table, returns true on success */
 	static bool AddEncryption(const std::unique_ptr<Encryption>& e);
 
-	// Returns cipher from database by encryption id
+	/** Returns cipher from database by encryption id */
 	static std::unique_ptr<Cipher> GetCipherByEncryptionID(const i64 ide);
 
-	// Delete Encryption record by id, returns true if successfully deleted
+	/** Delete Encryption record by id, returns true if successfully deleted */
 	static bool DeleteEncryption(const i64 ide);
 
-	// Delete all saved encryptions from the database (with their cipher)
+	/** Delete all saved encryptions from the database (with their cipher) */
 	static bool DeleteAllEncryptions();
 
-	// Returns how many encryption records are saved
+	/** Returns how many encryption records are saved */
 	static i64 GetEncryptionsCount();
 
 #if 0
@@ -157,7 +164,7 @@ class ENIGMA_API Database final
 	}
 #endif
 
-	// Get an Encyrption by id with desired columns for optimization
+	/** Get an Encyrption by id with desired columns for optimization */
 	template<const bool title, const bool cipher, const bool date_time, const bool size, const bool is_file>
 	inline static std::unique_ptr<Encryption> GetEncryptionByID(const i64 ide)
 	{
@@ -214,7 +221,7 @@ class ENIGMA_API Database final
 		}
 	}
 
-	// Get all Encryptions with desired columns for optimization
+	/** Get all Encryptions with desired columns for optimization */
 	template<const bool title, const bool cipher, const bool date_time, const bool size, const bool is_file>
 	inline static std::vector<std::unique_ptr<Encryption>> GetAllEncryptions(OrderBy order_by = OrderBy::ID, Order order = Order::Descending)
 	{			
@@ -275,7 +282,7 @@ class ENIGMA_API Database final
 	}
 
 
-	// Search Encryptions by title using keyword LIKE %QUERY%
+	/** Search Encryptions by title using keyword LIKE %QUERY% */
 	template<const bool title, const bool cipher, const bool date_time, const bool size, const bool is_file> // select which columns to return (for optimization)
 	inline static std::vector<std::unique_ptr<Encryption>> SearchEncryptionsByTitle(const String& qtitle, OrderBy order_by = OrderBy::ID, Order order = Order::Descending)
 	{
@@ -337,15 +344,17 @@ class ENIGMA_API Database final
 
 
 public: // Accessors
+	/** Returns SQLite database connection instance */
 	static const std::unique_ptr<SQLite::Database>& GetInstance() noexcept { return m_database; }
 
 
 public: // Modifiers
-	/*
-	*	https://www.sqlitetutorial.net/sqlite-vacuum/
+	/**	
 	*	Cleans up allocated disk space for deleted data, blob...
+	*
 	*	When you insert or delete data from the tables, the indexes and tables become fragmented, 
 	*	especially for the database that has a high number of inserts, updates, and deletes.
+	*	@note https://www.sqlitetutorial.net/sqlite-vacuum/
 	*/
 	static void Vacuum() noexcept 
 	{
@@ -361,20 +370,20 @@ class ENIGMA_API Database final
 		}
 		//else
 		//	ENIGMA_INFO("No database changes were made, skipping vacuum disk optimization.");
-
-
 	}
 
 
 
 private:
-	inline static std::unique_ptr<SQLite::Database> m_database{ nullptr }; // Database connection configuered on Initialize()
+	inline static std::unique_ptr<SQLite::Database> m_database{ nullptr }; /**< Database connection configuered on Initialize() */
 };
+
 /*
 Notes:
 for bind, use index starts by 1
 for getColumn, use index starts by 0
 */
+
 NS_ENIGMA_END
 #endif // !ENIGMA_DATABASE_H
 

Source/Database/Models/Cipher.hpp

@@ -6,12 +6,14 @@
 
 NS_ENIGMA_BEGIN
 
-// Cipher Model | table: Cipher
+/**
+*	Cipher Model | table: Cipher
+*/
 struct Cipher
 {
-	i64 idc{}; // auto incremental id
-	String data{}; // BLOB compressed text or file binary cipher
-	i64 ide{}; // foreign key references Encryption(id)
+	i64 idc{}; /**< auto incremental id */
+	String data{}; /**< BLOB compressed text or file binary cipher */
+	i64 ide{}; /**< foreign key references Encryption(id) */
 
 	~Cipher() noexcept
 	{

Source/Database/Models/Encryption.hpp

@@ -9,15 +9,17 @@
 
 NS_ENIGMA_BEGIN
 
-// Encryption Model | table: Encryption
+/**
+*	Encryption Model | Table: Encryption
+*/
 struct Encryption
 {
-	i64 ide{}; // auto incremental id 0 -> SIZE_MAX
-	String title{}; // E.G: "this is my gmail password"
-	Cipher cipher{}; 
-	String date_time{}; // date & time saved by sqlite3
-	i64 size{}; // size of compressed cipher in bytes
-	bool is_file{}; // whether its a text or file encryption
+	i64 ide{};  /**< auto incremental id in range [0, SIZE_MAX] */
+	String title{}; /**< encryption title, e.g: "this is my gmail password" */
+	Cipher cipher{}; /**< encryption encrypted data, aka cipher. from another table for perfermance reasons */
+	String date_time{}; /**< date & time saved by sqlite3 */
+	i64 size{}; /**< size of compressed cipher in bytes */
+	bool is_file{}; /**< whether its a text or file encryption */
 
 	~Encryption() noexcept
 	{

Source/Enigma.hpp

@@ -15,9 +15,6 @@
 #include <Config/Config.hpp>
 //
 
-// Enigma Language Translator
-//#include <Translation/Translation.hpp>
-//
 
 // System Dialogs, Notification, Clipboard, Environment Variable
 #include <System/Dialogs/MessageBox.hpp>

Source/Events/ApplicationEvent.hpp

@@ -11,6 +11,7 @@
 
 NS_ENIGMA_BEGIN
 
+/** Window size changed Event */
 class WindowResizeEvent : public Event
 {
 public:
@@ -37,6 +38,7 @@ class WindowResizeEvent : public Event
 	i32 m_width, m_height;
 };
 
+/** Frame buffer size changed Event */
 class FrameBufferResizeEvent : public Event
 {
 public:
@@ -63,6 +65,7 @@ class FrameBufferResizeEvent : public Event
 	i32 m_width, m_height;
 };
 
+/** Window position changed Event */
 class WindowMoveEvent : public Event
 {
 public:
@@ -88,6 +91,7 @@ class WindowMoveEvent : public Event
 	i32 m_xPos, m_yPos;
 };
 
+/** Window maximized Event */
 class WindowMaximizedEvent : public Event
 {
 public:
@@ -111,6 +115,7 @@ class WindowMaximizedEvent : public Event
 	bool m_isMaximized;
 };
 
+/** Window lost focus Event */
 class WindowFocusLostEvent : public Event
 {
 public:
@@ -119,6 +124,7 @@ class WindowFocusLostEvent : public Event
 	EVENT_CLASS_CATEGORY(EventCategory::APPLICATION);
 };
 
+/** Window gain focus Event */
 class WindowFocusEvent : public Event
 {
 public:
@@ -127,6 +133,7 @@ class WindowFocusEvent : public Event
 	EVENT_CLASS_CATEGORY(EventCategory::APPLICATION);
 };
 
+/** Window close button pressed Event */
 class WindowCloseEvent : public Event
 {
 public:
@@ -136,6 +143,7 @@ class WindowCloseEvent : public Event
 	EVENT_CLASS_CATEGORY(EventCategory::APPLICATION);
 };
 
+/** Files dropped over window Event */
 class WindowFileDropEvent : public Event
 {
 public:
@@ -153,6 +161,7 @@ class WindowFileDropEvent : public Event
 	std::vector<fs::path> m_filenames;
 };
 
+/** Application main loop tick Update Event */
 class AppUpdateEvent : public Event
 {
 public:
@@ -162,6 +171,7 @@ class AppUpdateEvent : public Event
 	EVENT_CLASS_CATEGORY(EventCategory::APPLICATION);
 };
 
+/** Application main loop tick Draw Event */
 class AppRenderEvent : public Event
 {
 public:
@@ -171,6 +181,7 @@ class AppRenderEvent : public Event
 	EVENT_CLASS_CATEGORY(EventCategory::APPLICATION);
 };
 
+/** Application main loop tick Event */
 class AppTickEvent : public Event
 {
 public:

Source/Events/EventDispatcher.hpp

@@ -10,6 +10,8 @@
 #include "Event.hpp"
 
 NS_ENIGMA_BEGIN
+
+/** Event dispatcher to dispatch specific desired events */
 class ENIGMA_API EventDispatcher
 {
 	template<typename T>

Source/Events/KeyEvent.hpp

@@ -10,6 +10,7 @@
 
 NS_ENIGMA_BEGIN
 
+/** Keyboard buttons Event */
 class KeyEvent : public Event
 {
 public:
@@ -26,6 +27,7 @@ class KeyEvent : public Event
 	KeyCode m_key_code;
 };
 
+/** Keyboard button press Event */
 class KeyPressedEvent : public KeyEvent
 {
 public:
@@ -49,6 +51,7 @@ class KeyPressedEvent : public KeyEvent
 	ui16 m_repeat_count;
 };
 
+/** Keyboard button release Event */
 class KeyReleasedEvent : public KeyEvent
 {
 public:
@@ -67,6 +70,7 @@ class KeyReleasedEvent : public KeyEvent
 	EVENT_CLASS_TYPE(EventType::KEY_RELEASED)
 };
 
+/** Keyboard button type Event */
 class KeyTypedEvent : public KeyEvent
 {
 public: