doc: correct documentation issues

- fix some failing doc-tests.
- amend formatting causing misinterpretation as code-samples.
- mark some examples as
  [`compile_fail`](https://doc.rust-lang.org/rustdoc/write-documentation/documentation-tests.html#attributes)
  as there's no immediate way to instantiate the required `struct`.

Author: PsypherPunk

src/benchmark/mod.rs

@@ -1,15 +1,18 @@
 //! # Usage
-//! ```
+//!
+//! ```rust
 //! // Initiate Benchmark vector
+//! # use rustscan::benchmark::{Benchmark, NamedTimer};
+//! # use log::info;
 //! let mut bm = Benchmark::init();
 //! // Start named timer with name
 //! let mut example_bench = NamedTimer::start("Example Bench");
 //! // Stop named timer
-//! example_bench.stop();
+//! example_bench.end();
 //! // Add named timer to Benchmarks
 //! bm.push(example_bench);
 //! // Print Benchmark Summary
-//! info!({}, bm.summary());
+//! info!("{}", bm.summary());
 //! ```
 use std::time::Instant;
 

src/scanner/mod.rs

@@ -64,7 +64,7 @@ impl Scanner {
 
     /// Runs scan_range with chunk sizes
     /// If you want to run RustScan normally, this is the entry point used
-    /// Returns all open ports as Vec<u16>
+    /// Returns all open ports as `Vec<u16>`
     /// Added by wasuaje - 01/26/2024:
     ///    Filtering port against exclude port list
     pub async fn run(&self) -> Vec<SocketAddr> {
@@ -116,14 +116,16 @@ impl Scanner {
 
     /// Given a socket, scan it self.tries times.
     /// Turns the address into a SocketAddr
-    /// Deals with the <result> type
+    /// Deals with the `<result>` type
     /// If it experiences error ErrorKind::Other then too many files are open and it Panics!
     /// Else any other error, it returns the error in Result as a string
     /// If no errors occur, it returns the port number in Result to signify the port is open.
     /// This function mainly deals with the logic of Results handling.
     /// # Example
     ///
-    ///     self.scan_socket(socket)
+    /// ```compile_fail
+    /// scanner.scan_socket(socket)
+    /// ```
     ///
     /// Note: `self` must contain `self.ip`.
     async fn scan_socket(&self, socket: SocketAddr) -> io::Result<SocketAddr> {
@@ -169,13 +171,16 @@ impl Scanner {
     /// Performs the connection to the socket with timeout
     /// # Example
     ///
-    ///     let port: u16 = 80
-    ///     // ip is an IpAddr type
-    ///     let ip = IpAddr::V6(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1));
-    ///     let socket = SocketAddr::new(ip, port);
-    ///     self.connect(socket)
-    ///     // returns Result which is either Ok(stream) for port is open, or Er for port is closed.
-    ///     // Timeout occurs after self.timeout seconds
+    /// ```compile_fail
+    /// # use std::net::{IpAddr, Ipv6Addr, SocketAddr};
+    /// let port: u16 = 80;
+    /// // ip is an IpAddr type
+    /// let ip = IpAddr::V6(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1));
+    /// let socket = SocketAddr::new(ip, port);
+    /// scanner.connect(socket);
+    /// // returns Result which is either Ok(stream) for port is open, or Er for port is closed.
+    /// // Timeout occurs after self.timeout seconds
+    /// ```
     ///
     async fn connect(&self, socket: SocketAddr) -> io::Result<TcpStream> {
         let stream = io::timeout(

src/scripts/mod.rs

@@ -5,23 +5,23 @@
 //!
 //! --scripts
 //!
-//!      default
-//!          This is the default behavior, like as it was from the beginning of RustScan.
-//!          The user do not have to chose anything for this. This is the only script embedded in RustScan running as default.
+//!   default
+//!     This is the default behavior, like as it was from the beginning of RustScan.
+//!     The user do not have to chose anything for this. This is the only script embedded in RustScan running as default.
 //!
-//!      none
-//!          The user have to use the --scripts none commandline argument or scripts = "none" in the config file.
-//!          None of the scripts will run, this replaces the removed --no-nmap option.
+//!   none
+//!     The user have to use the --scripts none commandline argument or scripts = "none" in the config file.
+//!     None of the scripts will run, this replaces the removed --no-nmap option.
 //!
-//!      custom
-//!          The user have to use the --scripts custom commandline argument or scripts = "custom" in the config file.
-//!          Rustscan will look for the script configuration file in the user's home dir: home_dir/.rustscan_scripts.toml
-//!          The config file have 3 optional fields, tag, developer and port. Just the tag field will be used forther in the process.
-//!          RustScan will also look for available scripts in the user's home dir: home_dir/.rustscan_scripts
-//!          and will try to read all the files, and parse them into a vector of ScriptFiles.
-//!          Filtering on tags means the tags found in the rustscan_scripts.toml file will also have to be present in the Scriptfile,
-//!          otherwise the script will not be selected.
-//!          All of the rustscan_script.toml tags have to be present at minimum in a Scriptfile to get selected, but can be also more.
+//!   custom
+//!     The user have to use the --scripts custom commandline argument or scripts = "custom" in the config file.
+//!     Rustscan will look for the script configuration file in the user's home dir: home_dir/.rustscan_scripts.toml
+//!     The config file have 3 optional fields, tag, developer and port. Just the tag field will be used forther in the process.
+//!     RustScan will also look for available scripts in the user's home dir: home_dir/.rustscan_scripts
+//!     and will try to read all the files, and parse them into a vector of ScriptFiles.
+//!     Filtering on tags means the tags found in the rustscan_scripts.toml file will also have to be present in the Scriptfile,
+//!     otherwise the script will not be selected.
+//!     All of the rustscan_script.toml tags have to be present at minimum in a Scriptfile to get selected, but can be also more.
 //!
 //! Config file example:
 //! fixtures/test_rustscan_scripts.toml