Fix and update documentation. 0.2.1

vitalyvb · Apr 12, 2024 · 29013a0 · 29013a0
1 parent cbf81ae
commit 29013a0
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 5 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.2.1] - 2024-04-13
+
+### Fixed
+- Outdated documentation
+
 ## [0.2.0] - 2024-04-12
 
 ### Added
@@ -22,6 +27,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 First version.
 
-[Unreleased]: https://github.com/vitalyvb/usbd-class-tester/compare/v0.2.0...HEAD
+[Unreleased]: https://github.com/vitalyvb/usbd-class-tester/compare/v0.2.1...HEAD
+[0.2.1]: https://github.com/vitalyvb/usbd-class-tester/compare/v0.2.0...v0.2.1
 [0.2.0]: https://github.com/vitalyvb/usbd-class-tester/compare/v0.1.0...v0.2.0
 [0.1.0]: https://github.com/vitalyvb/usbd-class-tester/releases/tag/v0.1.0
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "usbd-class-tester"
-version = "0.2.0"
+version = "0.2.1"
 edition = "2021"
 
 description = "Library for testing usb-device device classes."

diff --git a/src/lib.rs b/src/lib.rs
@@ -25,16 +25,14 @@
 //! ### Supported operations
 //!
 //! * IN and OUT EP0 control transfers
+//! * Transfers on other endpoints (e.g. Interrupt)
 //!
 //! ### Not supported operations
 //!
 //! Almost everything else, including but not limited to:
 //!
-//! * Endpoints other than EP0 in `EmulatedUsbBus::poll()`
-//! * Endpoint allocation in `EmulatedUsbBus::alloc_ep()`
 //! * Reset
 //! * Suspend and Resume
-//! * Interrupt transfers
 //! * Bulk transfers
 //! * Iso transfers
 //! * ...
@@ -437,6 +435,8 @@ where
     /// Perform Endpoint Device-to-host data transfer
     /// on a given endpoint index `ep_index` of a
     /// maximum size `length`.
+    ///
+    /// Returns a Vec[u8] with data.
     pub fn ep_read(
         &mut self,
         cls: &mut C,
@@ -458,6 +458,9 @@ where
     /// Perform Endpoint Host-to-device data transfer
     /// on a given endpoint index `ep_index` and
     /// with `data`.
+    ///
+    /// Returns number of bytes that was loaded into
+    /// Endpoint buffer.
     pub fn ep_write(
         &mut self,
         cls: &mut C,