Skip to content

Commit 569dc6e

Browse files
committed
stake-contract: Add docs comments
1 parent 8e6bb49 commit 569dc6e

2 files changed

Lines changed: 288 additions & 22 deletions

File tree

contracts/stake/src/lib.rs

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,22 @@
44
//
55
// Copyright (c) DUSK NETWORK. All rights reserved.
66

7+
//! # Stake Contract Documentation
8+
//!
9+
//! This contract manages staking-related state for the Dusk Network,
10+
//! implementing core functions that facilitate the management of stakes,
11+
//! rewards and penalties.
12+
//!
13+
//! For a detailed explanation of staking mechanisms refer to the
14+
//! [Dusk Whitepaper](https://dusk-cms.ams3.digitaloceanspaces.com/Dusk_Whitepaper_2024_4db72f92a1.pdf)
15+
//! and [Dusk Documentation](https://docs.dusk.network).
16+
717
#![cfg_attr(target_family = "wasm", no_std)]
818
#![cfg(target_family = "wasm")]
919
#![feature(arbitrary_self_types)]
20+
#![deny(missing_docs)]
21+
#![deny(rustdoc::broken_intra_doc_links)]
22+
#![deny(clippy::pedantic)]
1023
#![deny(unused_crate_dependencies)]
1124
#![deny(unused_extern_crates)]
1225

0 commit comments

Comments
 (0)