# Changes 0.2.4-1

- Add GIT_BRANCH (for development and stable)
- Write  Documentation of
  - pd-core (exept of vec.hpp)
  - pd-app
  - pd-drivers
  - pd-lib3ds
  - pd-image
  - pd-image
  - pd-ui7

include/pd/lib3ds/drv_hid.hpp

@@ -26,11 +26,20 @@ SOFTWARE.
 #include <pd/drivers/hid.hpp>
 
 namespace PD {
+/**
+ * Nintendo 3DS Input Driver
+ */
 class CtrHid : public Hid {
  public:
+  /**
+   * Constructor to setup Key binds
+   */
   CtrHid();
-  ~CtrHid() {}
+  ~CtrHid() = default;
 
+  /**
+   * Overrideing the Update Function for Input Checking etc
+   */
   void Update() override;
 };
 }  // namespace PD

include/pd/lib3ds/gamepad_icons.hpp

@@ -27,7 +27,14 @@ SOFTWARE.
 #include <pd/drivers/hid.hpp>
 
 namespace PD {
+/**
+ * Simple Table Containing the codepoint references
+ * for the Controller Icons on the 3ds
+ */
 namespace GamePadIcons {
+/**
+ * Icon ID
+ */
 enum ID {
   A,
   B,
@@ -50,7 +57,17 @@ enum ID {
   DpadHorizontal,
   DpadVertical,
 };
+/**
+ * Get Icon by ID
+ * @param id ID to Get
+ * @return codepoint
+ */
 std::string GetIcon(ID id);
+/**
+ * Get Icon By Input Driver Key
+ * @param key Key to find
+ * @return codepoint
+ */
 std::string GetIcon(Hid::Key key);
 }  // namespace GamePadIcons
 }  // namespace PD

include/pd/lib3ds/hwinfo.hpp

@@ -26,11 +26,32 @@ SOFTWARE.
 #include <pd/core/common.hpp>
 
 namespace PD {
+/**
+ * static Namespace containing Access to some 3ds Hardware Info
+ */
 namespace HwInfo {
+/**
+ * Init connecttion to required sys modules
+ */
 void Init();
+/**
+ * Deinit connection to sys modules
+ */
 void Deinit();
+/**
+ * Check if the Console is Charging
+ * @return true if the console is charging
+ */
 bool IsCharging();
+/**
+ * Get the Current Battery Percentage
+ * @return Battery Percentage (from 0 to 100)
+ */
 int GetBatteryPercentage();
+/**
+ * Get Current Wifi Level
+ * @return wifi level (0 to 4)
+ */
 int GetWifiLevel();
 }  // namespace HwInfo
 }  // namespace PD

include/pd/lib3ds/memory.hpp

@@ -26,10 +26,21 @@ SOFTWARE.
 
 #include <3ds.h>
 
-#include <pd/core/common.hpp>
 #include <pd/app/error.hpp>
+#include <pd/core/common.hpp>
 
 namespace PD {
+/**
+ * Custom C++ Allocator for 3DS linear Memory
+ * Used for Everything that has to do with Rendering or sound
+ * Dont going into that much detail here
+ *
+ * Example:
+ * ```cpp
+ * // Index Buffer for Rendering using Linear Allocator
+ * std::vector<u16, PD::LinearAllocator<u16>> index_buf;
+ * ```
+ */
 template <typename T>
 class LinearAllocator : public std::allocator<T> {
  public:

include/pd/lib3ds/os.hpp

@@ -26,7 +26,15 @@ SOFTWARE.
 #include <pd/core/common.hpp>
 
 namespace PD {
+/**
+ * Namespace to Everything that has to
+ * do with the 3ds (very empty currently)
+ */
 namespace Ctr {
+/**
+ * Get the System Language key (for lang system)
+ * @return language key
+ */
 std::string GetSystemLanguage();
 }  // namespace Ctr
 }  // namespace PD