some code documentation

This commit is contained in:
Christoph J. Scherr 2023-05-08 01:30:28 +02:00
parent 0e6fe6eda7
commit 02927ebdc6
Signed by: PlexSheep
GPG Key ID: 25B4ACF7D88186CC
4 changed files with 21 additions and 4 deletions

View File

@ -1,8 +1,8 @@
#![allow(dead_code)]
/// binary functions
/// # binary module
///
/// This module contains some functions that manipulate binary values.
///
/// ___
/// Author: Christoph J. Scherr <software@cscherr.de>
/// License: MIT
/// Source: <https://git.cscherr.de/PlexSheep/plexcryptool/>

View File

@ -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 <software@cscherr.de>
//!

View File

@ -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 <software@cscherr.de>
//!

View File

@ -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 <software@cscherr.de>
/// License: MIT
/// Source: <https://git.cscherr.de/PlexSheep/plexcryptool/>
pub mod modexp;