From 8bd10e7c4c3c29d1d53ba6149277def210749ccf Mon Sep 17 00:00:00 2001 From: Greg Fitzgerald Date: Thu, 7 Jun 2018 14:51:29 -0600 Subject: [PATCH] Cleanup top-level lib doc --- src/lib.rs | 8 +++++--- src/sigverify.rs | 6 ++++++ src/thin_client.rs | 1 + 3 files changed, 12 insertions(+), 3 deletions(-) diff --git a/src/lib.rs b/src/lib.rs index cf30c5d81..78a954a16 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -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))] diff --git a/src/sigverify.rs b/src/sigverify.rs index 13d587aef..164c7dff4 100644 --- a/src/sigverify.rs +++ b/src/sigverify.rs @@ -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}; diff --git a/src/thin_client.rs b/src/thin_client.rs index d783d4b7b..58174ab73 100644 --- a/src/thin_client.rs +++ b/src/thin_client.rs @@ -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,