reordering the crate and addind more documentation and added the docs to the same repo

This commit is contained in:
ZennDev1337 2023-08-15 12:41:08 +02:00
parent 6fb155dff3
commit 34c781e882
1035 changed files with 11041 additions and 18 deletions

View file

@ -2,7 +2,7 @@
//!
//! All of the functions are safe wrapped inside the struct.
#![allow(dead_code)]
use crate::prelude::ButtonSet;
use crate::hardware::buttons::ButtonSet;
use crate::print::Printable;
use core::ffi::{c_char, c_int, c_long, c_size_t, c_uchar, c_uint, c_ulong};
use core::mem;
@ -66,7 +66,7 @@ impl Arduboy2 {
/// ```
/// const arduboy: Arduboy2 = Arduboy2::new();
/// ```
pub fn new() -> Self {
pub const fn new() -> Self {
Arduboy2 {}
}
/// Initialize the hardware, display the boot logo, provide boot utilities, etc.

View file

@ -1,6 +1,6 @@
//pub use crate::library::arduboy_tone_pitch::*;
//!This is the Module to interact in a save way with the ArduboyTones C++ library.
pub use crate::library::arduboy_tone_pitch;
use core::ffi::{c_uchar, c_uint, c_ulong};
extern "C" {
#[link_name = "sound_tone"]
fn sound_tone(frequency: c_uint, duration: c_ulong);
@ -40,7 +40,7 @@ impl ArduboyTones {
/// ```
/// const sound: ArduboyTones = ArduboyTones::new();
/// ```
pub fn new() -> ArduboyTones {
pub const fn new() -> ArduboyTones {
ArduboyTones {}
}
///Play a single tone.