Rust API : Slight docs improvements

1 files changed, 31 insertions, 3 deletions

diff --git a/rust/src/logger.rs b/rust/src/logger.rs
index 2b067892..eab0c647 100644
--- a/rust/src/logger.rs
+++ b/rust/src/logger.rs
@@ -1,12 +1,40 @@
-use std::os::raw::{c_char, c_void};
-
-use log;
+//! To use logging in your script, do something like:
+//!
+//! ```
+//! use binaryninja::logger;
+//! use log::{info, LevelFilter};
+//!
+//! fn main() {
+//!     logger::init(LevelFilter::Warn).expect("Unable to initialize logger");
+//!     info!("The logger has been initialized!");
+//!     // Your code here...
+//! }
+//! ```
+//!
+//! or
+//!
+//!```
+//! use binaryninja::logger;
+//! use log::{info, LevelFilter};
+//!
+//! #[no_mangle]
+//! pub extern "C" fn CorePluginInit() -> bool {
+//!     logger::init(LevelFilter::Warn).expect("Unable to initialize logger");
+//!     info!("The logger has been initialized!");
+//!     // Your code here...
+//!     true
+//! }
+//! ```
+//!
 
 use crate::string::BnStr;
 
 pub use binaryninjacore_sys::BNLogLevel as Level;
 use binaryninjacore_sys::{BNLogListener, BNUpdateLogListeners};
 
+use log;
+use std::os::raw::{c_char, c_void};
+
 struct Logger;
 static LOGGER: Logger = Logger;