From cb1edad6582234a55bbf276773751eb0c56808f5 Mon Sep 17 00:00:00 2001 From: neon_arch Date: Fri, 28 Apr 2023 14:43:02 +0300 Subject: [PATCH] fixing documentation test in lib.rs and adding library documentation --- src/lib.rs | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/src/lib.rs b/src/lib.rs index e5ed0e9..696a07e 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,3 +1,6 @@ +//! This main library module provides the functionality to provide and handle the Tcp server +//! and register all the routes for the `websurfx` meta search engine website. + pub mod engines; pub mod server; pub mod search_results_handler; @@ -23,12 +26,12 @@ use handlebars::Handlebars; /// /// # Example /// -/// ``` +/// ```rust /// use std::net::TcpListener; -/// use web_server::Server; +/// use websurfx::run; /// /// let listener = TcpListener::bind("127.0.0.1:8080").expect("Failed to bind address"); -/// let server = Server::run(listener).expect("Failed to start server"); +/// let server = run(listener).expect("Failed to start server"); /// ``` pub fn run(listener: TcpListener) -> std::io::Result { let mut handlebars: Handlebars = Handlebars::new();