mirror of
https://github.com/neon-mmd/websurfx.git
synced 2024-11-22 14:08:23 -05:00
✨ feat: improve code documentation
This commit is contained in:
parent
25d6af0251
commit
9cb582a10d
@ -22,6 +22,7 @@ static CONFIG_FILE_NAME: &str = "config.lua";
|
|||||||
/// * `logging` - It stores the option to whether enable or disable logs.
|
/// * `logging` - It stores the option to whether enable or disable logs.
|
||||||
/// * `debug` - It stores the option to whether enable or disable debug mode.
|
/// * `debug` - It stores the option to whether enable or disable debug mode.
|
||||||
/// * `upstream_search_engines` - It stores all the engine names that were enabled by the user.
|
/// * `upstream_search_engines` - It stores all the engine names that were enabled by the user.
|
||||||
|
/// * `request_timeout` - It stores the time (secs) which controls the server request timeout.
|
||||||
#[derive(Clone)]
|
#[derive(Clone)]
|
||||||
pub struct Config {
|
pub struct Config {
|
||||||
pub port: u16,
|
pub port: u16,
|
||||||
|
@ -29,6 +29,7 @@ impl SearchEngine for DuckDuckGo {
|
|||||||
/// * `query` - Takes the user provided query to query to the upstream search engine with.
|
/// * `query` - Takes the user provided query to query to the upstream search engine with.
|
||||||
/// * `page` - Takes an u32 as an argument.
|
/// * `page` - Takes an u32 as an argument.
|
||||||
/// * `user_agent` - Takes a random user agent string as an argument.
|
/// * `user_agent` - Takes a random user agent string as an argument.
|
||||||
|
/// * `request_timeout` - Takes a time (secs) as a value which controls the server request timeout.
|
||||||
///
|
///
|
||||||
/// # Errors
|
/// # Errors
|
||||||
///
|
///
|
||||||
|
@ -27,6 +27,7 @@ impl SearchEngine for Searx {
|
|||||||
/// * `query` - Takes the user provided query to query to the upstream search engine with.
|
/// * `query` - Takes the user provided query to query to the upstream search engine with.
|
||||||
/// * `page` - Takes an u32 as an argument.
|
/// * `page` - Takes an u32 as an argument.
|
||||||
/// * `user_agent` - Takes a random user agent string as an argument.
|
/// * `user_agent` - Takes a random user agent string as an argument.
|
||||||
|
/// * `request_timeout` - Takes a time (secs) as a value which controls the server request timeout.
|
||||||
///
|
///
|
||||||
/// # Errors
|
/// # Errors
|
||||||
///
|
///
|
||||||
|
@ -51,6 +51,7 @@ type FutureVec = Vec<JoinHandle<Result<HashMap<String, RawSearchResult>, Report<
|
|||||||
/// * `random_delay` - Accepts a boolean value to add a random delay before making the request.
|
/// * `random_delay` - Accepts a boolean value to add a random delay before making the request.
|
||||||
/// * `debug` - Accepts a boolean value to enable or disable debug mode option.
|
/// * `debug` - Accepts a boolean value to enable or disable debug mode option.
|
||||||
/// * `upstream_search_engines` - Accepts a vector of search engine names which was selected by the
|
/// * `upstream_search_engines` - Accepts a vector of search engine names which was selected by the
|
||||||
|
/// * `request_timeout` - Accepts a time (secs) as a value which controls the server request timeout.
|
||||||
/// user through the UI or the config file.
|
/// user through the UI or the config file.
|
||||||
///
|
///
|
||||||
/// # Error
|
/// # Error
|
||||||
|
Loading…
Reference in New Issue
Block a user