docs: complete uORB and KVDB API documentation coverage#532
Merged
tanghao-xiaomi merged 1 commit intoopen-vela:devfrom May 8, 2026
Merged
docs: complete uORB and KVDB API documentation coverage#532tanghao-xiaomi merged 1 commit intoopen-vela:devfrom
tanghao-xiaomi merged 1 commit intoopen-vela:devfrom
Conversation
Collaborator
Author
|
/check-cla |
✅ CLA Verification Complete@tanghao-xiaomi All contributors have signed the CLA!
📋 View detailed check results: Action Run #25548324325 Your pull request can now proceed with the review process! 🎉 |
Bring both uorb.md and kvdb.md to 100% coverage of their public headers
following the openvela API documentation standard.
uorb.md:
- Add 18 previously missing core APIs, including orb_advertise,
orb_advertise_multi, orb_advertise_queue, orb_advertise_multi_queue,
orb_advertise_multi_queue_persist_info, orb_publish, orb_publish_auto,
orb_subscribe, orb_subscribe_wakeup, orb_subscribe_multi_wakeup,
orb_copy, orb_unlink, orb_absolute_time, orb_set_interval,
orb_get_interval, orb_set_frequency, orb_get_frequency
- Fix duplicate '## 发布接口' empty heading
- Correct '### orb_scanf' title to '### orb_sscanf' (signature was
already correct, only the title was wrong)
kvdb.md:
- Add previously missing property_list_binary API
- Split four composite sections so each public API has its own
'### name' entry (per api-doc-standards.md):
* property_get_bool/int32/int64_with_err -> 3 separate entries
* property_set_bool/int32/int64 -> 3 separate entries
* property_set_bool/int32/int64_oneway -> 3 separate entries
* property_set_buffer / property_set_buffer_oneway -> 2 separate entries
Coverage:
- uorb.md: 48 / 48 public APIs in apps/system/uorb/uORB/uORB.h (100%)
- kvdb.md: 31 / 31 public APIs in frameworks/system/utils/include/
kvdb.h + cutils/properties.h (100%)
Both files retain their existing openvela implementation notes and
functional grouping; all new sections follow the same format (Chinese
description, **参数** list, **返回值** section).
Every new signature has been verified against the source headers.
265ec81 to
fff4db4
Compare
TangMeng12
approved these changes
May 8, 2026
aiduxiaoxiong
approved these changes
May 8, 2026
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
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.
Overview
Bring
uorb.mdandkvdb.mdto 100% coverage of their public headers, filling in the APIs that were previously missing from the earlier pass.Coverage
apps/system/uorb/uORB/uORB.hframeworks/system/utils/include/kvdb.h+cutils/properties.hMain Changes
uorb.mdorb_advertise,orb_advertise_multi,orb_advertise_queue,orb_advertise_multi_queue,orb_advertise_multi_queue_persist_info,orb_publish,orb_publish_auto,orb_subscribe,orb_subscribe_wakeup,orb_subscribe_multi_wakeup,orb_copy,orb_unlink,orb_absolute_time,orb_set_interval,orb_get_interval,orb_set_frequency,orb_get_frequency, plus minor entries.## 发布接口heading.### orb_scanftitle to### orb_sscanf(the signature inside the code block was alreadyorb_sscanf; only the heading was inconsistent).kvdb.mdproperty_list_binary(binary-value iteration).### nameentry, perapi-doc-standards.md:property_get_bool/int32/int64_with_err→ 3 entriesproperty_set_bool/int32/int64→ 3 entriesproperty_set_bool/int32/int64_oneway→ 3 entriesproperty_set_buffer / property_set_buffer_oneway→ 2 entriesQuality
**参数**:list, and a**返回值**:section.Placement Rationale
Both files stay in
framework/(notkernel/) because:apps/system/uorb/, a userspace framework component, notnuttx/kernel.frameworks/system/utils/, also userspace.framework/index.md.Statistics
2 files changed, +1156 / -262 lines.