feat: [US-049] API documentation and examples#16
Merged
Conversation
Add comprehensive API documentation and three example programs: - Crate-level docs with quick start, options, and in-memory examples - Doc comments for all previously undocumented public items - examples/simple_convert.rs, custom_options.rs, from_bytes.rs - 3 doc tests pass (cargo test --doc) Signed-off-by: Yonghye Kwon <developer.0hye@gmail.com>
Signed-off-by: Yonghye Kwon <developer.0hye@gmail.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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
# Errorssectionssimple_convert.rs,custom_options.rs,from_bytes.rsKey Changes
crates/office2pdf/src/lib.rs: Crate-level docs, enhanced function documentationcrates/office2pdf/src/ir/style.rs: Color method doc commentscrates/office2pdf/src/parser/{docx,pptx,xlsx}.rs: Parser struct doc commentscrates/office2pdf/examples/: Three new example programsTest Plan
cargo test --docpasses (3 doc tests)cargo doc -p office2pdf --no-depsproduces clean docs (no warnings)cargo build --examplescompiles all examplescargo test --workspacepasses (485 lib + 7 CLI + 3 doc = 495 tests)cargo clippy --workspace -- -D warningspassescargo fmt --all -- --checkpasses🤖 Generated with Claude Code