From f49ab2e39ea479af886ecd3c325d16bc4df4046f Mon Sep 17 00:00:00 2001
From: GeckoEidechse <40122905+GeckoEidechse@users.noreply.github.com>
Date: Fri, 13 Oct 2023 03:26:15 +0200
Subject: docs: Add doc comments to some structs (#621)

---
 src-tauri/src/main.rs | 6 ++++++
 1 file changed, 6 insertions(+)

(limited to 'src-tauri')

diff --git a/src-tauri/src/main.rs b/src-tauri/src/main.rs
index 6b0425cd..1d20bf74 100644
--- a/src-tauri/src/main.rs
+++ b/src-tauri/src/main.rs
@@ -387,6 +387,7 @@ async fn get_available_northstar_versions() -> Result<Vec<NorthstarThunderstoreR
 
 use anyhow::Result;
 
+/// Defines how Titanfall2 was installed (Steam, Origin, ...)
 #[derive(Serialize, Deserialize, Debug, Clone, TS)]
 #[ts(export)]
 pub enum InstallType {
@@ -396,6 +397,10 @@ pub enum InstallType {
     UNKNOWN,
 }
 
+/// Object holding information of the Titanfall2 install, including
+/// - Install path
+/// - Active profile
+/// - Type of installation (Steam, Origin, ...)
 #[derive(Serialize, Deserialize, Debug, Clone)]
 pub struct GameInstall {
     pub game_path: String,
@@ -403,6 +408,7 @@ pub struct GameInstall {
     pub install_type: InstallType,
 }
 
+/// Object holding various information about a Northstar mod
 #[derive(Serialize, Deserialize, Debug, Clone, TS)]
 #[ts(export)]
 pub struct NorthstarMod {
-- 
cgit v1.2.3