playdate-sys docs improvements

api/sys/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "playdate-sys"
-version = "0.2.15"
+version = "0.2.16"
 build = "src/build.rs"
 readme = "README.md"
 description = "Low-level Playdate API bindings"

api/sys/src/log.rs

@@ -1,3 +1,5 @@
+//! `println` function.
+
 use core::ffi::c_char;
 use alloc::ffi::CString;
 

api/sys/src/sys/allocator.rs

@@ -1,4 +1,7 @@
 #![cfg(not(test))]
+//! Global Allocator implementation. Depends on `allocator` feature.
+
+
 /*
 With rust-lang/rust#102318 default_alloc_error_handler has been stabilized,
 ie. the default error handler is enabled by default.

api/sys/src/sys/error/mod.rs

@@ -1,3 +1,5 @@
+//! Typed API errors.
+
 use core::any::Any;
 use core::convert::Infallible;
 use core::fmt;

api/sys/src/sys/macros.rs

@@ -1,5 +1,8 @@
+//! Helper macros for API access.
+
+
 #[macro_export]
-/// Print line to stdout, simulator's console or device's output.
+/// Print line to stdout, simulator's console or device's output channel.
 ///
 /// Woks like [`std::println!`](https://doc.rust-lang.org/std/macro.println.html).
 macro_rules! println {

api/sys/src/sys/panic.rs

@@ -1,5 +1,6 @@
 #![cfg(not(test))]
 #![cfg(feature = "panic-handler")]
+//! Global Panic Handler implementation. Depends on `panic-handler` feature.
 
 use core::panic::PanicInfo;
 use core::fmt::Write;

api/sys/src/sys/proc.rs

@@ -1,8 +1,11 @@
+//! Process API. Abort and abort with error message.
+
 /// Executes the undefined instruction (UDF) and causes a CPU-level exception.
 /// See [`core::intrinsics::abort()`]
 pub fn abort() -> ! { core::intrinsics::abort() }
 
 
+/// Stops the program execution with custom system-level error.
 #[track_caller]
 pub fn error<S: AsRef<str>>(text: S) -> ! {
 	if let Some(f) = unsafe { (*(*crate::sys::API).system).error } {