Updated documentation and added new functions

Author: NewYaroslav

include/time_shield_cpp/parts/constants.hpp

@@ -11,6 +11,23 @@
 
 namespace time_shield {
 
+/// \defgroup time_constants Time Constants
+/// \brief A collection of constants for time calculations and conversions.
+///
+/// This group includes constants for time units (nanoseconds, microseconds, milliseconds, seconds, minutes, hours, days),
+/// and other values related to the representation of time, such as UNIX and OLE epochs.
+///
+/// ### Key Features:
+/// - Provides constants for common time conversions.
+/// - Includes limits and special values like MAX_YEAR and ERROR_YEAR.
+///
+/// ### Example Usage:
+/// ```cpp
+/// int64_t milliseconds_in_a_day = time_shield::MS_PER_DAY;
+/// ```
+///
+/// \{
+
     // Nanoseconds and microseconds
     constexpr int64_t NS_PER_US     = 1000;         ///< Nanoseconds per microsecond
     constexpr int64_t NS_PER_MS     = 1000000;      ///< Nanoseconds per millisecond
@@ -87,6 +104,8 @@ namespace time_shield {
     constexpr double MAX_OADATE         = std::numeric_limits<double>::max();   ///< Maximum OLE automation date
     constexpr double AVG_DAYS_PER_YEAR  = 365.25;   ///< Average days per year
 
+/// \}
+
 }; // namespace time_shield
 
 #endif // _TIME_SHIELD_CONSTANTS_HPP_INCLUDED

include/time_shield_cpp/parts/date_struct.hpp

@@ -8,22 +8,24 @@
 
 namespace time_shield {
 
+    /// \ingroup time_structures
     /// \brief Structure to represent a date.
     struct DateStruct {
         int64_t year;   ///< Year component of the date.
-        int     mon;    ///< Month component of the date (1-12).
-        int     day;    ///< Day component of the date (1-31).
+        int32_t mon;    ///< Month component of the date (1-12).
+        int32_t day;    ///< Day component of the date (1-31).
     };
 
+    /// \ingroup time_structures
     /// \brief Creates a DateStruct instance.
     /// \param year The year component of the date.
     /// \param mon The month component of the date, defaults to 1 (January).
     /// \param day The day component of the date, defaults to 1.
     /// \return A DateStruct instance with the provided date components.
     inline const DateStruct create_date_struct(
             int64_t year,
-            int mon = 1,
-            int day = 1) {
+            int32_t mon = 1,
+            int32_t day = 1) {
         DateStruct data{year, mon, day};
         return data;
     }

include/time_shield_cpp/parts/date_time_struct.hpp

@@ -8,6 +8,7 @@
 
 namespace time_shield {
 
+    /// \ingroup time_structures
     /// \brief Structure to represent date and time.
     struct DateTimeStruct {
         int64_t year;   ///< Year component of the date.
@@ -19,6 +20,7 @@ namespace time_shield {
         int     ms;     ///< Millisecond component of time (0-999)
     };
 
+    /// \ingroup time_structures
     /// \brief Creates a DateTimeStruct instance.
     /// \param year The year component of the date.
     /// \param mon The month component of the date, defaults to 1 (January).

include/time_shield_cpp/parts/enums.hpp

@@ -11,6 +11,24 @@
 
 namespace time_shield {
 
+/// \defgroup time_enums Time Enumerations
+/// \brief Enumerations for time-related concepts.
+///
+/// This group contains various enums that represent time-related concepts such as
+/// weekdays, months, time zones, and formatting options.
+///
+/// ### Key Features:
+/// - Defines enumerations for consistent handling of weekdays, months, and other time units.
+/// - Provides utility functions for converting enum values to string representations.
+///
+/// ### Example Usage:
+/// ```cpp
+/// auto weekday = time_shield::Weekday::MON;
+/// std::cout << time_shield::to_cstr(weekday, time_shield::FormatType::FULL_NAME); // "Monday"
+/// ```
+///
+/// \{
+
     /// Enumeration of the format options for representing a weekday or month.
     enum FormatType {
         UPPERCASE_NAME = 0, ///< Uppercase short name
@@ -255,6 +273,8 @@ namespace time_shield {
         EUROPEAN_TIME,        ///< European time format (e.g., "12:30")
     };
 
+/// \}
+
 }; // namespace time_shield
 
 #endif // _TIME_SHIELD_ENUMS_HPP_INCLUDED