UPDATE: Adds a bunch of documentation and examples
This commit is contained in:
@@ -1,4 +1,24 @@
|
||||
#![deny(clippy::unwrap_used)]
|
||||
//! # IronCalcBase engine API
|
||||
//!
|
||||
//! This is the documentation for the base engine API.
|
||||
//!
|
||||
//! # Basic usage
|
||||
//!
|
||||
//! Add the dependency in Cargo.toml:
|
||||
//!
|
||||
//! ```toml
|
||||
//! [dependencies]
|
||||
//! ironcalc_base = { git = "https://github.com/ironcalc/IronCalc", version = "0.1"}
|
||||
//! ```
|
||||
//!
|
||||
//! <small> until version 0.5.0 you should use the git dependencies as stated </small>
|
||||
//!
|
||||
//! In this example we use the excel function `CONCAT` to concatenate strings in cells `A1` and `B1`:
|
||||
//!
|
||||
//! ```rust
|
||||
#![doc = include_str!("../examples/hello_world.rs")]
|
||||
//! ```
|
||||
|
||||
pub mod calc_result;
|
||||
pub mod cell;
|
||||
pub mod expressions;
|
||||
|
||||
Reference in New Issue
Block a user