Documentation.

substrate/wasm-runtime/polkadot/src/codec/endiansensitive.rs

@@ -1,3 +1,22 @@
+// Copyright 2017 Parity Technologies (UK) Ltd.
+// This file is part of Polkadot.
+
+// Polkadot is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// Polkadot is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with Polkadot.  If not, see <http://www.gnu.org/licenses/>.
+
+//! Endian manager.
+
+/// Trait to allow conversion to a know endian representation when sensitive.
 pub trait EndianSensitive: Sized {
 	fn to_le(self) -> Self { self }
 	fn to_be(self) -> Self { self }

substrate/wasm-runtime/polkadot/src/codec/joiner.rs

@@ -1,6 +1,25 @@
+// Copyright 2017 Parity Technologies (UK) Ltd.
+// This file is part of Polkadot.
+
+// Polkadot is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// Polkadot is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with Polkadot.  If not, see <http://www.gnu.org/licenses/>.
+
+//! Vec<u8> serialiser.
+
 use runtime_support::Vec;
 use slicable::Slicable;
 
+/// Trait to allow itself to be serialised into a `Vec<u8>`
 pub trait Joiner {
 	fn join<T: Slicable + Sized>(self, value: &T) -> Self;
 }

substrate/wasm-runtime/polkadot/src/codec/keyedvec.rs

@@ -1,6 +1,25 @@
+// Copyright 2017 Parity Technologies (UK) Ltd.
+// This file is part of Polkadot.
+
+// Polkadot is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// Polkadot is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with Polkadot.  If not, see <http://www.gnu.org/licenses/>.
+
+//! Serialiser and prepender.
+
 use runtime_support::Vec;
 use slicable::Slicable;
 
+/// Trait to allow itselg to be serialised and prepended by a given slice.
 pub trait KeyedVec {
 	fn to_keyed_vec(&self, prepend_key: &[u8]) -> Vec<u8>;
 }

substrate/wasm-runtime/polkadot/src/codec/mod.rs

@@ -1,3 +1,21 @@
+// Copyright 2017 Parity Technologies (UK) Ltd.
+// This file is part of Polkadot.
+
+// Polkadot is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// Polkadot is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with Polkadot.  If not, see <http://www.gnu.org/licenses/>.
+
+//! Codec utils.
+
 pub mod endiansensitive;
 pub mod streamreader;
 pub mod joiner;

substrate/wasm-runtime/polkadot/src/codec/slicable.rs

@@ -1,3 +1,21 @@
+// Copyright 2017 Parity Technologies (UK) Ltd.
+// This file is part of Polkadot.
+
+// Polkadot is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// Polkadot is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with Polkadot.  If not, see <http://www.gnu.org/licenses/>.
+
+//! Serialisation.
+
 use runtime_support::{Vec, size_of, transmute, uninitialized, slice};
 use joiner::Joiner;
 use endiansensitive::EndianSensitive;
@@ -22,6 +40,7 @@ pub trait Slicable: Sized {
 	fn size_of(_value: &[u8]) -> Option<usize>;
 }
 
+/// Trait to mark that a type is not trivially (essentially "in place") serialisable.
 pub trait NonTrivialSlicable: Slicable {}
 
 impl<T: EndianSensitive> Slicable for T {

substrate/wasm-runtime/polkadot/src/codec/streamreader.rs

@@ -1,17 +1,39 @@
+// Copyright 2017 Parity Technologies (UK) Ltd.
+// This file is part of Polkadot.
+
+// Polkadot is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// Polkadot is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with Polkadot.  If not, see <http://www.gnu.org/licenses/>.
+
+//! Deserialiser.
+
 use slicable::Slicable;
 
+/// Simple deserialiser.
 pub struct StreamReader<'a> {
 	data: &'a[u8],
 	offset: usize,
 }
 
 impl<'a> StreamReader<'a> {
+	/// Create a new deserialiser based on the `data`.
 	pub fn new(data: &'a[u8]) -> Self {
 		StreamReader {
 			data: data,
 			offset: 0,
 		}
 	}
+
+	/// Deserialise a single item from the data stream.
 	pub fn read<T: Slicable>(&mut self) -> Option<T> {
 		let size = T::size_of(&self.data[self.offset..])?;
 		let new_offset = self.offset + size;