docs: refactor and enhance bluetooth API documentation#548
Closed
tanghao-xiaomi wants to merge 1 commit into
Closed
docs: refactor and enhance bluetooth API documentation#548tanghao-xiaomi wants to merge 1 commit into
tanghao-xiaomi wants to merge 1 commit into
Conversation
- Hand-write all 222 bluetooth APIs across 11 files, replacing 15 Doxygen directives - Add 3 new files: bt_device.md (72 APIs), bt_le_scan.md (7 APIs), bt_le_advertiser.md (7 APIs) - Generate briefs from source code context, not header comments - Translate all descriptions to Chinese, keep technical terms in English - Ensure all params match function signatures exactly - Add openvela implementation notes for each sub-module - Reorganize index.md with functional grouping
tanghao-xiaomi
requested review from
TangMeng12,
aiduxiaoxiong,
smile0425 and
yanxingyu17
as code owners
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.
Note: Please adhere to Contributing Guidelines.
Summary
Update this section with information on why change is necessary,
what it exactly does and how, if new feature shows up, provide
references (dependencies, similar problems and solutions), etc.
Impact
Update this section, where applicable, on how change affects users,
build process, hardware, documentation, security, compatibility, etc.
Testing
Update this section with details on how did you verify the change,
what Host was used for build (OS, CPU, compiler, ..), what Target was
used for verification (arch, board:config, ..), etc. Providing build
and runtime logs from before and after change is highly appreciated.