From 4a105e155c651d20ae1ab9effe28633e3940d0b2 Mon Sep 17 00:00:00 2001 From: Hossein Moein Date: Sun, 23 Jun 2024 10:21:32 -0400 Subject: [PATCH] Fixed DateTime doc html --- docs/HTML/DateTime.html | 29 +++++++++++++++++++---------- 1 file changed, 19 insertions(+), 10 deletions(-) diff --git a/docs/HTML/DateTime.html b/docs/HTML/DateTime.html index f34192df..10506e8b 100644 --- a/docs/HTML/DateTime.html +++ b/docs/HTML/DateTime.html @@ -136,7 +136,8 @@

Types

ISO_DT_NANO = 14, // e.g. 2015-05-05 13:51:04.123456789 }; -
+
+ These are the available time zones, used in a few methods and constructors.
    enum class DT_TIME_ZONE : short int  {
         LOCAL = -2,
@@ -173,7 +174,8 @@ 
Types

         EU_BUDAPEST = 30
     };
-
+
+ Week days: 1 - 7 (Sunday - Saturday), used by various methods:
    enum class DT_WEEKDAY : unsigned char  {
         BAD_DAY = 0,
@@ -186,7 +188,8 @@ 
Types

         SAT = 7
     };
-
+
+ Months: 1 - 12 (January - December), used by various methods:
    enum class DT_MONTH : unsigned char  {
         BAD_MONTH = 0,
@@ -204,16 +207,18 @@ 
Types

         DEC = 12
     };
-
+
+ These constants are used for parsing data:
    enum class DT_DATE_STYLE : unsigned char  {
         YYYYMMDD = 1,
         AME_STYLE = 2,  // MM/DD/YYYY
         EUR_STYLE = 3,  // YYYY/MM/DD
         ISO_STYLE = 3.  // YYYY-MM-DD
-    };
+    };
+ +
-
Types used in DateTime class:
    using DateType = unsigned int;            // YYYYMMDD
     using DatePartType = unsigned short int;  // year, month etc.
@@ -226,6 +231,8 @@ 
Types

     using EpochType = time_t;                 // Signed epoch
     using LongTimeType = long long int;       // Nano seconds since epoch
+
+ This table lists the 3-letter abbreviations for allowable time zones that can appear
in strings parsed by DateTime constructor or assignment operator:
inline static const
 std::unordered_map<std::string_view, DT_TIME_ZONE>  ZONE_STR_TO_TIME_ZONE  {
@@ -261,9 +268,11 @@ 
Types

     { "OSL", DT_TIME_ZONE::EU_OSLO },
     { "WAW", DT_TIME_ZONE::EU_WARSAW },
     { "BUD", DT_TIME_ZONE::EU_BUDAPEST },
-};
-
-

Member Functions

+}; + +
+ +

Member Functions

    // A constructor that creates a DateTime initialized to now.
     // tz: Desired time zone from DT_TIME_ZONE above.
     //
@@ -430,7 +439,7 @@ 
Member Functions

     //
     std::string string_format(DT_FORMAT format) const;
-
+

Global DateTime Operators

 template<typename S>