-
Notifications
You must be signed in to change notification settings - Fork 0
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
rusbの抽象化とドキュメントコメントの追加 #12
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
remove alert.
Feature/add cargo doc
This reverts commit c69aa64.
…actor Feature/add document and refactor
mituba3328
approved these changes
Jan 9, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nice Doc !
uchikun2493
approved these changes
Jan 9, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
見ました
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request includes several significant changes to the codebase, primarily focusing on restructuring the USB communication interface and enhancing documentation. The most important changes include the introduction of a new
usb
module, refactoring functions to use traits for USB handling, and adding detailed documentation for various modules and functions.Restructuring USB Communication Interface:
src/lib.rs
: Introduced a newusb
module and defined aUSBHandle
struct andUSBError
enum to standardize USB communication.src/blmd.rs
,src/md.rs
,src/sd.rs
: Refactored functions to use theUSBHandleTrait
for USB operations, replacing direct usage ofrusb::DeviceHandle
. [1] [2] [3]Enhancing Documentation:
src/lib.rs
: Added a library-level documentation comment providing an overview of the library's purpose and functionality.src/md.rs
,src/sd.rs
,src/blmd.rs
: Added detailed documentation comments for functions, including usage examples and descriptions of arguments and return values. [1] [2] [3]Workflow Improvements:
.github/workflows/rust.yml
: Created a new GitHub Actions workflow for building and deploying Rust documentation, including steps for building, running documentation, and deploying to GitHub Pages.