Skip to content

Commit

Permalink
Fix doc comments for jsonrpsee
Browse files Browse the repository at this point in the history
  • Loading branch information
pedromfedricci committed Oct 1, 2021
1 parent 85a0e19 commit cf118e5
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions jsonrpsee/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -30,44 +30,44 @@
//!
//! # Optional features
//!
//! Jsonrpsee crate composes JSON RPC functionality behind optional feature
//! The Jsonrpsee crate composes JSON-RPC functionality behind optional feature
//! flags to provide for client and server communication over specific protocols.
//! There are no default features, all functionality must be opted in accordingly.
//! There are no default features, all functionality must be opted in to accordingly.
//! The following features are avaliable.
//!
//! - **`http-client`** - JSON RPC client functionality over HTTP protocol.
//! - **`http-server`** - JSON RPC server functionality over HTTP protocol.
//! - **`ws-client`** - JSON RPC client functionality over WebSocket protocol.
//! - **`ws-server`** - JSON RPC server functionality over WebSocket protocol.
//! - **`macros`** - JSON RPC API generation convenience by derive macros.
//! - **`http-client`** - JSON-RPC client functionality over HTTP protocol.
//! - **`http-server`** - JSON-RPC server functionality over HTTP protocol.
//! - **`ws-client`** - JSON-RPC client functionality over WebSocket protocol.
//! - **`ws-server`** - JSON-RPC server functionality over WebSocket protocol.
//! - **`macros`** - JSON-RPC API generation convenience by derive macros.
//! - **`client`** - Enables `http-client` and `ws-client` features.
//! - **`server`** - Enables `http-server` and `ws-server` features.
//! - **`full`** - Enables `client`, `server` and `macros` features.
/// JSON RPC HTTP client.
/// JSON-RPC HTTP client.
#[cfg(feature = "jsonrpsee-http-client")]
pub use jsonrpsee_http_client as http_client;

/// JSON RPC WebSocket client.
/// JSON-RPC WebSocket client.
#[cfg(feature = "jsonrpsee-ws-client")]
pub use jsonrpsee_ws_client as ws_client;

/// JSON RPC HTTP server.
/// JSON-RPC HTTP server.
#[cfg(feature = "jsonrpsee-http-server")]
pub use jsonrpsee_http_server as http_server;

/// JSON RPC WebSocket server.
/// JSON-RPC WebSocket server.
#[cfg(feature = "jsonrpsee-ws-server")]
pub use jsonrpsee_ws_server as ws_server;

/// Set of RPC methods that can be mounted to the server.
#[cfg(any(feature = "http-server", feature = "ws-server"))]
pub use jsonrpsee_utils::server::rpc_module::{RpcModule, SubscriptionSink};

/// Procedural macros for JSON RPC implementations.
/// Procedural macros for JSON-RPC implementations.
#[cfg(feature = "jsonrpsee-proc-macros")]
pub use jsonrpsee_proc_macros as proc_macros;

/// Common types used to implement JSON RPC server and client
/// Common types used to implement JSON-RPC server and client.
#[cfg(feature = "jsonrpsee-types")]
pub use jsonrpsee_types as types;

0 comments on commit cf118e5

Please sign in to comment.