docs: add comprehensive API documentation for all crates #28
Conversation
This file contains hidden or 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
- Fix Cargo.toml categories to use valid crates.io categories - Add module-level documentation for all public modules - Add documentation for public structs, enums, and functions - Add usage examples in doc comments where appropriate Modules documented: - build/mod.rs, cargo_builder.rs, config.rs - ctx.rs - run/mod.rs, qemu.rs, tftp.rs - sterm/mod.rs - menuconfig.rs - utils.rs
- Add crate-level documentation with usage examples - Add module-level documentation for data module - Document public structs, enums, and functions - Add field-level documentation for configuration types Modules documented: - lib.rs - run.rs - data/mod.rs, app_data.rs, item.rs, menu.rs, oneof.rs, schema.rs, types.rs
- Add crate-level documentation with usage examples - Improve README.md with better structure and examples - Document public structs, enums, and functions - Add documentation for compression and FIT image modules Modules documented: - lib.rs - compression/mod.rs, gzip.rs, traits.rs - fit/mod.rs, config.rs, fdt_header.rs - error.rs
- Add crate-level documentation with usage examples - Update README.md with improved examples - Document public structs and methods for UbootShell - Add documentation for YMODEM protocol implementation - Document CRC utilities Modules documented: - lib.rs - ymodem.rs - crc.rs
Add comprehensive .gitignore for Rust projects including: - Cargo build artifacts (target/, debug/) - IDE directories (.idea/, .vscode/) - OS generated files (.DS_Store, Thumbs.db) - Coverage and profiling files - Environment files
Restore the original .gitignore that includes project-specific entries like .qemu.toml, .uboot.toml, and schema files that were accidentally removed in 4ab467c. Restored entries: - /.vscode - /.project* - .spec-workflow - .claude - .*-schema.json - .qemu.toml - .uboot.toml
Member
|
please fix ci err |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
Changes
ostool
jkconfig
fitimage
uboot-shell