Skip to content

Commit

Permalink
Cleanup top-level lib doc
Browse files Browse the repository at this point in the history
  • Loading branch information
garious committed Jun 7, 2018
1 parent 928e616 commit 8bd10e7
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 3 deletions.
8 changes: 5 additions & 3 deletions src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
//! The `solana` library implements the Solana high-performance blockchain architecture.
//! It includes a full Rust implementation of the architecture as well as hooks to GPU
//! implementations of its most paralellizable components. It also includes command-line
//! tools to spin up fullnodes and a Rust library `thin_client` to interact with them.
//! It includes a full Rust implementation of the architecture (see
//! [Server](server/struct.Server.html)) as well as hooks to GPU implementations of its most
//! paralellizable components (i.e. [SigVerify](sigverify/index.html)). It also includes
//! command-line tools to spin up fullnodes and a Rust library
//! (see [ThinClient](thin_client/struct.ThinClient.html)) to interact with them.
//!
#![cfg_attr(feature = "unstable", feature(test))]
Expand Down
6 changes: 6 additions & 0 deletions src/sigverify.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
//! The `sigverify` module provides digital signature verification functions.
//! By default, signatures are verified in parallel using all available CPU
//! cores. When `--features=cuda` is enabled, signature verification is
//! offloaded to the GPU.
//!
use packet::{Packet, SharedPackets};
use std::mem::size_of;
use transaction::{PUB_KEY_OFFSET, SIGNED_DATA_OFFSET, SIG_OFFSET};
Expand Down
1 change: 1 addition & 0 deletions src/thin_client.rs
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ use std::io;
use std::net::{SocketAddr, UdpSocket};
use transaction::Transaction;

/// An object for querying and sending transactions to the network.
pub struct ThinClient {
requests_addr: SocketAddr,
requests_socket: UdpSocket,
Expand Down

0 comments on commit 8bd10e7

Please sign in to comment.