From c3c9982ddc03331ceb7614b0b2a108c11ee283d1 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E2=97=B1=20PixelyIon?= <pixelyion@protonmail.com>
Date: Fri, 27 Mar 2020 19:43:30 +0530
Subject: [PATCH] Add Comments to Time Services + Fix IDE Case Conventions

This commit mainly just adds comments to parts of time services and fixes the case conventions in Android Studio.
---
 .idea/codeStyles/Project.xml                  | 15 +++++++++++++
 .../services/timesrv/ITimeZoneService.h       | 22 +++++++++----------
 2 files changed, 26 insertions(+), 11 deletions(-)

diff --git a/.idea/codeStyles/Project.xml b/.idea/codeStyles/Project.xml
index f4faad14..eb8821ea 100644
--- a/.idea/codeStyles/Project.xml
+++ b/.idea/codeStyles/Project.xml
@@ -51,6 +51,21 @@
         <pair source="cpp" header="h" fileNamingConvention="PASCAL_CASE" />
         <pair source="cpp" header="h" fileNamingConvention="NONE" />
       </extensions>
+      <rules>
+        <rule entity="NAMESPACE" visibility="ANY" specifier="ANY" prefix="" style="CAMEL_CASE" suffix="" />
+        <rule entity="MACRO" visibility="ANY" specifier="ANY" prefix="" style="SCREAMING_SNAKE_CASE" suffix="" />
+        <rule entity="CLASS" visibility="ANY" specifier="ANY" prefix="" style="PASCAL_CASE" suffix="" />
+        <rule entity="ENUM" visibility="ANY" specifier="ANY" prefix="" style="PASCAL_CASE" suffix="" />
+        <rule entity="ENUMERATOR" visibility="ANY" specifier="ANY" prefix="" style="PASCAL_CASE" suffix="" />
+        <rule entity="TYPEDEF" visibility="ANY" specifier="ANY" prefix="" style="PASCAL_CASE" suffix="" />
+        <rule entity="UNION" visibility="ANY" specifier="ANY" prefix="" style="PASCAL_CASE" suffix="" />
+        <rule entity="MEMBER_FUNCTION" visibility="ANY" specifier="ANY" prefix="" style="PASCAL_CASE" suffix="" />
+        <rule entity="MEMBER_FIELD" visibility="ANY" specifier="ANY" prefix="" style="CAMEL_CASE" suffix="" />
+        <rule entity="GLOBAL_FUNCTION" visibility="ANY" specifier="ANY" prefix="" style="PASCAL_CASE" suffix="" />
+        <rule entity="GLOBAL_VARIABLE" visibility="ANY" specifier="ANY" prefix="" style="PASCAL_CASE" suffix="" />
+        <rule entity="PARAMETER" visibility="ANY" specifier="ANY" prefix="" style="CAMEL_CASE" suffix="" />
+        <rule entity="LOCAL_VARIABLE" visibility="ANY" specifier="ANY" prefix="" style="CAMEL_CASE" suffix="" />
+      </rules>
     </Objective-C-extensions>
     <XML>
       <option name="XML_ATTRIBUTE_WRAP" value="0" />
diff --git a/app/src/main/cpp/skyline/services/timesrv/ITimeZoneService.h b/app/src/main/cpp/skyline/services/timesrv/ITimeZoneService.h
index 85ea2c01..ce39720e 100644
--- a/app/src/main/cpp/skyline/services/timesrv/ITimeZoneService.h
+++ b/app/src/main/cpp/skyline/services/timesrv/ITimeZoneService.h
@@ -13,12 +13,12 @@ namespace skyline::service::timesrv {
          * @brief This holds a particular time point in calendar format
          */
         struct CalendarTime {
-            u16 year;
-            u8 month;
-            u8 day;
-            u8 hour;
-            u8 minute;
-            u8 second;
+            u16 year; //!< The Year component of the date
+            u8 month; //!< The Month component of the date
+            u8 day; //!< The Day component of the date
+            u8 hour; //!< The Hour component of the date
+            u8 minute; //!< The Minute component of the date
+            u8 second; //!< The Second component of the date
             u8 _pad_;
         };
         static_assert(sizeof(CalendarTime) == 0x8);
@@ -27,11 +27,11 @@ namespace skyline::service::timesrv {
          * @brief This is passed in addition to CalendarTime
          */
         struct CalendarAdditionalInfo {
-            u32 dayWeek;
-            u32 dayMonth;
-            u64 name;
-            i32 dst;
-            u32 utcRel;
+            u32 dayWeek; //!< The amount of days since Sunday
+            u32 dayMonth; //!< The amount of days since the start of the month
+            u64 name; //!< The name of the time zone
+            i32 dst; //!< If DST is in effect or not
+            u32 utcRel; //!< The offset of the time from GMT in seconds
         };
         static_assert(sizeof(CalendarAdditionalInfo) == 0x18);