Skip to content
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
merged 27 commits into from
Jan 9, 2025
Merged

Conversation

sarukiti
Copy link
Contributor

@sarukiti sarukiti commented Jan 9, 2025

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 new usb module and defined a USBHandle struct and USBError enum to standardize USB communication.
  • src/blmd.rs, src/md.rs, src/sd.rs: Refactored functions to use the USBHandleTrait for USB operations, replacing direct usage of rusb::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.

sarukiti and others added 27 commits December 26, 2024 17:42
Copy link

@mituba3328 mituba3328 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice Doc !

@sarukiti sarukiti changed the title Develop rusbの抽象化とドキュメントコメントの追加 Jan 9, 2025
Copy link

@uchikun2493 uchikun2493 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

見ました

@sarukiti sarukiti merged commit dde82e3 into master Jan 9, 2025
3 checks passed
@sarukiti sarukiti deleted the develop branch January 9, 2025 09:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants