summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorLinus Färnstrand <faern@faern.net>2022-01-18 11:03:42 +0100
committerLinus Färnstrand <faern@faern.net>2022-01-18 11:54:36 +0100
commit8f37fe804c020f81d04d6ea132292f296a955341 (patch)
tree87bfa582bec6c7d88c20ddf2f0865eeb28ac1fac
parent536f874ea4789c3c4b90f14b4701a3fa20f92448 (diff)
downloadmullvadvpn-8f37fe804c020f81d04d6ea132292f296a955341.tar.xz
mullvadvpn-8f37fe804c020f81d04d6ea132292f296a955341.zip
Just slight fix for the documentation `///` -> `//!` and similar
-rw-r--r--mullvad-rpc/src/bin/address_cache.rs6
-rw-r--r--mullvad-rpc/src/bin/relay_list.rs6
-rw-r--r--mullvad-rpc/src/relay_list.rs3
3 files changed, 11 insertions, 4 deletions
diff --git a/mullvad-rpc/src/bin/address_cache.rs b/mullvad-rpc/src/bin/address_cache.rs
index efb2501ba9..066ce5c910 100644
--- a/mullvad-rpc/src/bin/address_cache.rs
+++ b/mullvad-rpc/src/bin/address_cache.rs
@@ -1,4 +1,8 @@
-/// Generate a first list of IP addresses for Mullvad VPN to use to talk to the API.
+//! Fetches and prints a list of IP addresses and ports where the Mullvad API
+//! can be reached.
+//! Used by the installer artifact packer to bundle the latest available list
+//! of API IPs.
+
use mullvad_rpc::{rest::Error as RestError, ApiProxy, MullvadRpcRuntime};
use std::process;
use talpid_types::ErrorExt;
diff --git a/mullvad-rpc/src/bin/relay_list.rs b/mullvad-rpc/src/bin/relay_list.rs
index e3ca00a9bc..db7fc29854 100644
--- a/mullvad-rpc/src/bin/relay_list.rs
+++ b/mullvad-rpc/src/bin/relay_list.rs
@@ -1,5 +1,7 @@
-/// Intended to be used to pre-load a relay list when creating an installer for the Mullvad VPN
-/// app.
+//! Fetches and prints the full relay list in JSON.
+//! Used by the installer artifact packer to bundle the latest available
+//! relay list at the time of creating the installer.
+
use mullvad_rpc::{rest::Error as RestError, MullvadRpcRuntime, RelayListProxy};
use std::process;
use talpid_types::ErrorExt;
diff --git a/mullvad-rpc/src/relay_list.rs b/mullvad-rpc/src/relay_list.rs
index e24a873ebb..f1ed2217fd 100644
--- a/mullvad-rpc/src/relay_list.rs
+++ b/mullvad-rpc/src/relay_list.rs
@@ -1,4 +1,5 @@
-/// A module dedicated to retrieving the relay list from the master API.
+//! A module dedicated to retrieving the relay list from the Mullvad API.
+
use crate::rest;
use hyper::{header, Method, StatusCode};