Merge pull request #77 from ralexstokes/add-docs

add/hide docs so all public items are documented

ssz-rs-test-gen/src/main.rs

@@ -1,3 +1,5 @@
+#![doc(hidden)]
+
 use convert_case::{Case, Casing};
 use num_bigint::BigUint;
 use std::{collections::BTreeMap, env, ffi::OsStr, fmt, fs, fs::DirEntry, path::PathBuf};

ssz-rs/src/de.rs

@@ -9,15 +9,10 @@ use crate::{
 #[derive(Debug)]
 pub enum DeserializeError {
     /// More data was expected to be in the buffer.
-    ExpectedFurtherInput {
-        provided: usize,
-        expected: usize,
-    },
+    ExpectedFurtherInput { provided: usize, expected: usize },
     /// The buffer contained more data than expected.
-    AdditionalInput {
-        provided: usize,
-        expected: usize,
-    },
+    AdditionalInput { provided: usize, expected: usize },
+    /// An invalid byte was encountered when deserializing the given type
     InvalidByte(u8),
     /// An invalid instance was encountered.
     InvalidInstance(InstanceError),
@@ -26,10 +21,7 @@ pub enum DeserializeError {
     /// The number of bytes used for length offsets wasn't a multiple of BYTES_PER_LENGTH_OFFSET.
     InvalidOffsetsLength(usize),
     /// An offset was found with start > end.
-    OffsetNotIncreasing {
-        start: usize,
-        end: usize,
-    },
+    OffsetNotIncreasing { start: usize, end: usize },
 }
 
 impl From<InstanceError> for DeserializeError {

ssz-rs/src/merkleization/mod.rs

@@ -12,14 +12,18 @@ pub use proofs::is_valid_merkle_branch;
 
 pub(crate) const BYTES_PER_CHUNK: usize = 32;
 
+/// A `Merkleized` type provides a "hash tree root" following the SSZ spec.
 pub trait Merkleized {
     /// Compute the "hash tree root" of `Self`.
     fn hash_tree_root(&mut self) -> Result<Node, MerkleizationError>;
 }
 
+/// An error encountered during merkleization.
 #[derive(Debug)]
 pub enum MerkleizationError {
+    /// An error serializing a type while computing the hash tree.
     SerializationError(SerializeError),
+    /// More data was provided than expected
     InputExceedsLimit(usize),
 }
 

ssz-rs/src/uint.rs

@@ -72,6 +72,7 @@ define_uint!(u64);
 define_uint!(u128);
 define_uint!(usize);
 
+/// An unsigned integer represented by 256 bits
 #[derive(Default, Debug, PartialEq, Eq, Clone, PartialOrd, Ord, Hash)]
 pub struct U256(BigUint);