Fix broken intra-doc links + add CI stage to test example docs

.gitlab-ci.yml

@@ -264,6 +264,20 @@ examples-contract-build:
         popd;
       done
 
+examples-docs:
+    stage:                           examples
+    <<:                              *docker-env
+    variables:
+        RUSTDOCFLAGS: -Dwarnings
+    script:
+        # `--document-private-items` needs to be in here because currently our contract macro
+        # puts the contract functions in a private module.
+        # Once https://github.com/paritytech/ink/issues/336 has been implemented we can get rid
+        # of this flag.
+        - for example in examples/*/; do
+            cargo doc --manifest-path ${example}/Cargo.toml --document-private-items --verbose --no-deps;
+          done
+
 #### stage:                        publish
 
 publish-docs:

crates/env/src/backend.rs

@@ -28,6 +28,9 @@ use crate::{
 };
 use ink_primitives::Key;
 
+#[cfg(doc)]
+use crate as ink_env;
+
 /// The flags to indicate further information about the end of a contract execution.
 pub struct ReturnFlags {
     value: u32,
@@ -165,7 +168,7 @@ pub trait TypedEnvBackend: EnvBackend {
     ///
     /// # Note
     ///
-    /// For more details visit: [`ink_env::gas_price`]
+    /// For more details visit: [`ink_env::weight_to_fee`]
     fn weight_to_fee<T: Environment>(&mut self, gas: u64) -> Result<T::Balance>;
 
     /// Returns the amount of gas left for the contract execution.

crates/env/src/engine/off_chain/db/block.rs

@@ -34,7 +34,7 @@ pub struct Block {
     /// # Note
     ///
     /// - Can optionally be set for more control via
-    ///   [`crate::set_block_randomization_hash`].
+    ///   [`crate::test::set_block_entropy`].
     entropy: OffHash,
 }
 

crates/lang/codegen/src/generator/cross_calling.rs

@@ -140,7 +140,7 @@ impl CrossCalling<'_> {
         }
     }
 
-    /// Builds up the [`ink_env::call::ArgumentList`] type structure for the given types.
+    /// Builds up the `ink_env::call::utils::ArgumentList` type structure for the given types.
     fn generate_arg_list<'a, Args>(args: Args) -> TokenStream2
     where
         Args: IntoIterator<Item = &'a syn::Type>,

crates/storage/src/collections/bitstash/mod.rs

@@ -32,6 +32,9 @@ use crate::collections::{
     Vec as StorageVec,
 };
 
+#[cfg(doc)]
+use crate::collections::Bitvec;
+
 /// The index type used in the storage bit stash.
 type Index = u32;
 

crates/storage/src/collections/smallvec/mod.rs

@@ -39,6 +39,9 @@ use crate::{
     traits::PackedLayout,
 };
 
+#[cfg(doc)]
+use crate::traits::SpreadLayout;
+
 /// The used index type.
 type Index = u32;
 

crates/storage/src/collections/stash/mod.rs

@@ -33,6 +33,9 @@ use crate::{
 };
 use ink_primitives::Key;
 
+#[cfg(doc)]
+use crate::traits::SpreadLayout;
+
 /// An index into the stash.
 type Index = u32;
 

crates/storage/src/collections/vec/mod.rs

@@ -36,6 +36,9 @@ use crate::{
     traits::PackedLayout,
 };
 
+#[cfg(doc)]
+use crate::traits::SpreadLayout;
+
 /// A contiguous growable array type, written `Vec<T>` but pronounced 'vector'.
 ///
 /// # Note

crates/storage/src/lazy/entry.rs

@@ -15,6 +15,7 @@
 #[cfg(doc)]
 use crate::lazy::{
     LazyArray,
+    LazyCell,
     LazyIndexMap,
 };
 use crate::traits::{

crates/storage/src/lazy/lazy_hmap.rs

@@ -54,6 +54,9 @@ use ink_prelude::{
 };
 use ink_primitives::Key;
 
+#[cfg(doc)]
+use crate::lazy::LazyIndexMap;
+
 /// The map for the contract storage entries.
 ///
 /// # Note

examples/dns/lib.rs

@@ -59,7 +59,7 @@ mod dns {
     }
 
     /// Domain name service contract inspired by ChainX's [blog post]
-    /// (https://medium.com/@chainx_org/secure-and-decentralized-polkadot-domain-name-system-e06c35c2a48d).
+    /// (<https://medium.com/@chainx_org/secure-and-decentralized-polkadot-domain-name-system-e06c35c2a48d>).
     ///
     /// # Note
     ///