From 7f26fc545503c523a6ce2bf2fc198190ec5720a3 Mon Sep 17 00:00:00 2001
From: GeckoEidechse <40122905+GeckoEidechse@users.noreply.github.com>
Date: Wed, 13 Sep 2023 02:00:09 +0200
Subject: fix: Turn comments into doc comments (#561)

So for some reason when I started out writing this file I used standard
comments to annotate the constants.

Using doc comments makes more sense here as they get taken into account
when generating documentations.
---
 src-tauri/src/constants.rs | 30 +++++++++++++++---------------
 1 file changed, 15 insertions(+), 15 deletions(-)

(limited to 'src-tauri/src')

diff --git a/src-tauri/src/constants.rs b/src-tauri/src/constants.rs
index f98521b8..7ee98f95 100644
--- a/src-tauri/src/constants.rs
+++ b/src-tauri/src/constants.rs
@@ -2,59 +2,59 @@
 use const_format::concatcp;
 use std::time::Duration;
 
-// FlightCore user agent for web requests
+/// FlightCore user agent for web requests
 pub const APP_USER_AGENT: &str = concatcp!("FlightCore/", env!("CARGO_PKG_VERSION"));
 
-// URL of the Northstar masterserver
+/// URL of the Northstar masterserver
 pub const MASTER_SERVER_URL: &str = "https://northstar.tf";
 
-// server list endpoint
+/// server list endpoint
 pub const SERVER_BROWSER_ENDPOINT: &str = "/client/servers";
 
-// List of core Northstar mods
+/// List of core Northstar mods
 pub const CORE_MODS: [&str; 3] = [
     "Northstar.Client",
     "Northstar.Custom",
     "Northstar.CustomServers",
 ];
 
-// List of Thunderstoremods that shouldn't be installable
-// as they behave different than common Squirrel mods
+/// List of Thunderstoremods that shouldn't be installable
+/// as they behave different than common Squirrel mods
 pub const BLACKLISTED_MODS: [&str; 3] = [
     "northstar-Northstar",
     "northstar-NorthstarReleaseCandidate",
     "ebkr-r2modman",
 ];
 
-// Titanfall2 Steam App ID
+/// Titanfall2 Steam App ID
 pub const TITANFALL2_STEAM_ID: &str = "1237970";
 
-// Order in which the sections for release notes should be displayed
+/// Order in which the sections for release notes should be displayed
 pub const SECTION_ORDER: [&str; 10] = [
     "feat", "fix", "docs", "style", "refactor", "build", "test", "i18n", "chore", "other",
 ];
 
-// GitHub API endpoints for launcher/mods PRs
+/// GitHub API endpoints for launcher/mods PRs
 pub const PULLS_API_ENDPOINT_LAUNCHER: &str =
     "https://api.github.com/repos/R2Northstar/NorthstarLauncher/pulls";
 pub const PULLS_API_ENDPOINT_MODS: &str =
     "https://api.github.com/repos/R2Northstar/NorthstarMods/pulls";
 
-// Statistics (players and servers counts) refresh delay
+/// Statistics (players and servers counts) refresh delay
 pub const REFRESH_DELAY: Duration = Duration::from_secs(5 * 60);
 
-// Flightcore repo name and org name on GitHub
+/// Flightcore repo name and org name on GitHub
 pub const FLIGHTCORE_REPO_NAME: &str = "R2NorthstarTools/FlightCore";
 
-// Northstar release repo name and org name on GitHub
+/// Northstar release repo name and org name on GitHub
 pub const NORTHSTAR_RELEASE_REPO_NAME: &str = "R2Northstar/Northstar";
 
-// URL to launcher commits API URL
+/// URL to launcher commits API URL
 pub const NS_LAUNCHER_COMMITS_API_URL: &str =
     "https://api.github.com/repos/R2Northstar/NorthstarLauncher/commits";
 
-// Filename of DLL that Northstar uses
+/// Filename of DLL that Northstar uses
 pub const NORTHSTAR_DLL: &str = "Northstar.dll";
 
-// Profile that Northstar defaults to and ships with
+/// Profile that Northstar defaults to and ships with
 pub const NORTHSTAR_DEFAULT_PROFILE: &str = "R2Northstar";
-- 
cgit v1.2.3