aboutsummaryrefslogtreecommitdiff
path: root/src-tauri
diff options
context:
space:
mode:
authorGeckoEidechse <40122905+GeckoEidechse@users.noreply.github.com>2023-05-08 14:39:03 +0200
committerGitHub <noreply@github.com>2023-05-08 14:39:03 +0200
commit49b00f4996ff8ef179c7ec87bced1281fd430ea1 (patch)
treea3004a7a49dfeb385a8ca759fa3fd8e89387f2e1 /src-tauri
parentdc9f8c47eee0a320590d73a615107516bb824f8d (diff)
downloadFlightCore-49b00f4996ff8ef179c7ec87bced1281fd430ea1.tar.gz
FlightCore-49b00f4996ff8ef179c7ec87bced1281fd430ea1.zip
refactor: Put doc comment before macro (#312)
Doc comments should be placed before the procedural macro decorating the function being documented.
Diffstat (limited to 'src-tauri')
-rw-r--r--src-tauri/src/main.rs32
1 files changed, 16 insertions, 16 deletions
diff --git a/src-tauri/src/main.rs b/src-tauri/src/main.rs
index 1ba12474..f861801b 100644
--- a/src-tauri/src/main.rs
+++ b/src-tauri/src/main.rs
@@ -191,27 +191,27 @@ fn main() {
};
}
-#[tauri::command]
/// Wrapper for `find_game_install_location` as tauri doesn't allow passing `Result<>` types to front-end
+#[tauri::command]
async fn find_game_install_location_caller() -> Result<GameInstall, String> {
find_game_install_location()
}
-#[tauri::command]
/// This function's only use is to force a `panic!()`
// This must NOT be async to ensure crashing whole application.
+#[tauri::command]
fn force_panic() {
panic!("Force panicked!");
}
-#[tauri::command]
/// Returns true if built in debug mode
+#[tauri::command]
async fn is_debug_mode() -> bool {
cfg!(debug_assertions)
}
-#[tauri::command]
/// Returns true if linux compatible
+#[tauri::command]
async fn linux_checks() -> Result<(), String> {
// Different behaviour depending on OS
// MacOS is missing as it is not a target
@@ -227,8 +227,8 @@ async fn linux_checks() -> Result<(), String> {
}
}
-#[tauri::command]
/// Returns the current version number as a string
+#[tauri::command]
async fn get_flightcore_version_number() -> String {
let version = env!("CARGO_PKG_VERSION");
if cfg!(debug_assertions) {
@@ -248,10 +248,10 @@ async fn get_northstar_version_number_caller(game_path: String) -> Result<String
}
}
-#[tauri::command]
/// Checks if installed Northstar version is up-to-date
/// false -> Northstar install is up-to-date
/// true -> Northstar install is outdated
+#[tauri::command]
async fn check_is_northstar_outdated(
game_path: String,
northstar_package_name: Option<String>,
@@ -295,16 +295,16 @@ async fn check_is_northstar_outdated(
}
}
-#[tauri::command]
/// Checks if installed FlightCore version is up-to-date
/// false -> FlightCore install is up-to-date
/// true -> FlightCore install is outdated
+#[tauri::command]
async fn check_is_flightcore_outdated_caller() -> Result<bool, String> {
check_is_flightcore_outdated().await
}
-#[tauri::command]
/// Checks if is valid Titanfall2 install based on certain conditions
+#[tauri::command]
async fn verify_install_location(game_path: String) -> bool {
match check_is_valid_game_path(&game_path) {
Ok(()) => true,
@@ -315,14 +315,14 @@ async fn verify_install_location(game_path: String) -> bool {
}
}
-#[tauri::command]
/// Returns identifier of host OS FlightCore is running on
+#[tauri::command]
async fn get_host_os_caller() -> String {
get_host_os()
}
-#[tauri::command]
/// Installs Northstar to the given path
+#[tauri::command]
async fn install_northstar_caller(
window: tauri::Window,
game_path: String,
@@ -351,8 +351,8 @@ async fn install_northstar_caller(
}
}
-#[tauri::command]
/// Update Northstar install in the given path
+#[tauri::command]
async fn update_northstar_caller(
window: tauri::Window,
game_path: String,
@@ -364,8 +364,8 @@ async fn update_northstar_caller(
install_northstar_caller(window, game_path, northstar_package_name, None).await
}
-#[tauri::command]
/// Launches Northstar
+#[tauri::command]
async fn launch_northstar_caller(
game_install: GameInstall,
bypass_checks: Option<bool>,
@@ -373,8 +373,8 @@ async fn launch_northstar_caller(
launch_northstar(&game_install, bypass_checks)
}
-#[tauri::command]
/// Launches Northstar
+#[tauri::command]
async fn launch_northstar_steam_caller(
game_install: GameInstall,
bypass_checks: Option<bool>,
@@ -382,8 +382,8 @@ async fn launch_northstar_steam_caller(
launch_northstar_steam(&game_install, bypass_checks)
}
-#[tauri::command]
/// Installs the specified mod
+#[tauri::command]
async fn install_mod_caller(
game_install: GameInstall,
thunderstore_mod_string: String,
@@ -400,8 +400,8 @@ async fn install_mod_caller(
}
}
-#[tauri::command]
/// Installs the specified mod
+#[tauri::command]
async fn clean_up_download_folder_caller(
game_install: GameInstall,
force: bool,
@@ -442,8 +442,8 @@ async fn get_server_player_count() -> Result<(i32, usize), String> {
Ok((total_player_count, server_count))
}
-#[tauri::command]
/// Spawns repair window
+#[tauri::command]
async fn open_repair_window(handle: tauri::AppHandle) -> Result<(), String> {
// Spawn new window
let repair_window = match tauri::WindowBuilder::new(