diff --git a/src/binary/mod.rs b/src/binary/mod.rs index e7c378d..20916df 100644 --- a/src/binary/mod.rs +++ b/src/binary/mod.rs @@ -1,8 +1,8 @@ -#![allow(dead_code)] -/// binary functions +/// # binary module /// /// This module contains some functions that manipulate binary values. /// +/// ___ /// Author: Christoph J. Scherr /// License: MIT /// Source: diff --git a/src/lib.rs b/src/lib.rs index f489ba7..63bb029 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,11 +1,17 @@ #![warn(missing_docs)] #![warn(clippy::missing_docs_in_private_items)] -//! # various tools for use in cryptology contexts //! //! This is a mixed rust/python library that also offers an executable. //! The intended usage is the solving of tasks for cryptology and maybe math, in the context of a +//! # various tools for use in cryptology contexts //! university degree. I wrote this for cryptology at DHBW Mannheim. //! +//! ## main function +//! This project contains an executable, see [main.rs](main.rs) +//! +//! ## lib module +//! This project contains is a library, see [lib.rs](lib.rs). +//! Note that this library offers Python bindings using [PyO3](pyo3.rs) //! ___ //! Author: Christoph J. Scherr //! diff --git a/src/main.rs b/src/main.rs index f3d58ef..21d7e1b 100644 --- a/src/main.rs +++ b/src/main.rs @@ -6,6 +6,12 @@ //! # various tools for use in cryptology contexts //! university degree. I wrote this for cryptology at DHBW Mannheim. //! +//! ## main function +//! This project contains an executable, see [main.rs](main.rs) +//! +//! ## lib module +//! This project contains is a library, see [lib.rs](lib.rs). +//! Note that this library offers Python bindings using [PyO3](pyo3.rs) //! ___ //! Author: Christoph J. Scherr //! diff --git a/src/math/mod.rs b/src/math/mod.rs index d77d4bc..0dfe59f 100644 --- a/src/math/mod.rs +++ b/src/math/mod.rs @@ -1,4 +1,9 @@ /// # math module /// -/// funcionality for math things. Contains tedious algorithms like binary exponentiation. +/// Funcionality for math things. Contains tedious algorithms like binary exponentiation. +/// +/// ___ +/// Author: Christoph J. Scherr +/// License: MIT +/// Source: pub mod modexp;