Removed docs headers

src/ui/activities/auth/bookmarks.rs

@@ -35,8 +35,6 @@ use crate::system::environment;
 use std::path::PathBuf;
 
 impl AuthActivity {
-    /// ### del_bookmark
-    ///
     /// Delete bookmark
     pub(super) fn del_bookmark(&mut self, idx: usize) {
         if let Some(bookmarks_cli) = self.bookmarks_client.as_mut() {
@@ -52,8 +50,6 @@ impl AuthActivity {
         }
     }
 
-    /// ### load_bookmark
-    ///
     /// Load selected bookmark (at index) to input fields
     pub(super) fn load_bookmark(&mut self, idx: usize) {
         if let Some(bookmarks_cli) = self.bookmarks_client.as_ref() {
@@ -67,8 +63,6 @@ impl AuthActivity {
         }
     }
 
-    /// ### save_bookmark
-    ///
     /// Save current input fields as a bookmark
     pub(super) fn save_bookmark(&mut self, name: String, save_password: bool) {
         let params = match self.collect_host_params() {
@@ -89,8 +83,6 @@ impl AuthActivity {
             self.sort_bookmarks();
         }
     }
-    /// ### del_recent
-    ///
     /// Delete recent
     pub(super) fn del_recent(&mut self, idx: usize) {
         if let Some(client) = self.bookmarks_client.as_mut() {
@@ -105,8 +97,6 @@ impl AuthActivity {
         }
     }
 
-    /// ### load_recent
-    ///
     /// Load selected recent (at index) to input fields
     pub(super) fn load_recent(&mut self, idx: usize) {
         if let Some(client) = self.bookmarks_client.as_ref() {
@@ -120,8 +110,6 @@ impl AuthActivity {
         }
     }
 
-    /// ### save_recent
-    ///
     /// Save current input fields as a "recent"
     pub(super) fn save_recent(&mut self) {
         let params = match self.collect_host_params() {
@@ -138,8 +126,6 @@ impl AuthActivity {
         }
     }
 
-    /// ### write_bookmarks
-    ///
     /// Write bookmarks to file
     fn write_bookmarks(&mut self) {
         if let Some(bookmarks_cli) = self.bookmarks_client.as_ref() {
@@ -149,8 +135,6 @@ impl AuthActivity {
         }
     }
 
-    /// ### init_bookmarks_client
-    ///
     /// Initialize bookmarks client
     pub(super) fn init_bookmarks_client(&mut self) {
         // Get config dir
@@ -210,8 +194,6 @@ impl AuthActivity {
 
     // -- privates
 
-    /// ### sort_bookmarks
-    ///
     /// Sort bookmarks in list
     fn sort_bookmarks(&mut self) {
         // Conver to lowercase when sorting
@@ -219,16 +201,12 @@ impl AuthActivity {
             .sort_by(|a, b| a.to_lowercase().as_str().cmp(b.to_lowercase().as_str()));
     }
 
-    /// ### sort_recents
-    ///
     /// Sort recents in list
     fn sort_recents(&mut self) {
         // Reverse order
         self.recents_list.sort_by(|a, b| b.cmp(a));
     }
 
-    /// ### load_bookmark_into_gui
-    ///
     /// Load bookmark data into the gui components
     fn load_bookmark_into_gui(&mut self, bookmark: FileTransferParams) {
         // Load parameters into components

src/ui/activities/auth/components/form.rs

@@ -57,8 +57,6 @@ impl ProtocolRadio {
         }
     }
 
-    /// ### protocol_opt_to_enum
-    ///
     /// Convert radio index for protocol into a `FileTransferProtocol`
     fn protocol_opt_to_enum(protocol: usize) -> FileTransferProtocol {
         match protocol {
@@ -70,8 +68,6 @@ impl ProtocolRadio {
         }
     }
 
-    /// ### protocol_enum_to_opt
-    ///
     /// Convert `FileTransferProtocol` enum into radio group index
     fn protocol_enum_to_opt(protocol: FileTransferProtocol) -> usize {
         match protocol {

src/ui/activities/auth/misc.rs

@@ -31,8 +31,6 @@ use crate::system::auto_update::{Release, Update, UpdateStatus};
 use crate::system::notifications::Notification;
 
 impl AuthActivity {
-    /// ### get_default_port_for_protocol
-    ///
     /// Get the default port for protocol
     pub(super) fn get_default_port_for_protocol(protocol: FileTransferProtocol) -> u16 {
         match protocol {
@@ -42,15 +40,11 @@ impl AuthActivity {
         }
     }
 
-    /// ### is_port_standard
-    ///
     /// Returns whether the port is standard or not
     pub(super) fn is_port_standard(port: u16) -> bool {
         port < 1024
     }
 
-    /// ### check_minimum_window_size
-    ///
     /// Check minimum window size window
     pub(super) fn check_minimum_window_size(&mut self, height: u16) {
         if height < 25 {
@@ -61,8 +55,6 @@ impl AuthActivity {
         }
     }
 
-    /// ### collect_host_params
-    ///
     /// Collect host params as `FileTransferParams`
     pub(super) fn collect_host_params(&self) -> Result<FileTransferParams, &'static str> {
         match self.protocol {
@@ -71,8 +63,6 @@ impl AuthActivity {
         }
     }
 
-    /// ### collect_generic_host_params
-    ///
     /// Get input values from fields or return an error if fields are invalid to work as generic
     pub(super) fn collect_generic_host_params(
         &self,
@@ -105,8 +95,6 @@ impl AuthActivity {
         })
     }
 
-    /// ### collect_s3_host_params
-    ///
     /// Get input values from fields or return an error if fields are invalid to work as aws s3
     pub(super) fn collect_s3_host_params(&self) -> Result<FileTransferParams, &'static str> {
         let (bucket, region, profile): (String, String, Option<String>) =
@@ -126,8 +114,6 @@ impl AuthActivity {
 
     // -- update install
 
-    /// ### check_for_updates
-    ///
     /// If enabled in configuration, check for updates from Github
     pub(super) fn check_for_updates(&mut self) {
         debug!("Check for updates...");
@@ -171,8 +157,6 @@ impl AuthActivity {
         }
     }
 
-    /// ### install_update
-    ///
     /// Install latest termscp version via GUI
     pub(super) fn install_update(&mut self) {
         // Umount release notes

src/ui/activities/auth/mod.rs

@@ -127,8 +127,6 @@ pub enum Msg {
     None,
 }
 
-/// ## InputMask
-///
 /// Auth form input mask
 #[derive(Eq, PartialEq)]
 enum InputMask {
@@ -160,8 +158,6 @@ pub struct AuthActivity {
 }
 
 impl AuthActivity {
-    /// ### new
-    ///
     /// Instantiates a new AuthActivity
     pub fn new(ticks: Duration) -> AuthActivity {
         AuthActivity {
@@ -180,36 +176,26 @@ impl AuthActivity {
         }
     }
 
-    /// ### context
-    ///
     /// Returns a reference to context
     fn context(&self) -> &Context {
         self.context.as_ref().unwrap()
     }
 
-    /// ### context_mut
-    ///
     /// Returns a mutable reference to context
     fn context_mut(&mut self) -> &mut Context {
         self.context.as_mut().unwrap()
     }
 
-    /// ### config
-    ///
     /// Returns config client reference
     fn config(&self) -> &ConfigClient {
         self.context().config()
     }
 
-    /// ### theme
-    ///
     /// Returns a reference to theme
     fn theme(&self) -> &Theme {
         self.context().theme_provider().theme()
     }
 
-    /// ### input_mask
-    ///
     /// Get current input mask to show
     fn input_mask(&self) -> InputMask {
         match self.protocol {
@@ -222,8 +208,6 @@ impl AuthActivity {
 }
 
 impl Activity for AuthActivity {
-    /// ### on_create
-    ///
     /// `on_create` is the function which must be called to initialize the activity.
     /// `on_create` must initialize all the data structures used by the activity
     /// Context is taken from activity manager and will be released only when activity is destroyed
@@ -259,8 +243,6 @@ impl Activity for AuthActivity {
         info!("Activity initialized");
     }
 
-    /// ### on_draw
-    ///
     /// `on_draw` is the function which draws the graphical interface.
     /// This function must be called at each tick to refresh the interface
     fn on_draw(&mut self) {
@@ -288,8 +270,6 @@ impl Activity for AuthActivity {
         }
     }
 
-    /// ### will_umount
-    ///
     /// `will_umount` is the method which must be able to report to the activity manager, whether
     /// the activity should be terminated or not.
     /// If not, the call will return `None`, otherwise return`Some(ExitReason)`
@@ -297,8 +277,6 @@ impl Activity for AuthActivity {
         self.exit_reason.as_ref()
     }
 
-    /// ### on_destroy
-    ///
     /// `on_destroy` is the function which cleans up runtime variables and data before terminating the activity.
     /// This function must be called once before terminating the activity.
     /// This function finally releases the context

src/ui/activities/auth/view.rs

@@ -37,8 +37,6 @@ use tuirealm::tui::widgets::Clear;
 use tuirealm::{State, StateValue, Sub, SubClause, SubEventClause};
 
 impl AuthActivity {
-    /// ### init
-    ///
     /// Initialize view, mounting all startup components inside the view
     pub(super) fn init(&mut self) {
         let key_color = self.theme().misc_keys;
@@ -104,8 +102,6 @@ impl AuthActivity {
         assert!(self.app.active(&Id::Protocol).is_ok());
     }
 
-    /// ### view
-    ///
     /// Display view on canvas
     pub(super) fn view(&mut self) {
         self.redraw = false;
@@ -276,8 +272,6 @@ impl AuthActivity {
 
     // -- partials
 
-    /// ### view_bookmarks
-    ///
     /// Make text span from bookmarks
     pub(super) fn view_bookmarks(&mut self) {
         let bookmarks: Vec<String> = self
@@ -305,8 +299,6 @@ impl AuthActivity {
             .is_ok());
     }
 
-    /// ### view_recent_connections
-    ///
     /// View recent connections
     pub(super) fn view_recent_connections(&mut self) {
         let bookmarks: Vec<String> = self
@@ -335,8 +327,6 @@ impl AuthActivity {
 
     // -- mount
 
-    /// ### mount_error
-    ///
     /// Mount error box
     pub(super) fn mount_error<S: AsRef<str>>(&mut self, text: S) {
         let err_color = self.theme().misc_error_dialog;
@@ -351,15 +341,11 @@ impl AuthActivity {
         assert!(self.app.active(&Id::ErrorPopup).is_ok());
     }
 
-    /// ### umount_error
-    ///
     /// Umount error message
     pub(super) fn umount_error(&mut self) {
         let _ = self.app.umount(&Id::ErrorPopup);
     }
 
-    /// ### mount_info
-    ///
     /// Mount info box
     pub(super) fn mount_info<S: AsRef<str>>(&mut self, text: S) {
         let color = self.theme().misc_info_dialog;
@@ -374,15 +360,11 @@ impl AuthActivity {
         assert!(self.app.active(&Id::InfoPopup).is_ok());
     }
 
-    /// ### umount_info
-    ///
     /// Umount info message
     pub(super) fn umount_info(&mut self) {
         let _ = self.app.umount(&Id::InfoPopup);
     }
 
-    /// ### mount_error
-    ///
     /// Mount wait box
     pub(super) fn mount_wait(&mut self, text: &str) {
         let wait_color = self.theme().misc_info_dialog;
@@ -397,15 +379,11 @@ impl AuthActivity {
         assert!(self.app.active(&Id::WaitPopup).is_ok());
     }
 
-    /// ### umount_wait
-    ///
     /// Umount wait message
     pub(super) fn umount_wait(&mut self) {
         let _ = self.app.umount(&Id::WaitPopup);
     }
 
-    /// ### mount_size_err
-    ///
     /// Mount size error
     pub(super) fn mount_size_err(&mut self) {
         // Mount
@@ -421,15 +399,11 @@ impl AuthActivity {
         assert!(self.app.active(&Id::WindowSizeError).is_ok());
     }
 
-    /// ### umount_size_err
-    ///
     /// Umount error size error
     pub(super) fn umount_size_err(&mut self) {
         let _ = self.app.umount(&Id::WindowSizeError);
     }
 
-    /// ### mount_quit
-    ///
     /// Mount quit popup
     pub(super) fn mount_quit(&mut self) {
         // Protocol
@@ -445,15 +419,11 @@ impl AuthActivity {
         assert!(self.app.active(&Id::QuitPopup).is_ok());
     }
 
-    /// ### umount_quit
-    ///
     /// Umount quit popup
     pub(super) fn umount_quit(&mut self) {
         let _ = self.app.umount(&Id::QuitPopup);
     }
 
-    /// ### mount_bookmark_del_dialog
-    ///
     /// Mount bookmark delete dialog
     pub(super) fn mount_bookmark_del_dialog(&mut self) {
         let warn_color = self.theme().misc_warn_dialog;
@@ -468,15 +438,11 @@ impl AuthActivity {
         assert!(self.app.active(&Id::DeleteBookmarkPopup).is_ok());
     }
 
-    /// ### umount_bookmark_del_dialog
-    ///
     /// umount delete bookmark dialog
     pub(super) fn umount_bookmark_del_dialog(&mut self) {
         let _ = self.app.umount(&Id::DeleteBookmarkPopup);
     }
 
-    /// ### mount_bookmark_del_dialog
-    ///
     /// Mount recent delete dialog
     pub(super) fn mount_recent_del_dialog(&mut self) {
         let warn_color = self.theme().misc_warn_dialog;
@@ -491,15 +457,11 @@ impl AuthActivity {
         assert!(self.app.active(&Id::DeleteRecentPopup).is_ok());
     }
 
-    /// ### umount_recent_del_dialog
-    ///
     /// umount delete recent dialog
     pub(super) fn umount_recent_del_dialog(&mut self) {
         let _ = self.app.umount(&Id::DeleteRecentPopup);
     }
 
-    /// ### mount_bookmark_save_dialog
-    ///
     /// Mount bookmark save dialog
     pub(super) fn mount_bookmark_save_dialog(&mut self) {
         let save_color = self.theme().misc_save_dialog;
@@ -524,16 +486,12 @@ impl AuthActivity {
         assert!(self.app.active(&Id::BookmarkName).is_ok());
     }
 
-    /// ### umount_bookmark_save_dialog
-    ///
     /// Umount bookmark save dialog
     pub(super) fn umount_bookmark_save_dialog(&mut self) {
         let _ = self.app.umount(&Id::BookmarkName);
         let _ = self.app.umount(&Id::BookmarkSavePassword);
     }
 
-    /// ### mount_keybindings
-    ///
     /// Mount keybindings
     pub(super) fn mount_keybindings(&mut self) {
         let key_color = self.theme().misc_keys;
@@ -549,15 +507,11 @@ impl AuthActivity {
         assert!(self.app.active(&Id::Keybindings).is_ok());
     }
 
-    /// ### umount_help
-    ///
     /// Umount help
     pub(super) fn umount_help(&mut self) {
         let _ = self.app.umount(&Id::Keybindings);
     }
 
-    /// ### mount_release_notes
-    ///
     /// mount release notes text area
     pub(super) fn mount_release_notes(&mut self) {
         if let Some(ctx) = self.context.as_ref() {
@@ -585,8 +539,6 @@ impl AuthActivity {
         }
     }
 
-    /// ### umount_release_notes
-    ///
     /// Umount release notes text area
     pub(super) fn umount_release_notes(&mut self) {
         let _ = self.app.umount(&Id::NewVersionChangelog);
@@ -691,8 +643,6 @@ impl AuthActivity {
 
     // -- query
 
-    /// ### get_generic_params
-    ///
     /// Collect input values from view
     pub(super) fn get_generic_params_input(&self) -> (String, u16, String, String) {
         let addr: String = self.get_input_addr();
@@ -702,8 +652,6 @@ impl AuthActivity {
         (addr, port, username, password)
     }
 
-    /// ### get_s3_params_input
-    ///
     /// Collect s3 input values from view
     pub(super) fn get_s3_params_input(&self) -> (String, String, Option<String>) {
         let bucket: String = self.get_input_s3_bucket();
@@ -764,8 +712,6 @@ impl AuthActivity {
         }
     }
 
-    /// ### get_new_bookmark
-    ///
     /// Get new bookmark params
     pub(super) fn get_new_bookmark(&self) -> (String, bool) {
         let name = match self.app.state(&Id::BookmarkName) {
@@ -784,8 +730,6 @@ impl AuthActivity {
 
     // -- len
 
-    /// ### input_mask_size
-    ///
     /// Returns the input mask size based on current input mask
     pub(super) fn input_mask_size(&self) -> u16 {
         match self.input_mask() {
@@ -796,16 +740,12 @@ impl AuthActivity {
 
     // -- fmt
 
-    /// ### fmt_bookmark
-    ///
     /// Format bookmark to display on ui
     fn fmt_bookmark(name: &str, b: FileTransferParams) -> String {
         let addr: String = Self::fmt_recent(b);
         format!("{} ({})", name, addr)
     }
 
-    /// ### fmt_recent
-    ///
     /// Format recent connection to display on ui
     fn fmt_recent(b: FileTransferParams) -> String {
         let protocol: String = b.protocol.to_string().to_lowercase();
@@ -881,8 +821,6 @@ impl AuthActivity {
             .is_ok());
     }
 
-    /// ### no_popup_mounted_clause
-    ///
     /// Returns a sub clause which requires that no popup is mounted in order to be satisfied
     fn no_popup_mounted_clause() -> SubClause<Id> {
         SubClause::And(