G2/cross-usb
1
0
Fork 0
mirror of https://github.com/G2-Games/cross-usb.git synced 2025-04-18 12:52:53 -05:00
Code Issues Projects Releases Packages Wiki Activity

Fixed documentation errors

Browse source
This commit is contained in:
G2-Games 2024-02-08 03:04:49 -06:00
parent e5b0bcc731
commit 1b8df6ab26
3 changed files with 4 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
.gitignore vendored
View file

@ -7,5 +7,7 @@ wasm-pack.log
www
.xwin-cache/
.travis
.appveyor

2
src/lib.rs
View file

@ -60,7 +60,7 @@ pub use crate::context::UsbDevice;
pub use crate::context::UsbInterface;
/// Information about a USB device for finding it while trying
/// to look for new USB devices using [get_device_filter]
/// to look for new USB devices using [get_device]
#[doc(inline)]
pub use crate::context::DeviceFilter;

3
src/usb.rs
View file

@ -20,8 +20,7 @@ pub trait Device {
/// request a new device with [crate::get_device] or [crate::get_device_filter]
async fn reset(&self) -> Result<(), UsbError>;
/// Remove the device from the paired devices list, causing it to no longer be usable.
/// You must request to reconnect using [crate::get_device] or [crate::get_device_filter]
/// Remove the device from the paired devices list, causing it to no longer be usable. You must request to reconnect using [crate::get_device]
///
/// **Note: on Native with `nusb` this simply resets the device**
async fn forget(&self) -> Result<(), UsbError>;