Formatting changes.

Adds blocks to break up the structure.

Author: thejpster

src/lib.rs

@@ -55,6 +55,9 @@ pub const API_VERSION: Version = Version::new(0, 6, 1);
 /// function.
 #[repr(C)]
 pub struct Api {
+	// ========================================================================
+	// Version and Metadata
+	// ========================================================================
 	/// Gets the version number of the BIOS API.
 	///
 	/// You need this value to determine which of the following API calls are
@@ -69,6 +72,10 @@ pub struct Api {
 	/// a Rust string. It is unspecified as to whether the string is located
 	/// in Flash ROM or RAM (but it's likely to be Flash ROM).
 	pub bios_version_get: extern "C" fn() -> ApiString<'static>,
+
+	// ========================================================================
+	// Serial Port Support
+	// ========================================================================
 	/// Get information about the Serial ports in the system.
 	///
 	/// Serial ports are ordered octet-oriented pipes. You can push octets
@@ -106,6 +113,10 @@ pub struct Api {
 		data: ApiBuffer,
 		timeout: crate::Option<Timeout>,
 	) -> crate::Result<usize>,
+
+	// ========================================================================
+	// Time Support
+	// ========================================================================
 	/// Get the current wall time.
 	///
 	/// The Neotron BIOS does not understand time zones, leap-seconds or the
@@ -137,6 +148,9 @@ pub struct Api {
 	/// Report the system tick rate, in ticks-per-second.
 	pub time_ticks_per_second: extern "C" fn() -> Ticks,
 
+	// ========================================================================
+	// Persistent Configuration Support
+	// ========================================================================
 	/// Get the configuration data block.
 	///
 	/// Configuration data is, to the BIOS, just a block of bytes of a given
@@ -147,6 +161,10 @@ pub struct Api {
 	///
 	/// See `configuration_get`.
 	pub configuration_set: extern "C" fn(buffer: ApiByteSlice) -> crate::Result<()>,
+
+	// ========================================================================
+	// Video Output Support
+	// ========================================================================
 	/// Does this Neotron BIOS support this video mode?
 	pub video_is_valid_mode: extern "C" fn(mode: video::Mode) -> bool,
 	/// Does this Neotron BIOS require extra VRAM (passed with
@@ -263,6 +281,9 @@ pub struct Api {
 	pub video_set_whole_palette:
 		unsafe extern "C" fn(start: *const video::RGBColour, length: usize),
 
+	// ========================================================================
+	// Memory Region Support
+	// ========================================================================
 	/// Find out about regions of memory in the system.
 	///
 	/// The first region (index `0`) must be the 'application region' which is
@@ -280,12 +301,20 @@ pub struct Api {
 	/// application space available). The OS will prefer lower numbered regions
 	/// (other than Region 0), so faster memory should be listed first.
 	pub memory_get_region: extern "C" fn(region_index: u8) -> crate::Result<types::MemoryRegion>,
+
+	// ========================================================================
+	// Human Interface Device Support
+	// ========================================================================
 	/// Get the next available HID event, if any.
 	///
 	/// This function doesn't block. It will return `Ok(None)` if there is no event ready.
 	pub hid_get_event: extern "C" fn() -> crate::Result<crate::Option<hid::HidEvent>>,
 	/// Control the keyboard LEDs.
 	pub hid_set_leds: extern "C" fn(leds: hid::KeyboardLeds) -> crate::Result<()>,
+
+	// ========================================================================
+	// I²C Bus Support
+	// ========================================================================
 	/// Get information about the I²C Buses in the system.
 	///
 	/// I²C Bus 0 should be the one connected to the Neotron Bus.
@@ -317,6 +346,10 @@ pub struct Api {
 		tx2: ApiByteSlice,
 		rx: ApiBuffer,
 	) -> crate::Result<()>,
+
+	// ========================================================================
+	// Audio Support
+	// ========================================================================
 	/// Get information about the Audio Mixer channels
 	pub audio_mixer_channel_get_info:
 		extern "C" fn(audio_mixer_id: u8) -> crate::Result<audio::MixerChannelInfo>,
@@ -406,6 +439,10 @@ pub struct Api {
 	/// How many samples in the current format can be read right now using
 	/// `audio_input_data`?
 	pub audio_input_get_count: extern "C" fn() -> crate::Result<usize>,
+
+	// ========================================================================
+	// Neotron (SPI) Bus Support
+	// ========================================================================
 	/// Select a Neotron Bus Peripheral. This drives the SPI chip-select line
 	/// low for that peripheral. Selecting a peripheral de-selects any other
 	/// peripherals. Select peripheral 'None' to select no peripherals. If

src/video.rs

@@ -152,7 +152,7 @@ pub struct TextBackgroundColour(u8);
 pub struct Attr(pub u8);
 
 /// Represents a glyph/attribute pair.
-/// 
+///
 /// This is what out text console is made out of. They work in exactly the same
 /// way as IBM PC VGA.
 #[repr(transparent)]