Improve Code Documentation

This commit is contained in:
2024-05-25 16:25:03 -04:00
parent bb4e163f45
commit 1d5fa1b860
3 changed files with 52 additions and 8 deletions

View File

@@ -1,4 +1,13 @@
#[macro_use] extern crate log;
#![warn(missing_docs)]
//! sgtool is a library for analyze of the replay of the Stormgate game.
//!
//!
//! # Example
//! ```
//! let replay_path = "replay.SGReplay";
//! let mut buffer : Vec<u8> = vec![];
//! let replay : Replay = Replay::load_file(replay_path, &mut buffer)?;
//! ```
//!
pub mod parser;
mod protos;