mirror of
https://github.com/QRouland/SGTool.git
synced 2026-08-23 17:26:58 +00:00
Improve Code Documentation
This commit is contained in:
13
src/lib.rs
13
src/lib.rs
@@ -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;
|
||||
Reference in New Issue
Block a user