feat: enhance metadata struct with detailed comments for clarity

Author: Katze719

include/cpp_core/interface/meta.h

@@ -14,24 +14,24 @@ extern "C"
      */
     struct Meta
     {
-        int major = version::MAJOR;
-        int minor = version::MINOR;
-        int patch = version::PATCH;
-        int commits_since_tag = version::GIT_COMMIT_COUNT;
-        int is_dirty = version::GIT_IS_DIRTY ? 1 : 0;
+        int major = version::MAJOR;                        ///< Semantic-version major component.
+        int minor = version::MINOR;                        ///< Semantic-version minor component.
+        int patch = version::PATCH;                        ///< Semantic-version patch component.
+        int commits_since_tag = version::GIT_COMMIT_COUNT; ///< Commits since the closest Git tag.
+        int is_dirty = version::GIT_IS_DIRTY ? 1 : 0;      ///< 1 for uncommitted changes, otherwise 0.
 
-        const char *version_string = version::VERSION;
-        const char *prerelease = version::PRERELEASE;
-        const char *prerelease_type = version::PRERELEASE_TYPE;
-        const char *prerelease_number = version::PRERELEASE_NUMBER;
+        const char *version_string = version::VERSION;              ///< Complete generated version string.
+        const char *prerelease = version::PRERELEASE;               ///< Prerelease identifier, or an empty string.
+        const char *prerelease_type = version::PRERELEASE_TYPE;     ///< Prerelease kind such as `alpha` or `rc`.
+        const char *prerelease_number = version::PRERELEASE_NUMBER; ///< Prerelease number, or an empty string.
 
-        const char *git_tag = version::GIT_TAG;
-        const char *git_describe_hash = version::GIT_DESCRIBE_HASH;
-        const char *git_commit_hash_short = version::GIT_COMMIT_HASH_SHORT;
-        const char *git_commit_hash_full = version::GIT_COMMIT_HASH_FULL;
-        const char *git_commit_date = version::GIT_COMMIT_DATE;
-        const char *git_branch = version::GIT_BRANCH;
-        const char *git_dirty_suffix = version::GIT_DIRTY_SUFFIX;
+        const char *git_tag = version::GIT_TAG;                     ///< Closest Git tag.
+        const char *git_describe_hash = version::GIT_DESCRIBE_HASH; ///< Hash component reported by Git describe.
+        const char *git_commit_hash_short = version::GIT_COMMIT_HASH_SHORT; ///< Abbreviated commit hash.
+        const char *git_commit_hash_full = version::GIT_COMMIT_HASH_FULL;   ///< Full commit hash.
+        const char *git_commit_date = version::GIT_COMMIT_DATE;             ///< Commit timestamp including timezone.
+        const char *git_branch = version::GIT_BRANCH;                       ///< Branch name used for the build.
+        const char *git_dirty_suffix = version::GIT_DIRTY_SUFFIX;           ///< `-dirty` or an empty string.
     };
     } // namespace cpp_core