summaryrefslogtreecommitdiff
path: root/src/cmdline.rs
diff options
context:
space:
mode:
authorXavier Del Campo <xavi92psx@gmail.com>2018-12-30 18:21:35 +0100
committerXavier Del Campo <xavi92psx@gmail.com>2018-12-30 18:21:35 +0100
commitb47361f283777f266970f9c082782ebac6c04aef (patch)
treec575bd7d024e6092a144869d3b59229d9740842b /src/cmdline.rs
parent344e0963112081ca5d4e25762bbe0b8e73d2dda5 (diff)
downloadrspsxserial-b47361f283777f266970f9c082782ebac6c04aef.tar.gz
Added some comments
Diffstat (limited to 'src/cmdline.rs')
-rw-r--r--src/cmdline.rs8
1 files changed, 8 insertions, 0 deletions
diff --git a/src/cmdline.rs b/src/cmdline.rs
index c3278df..6405301 100644
--- a/src/cmdline.rs
+++ b/src/cmdline.rs
@@ -1,5 +1,9 @@
use std::{string::String, env, collections::HashMap};
+/// This structure defines a command line
+/// argument and its low-level parameters.
+/// An array of CmdLineArg instances,
+/// called CMD_LINE_ARGS, is defined.
pub struct CmdLineArg {
pub arg_str : &'static str,
pub param_str : Option<&'static str>,
@@ -7,7 +11,11 @@ pub struct CmdLineArg {
explanation : &'static str
}
+/// This parameter allows defining serial port name.
pub const PORT_NAME_ARG : &'static str = "--port-name";
+
+/// This parameter disables sending any information
+/// coming from the console to stdout.
pub const DISABLE_OUTPUT_ARG : &'static str = "--disable-output";
pub const BAUDRATE_ARG : &'static str = "--baudrate";
pub const TCP_ARG : &'static str = "--tcp";