Skip to content

docs: refactor and enhance pthread API documentation#521

Merged
tanghao-xiaomi merged 1 commit intoopen-vela:devfrom
tanghao-xiaomi:dev
Apr 28, 2026
Merged

docs: refactor and enhance pthread API documentation#521
tanghao-xiaomi merged 1 commit intoopen-vela:devfrom
tanghao-xiaomi:dev

Conversation

@tanghao-xiaomi
Copy link
Copy Markdown
Collaborator

Summary

Refactor and enhance the pthread API documentation (doxygen/api/kernel/thread.md).

Changes

  • Complete all 113 pthread API entries (up from 75), achieving 100% coverage of nuttx/include/pthread.h
  • Add error codes and parameter validation details for all APIs, verified against NuttX source code
  • Reorganize document from flat numbered list into 15 functional groups (thread management, mutex, condvar, rwlock, barrier, spinlock, etc.)
  • Add "openvela Implementation Notes" section covering platform-specific behaviors (pthread_t=pid_t, CONFIG dependencies, scope limitations)
  • Fix parameter name inconsistency in pthread_exit
  • Add type alias explanations for NuttX private types (pthread_startroutine_t, pthread_addr_t)
  • Standardize POSIX compatibility wording across all entries
  • Fix document title from "进程/线程 API" to "线程 API"

Stats

  • APIs documented: 75 → 113
  • Header coverage: 67% → 100%
  • APIs with error codes: 25% → 98%
  • File diff: +1870, -676

- Complete all 113 pthread API entries (up from 75), 100% header coverage
- Add error codes and parameter validation for all APIs (verified against NuttX source)
- Reorganize into 15 functional groups (thread mgmt/mutex/condvar/rwlock/etc.)
- Add openvela implementation notes section (pthread_t=pid_t, CONFIG dependencies)
- Fix parameter name inconsistencies and undocumented private types
- Standardize POSIX compatibility wording
@tanghao-xiaomi tanghao-xiaomi merged commit 013e95b into open-vela:dev Apr 28, 2026
4 checks passed
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