Skip to content

[Feature] RTT doxygen 文档改进 #9824

@unicornx

Description

@unicornx
Contributor

NOTE:这是一个用于长期 Tracking Feature 的 issue,所以在相关工作完成之前,请不要关闭。

Describe problem solved by the proposed feature

需求来源:

这个 issue 用于搜集 RTT 代码仓库中和 doxygen 文档维护改进相关的 issue,相关工作可以分为下面几大部分:

Describe your preferred solution

No response

Describe possible alternatives

No response

Sub-issues

Sub-issues

0 of 1 Issues completed

Activity

self-assigned this
on Dec 23, 2024
added
DocThis PR/issue related with documents
on Dec 24, 2024
unicornx

unicornx commented on Dec 24, 2024

@unicornx
ContributorAuthor

有关文档改进的工作我也很有兴趣,希望能在相关方面做些工作,推进一下。

BernardXiong

BernardXiong commented on Dec 24, 2024

@BernardXiong
Member

文档中心

image

BernardXiong

BernardXiong commented on Dec 24, 2024

@BernardXiong
Member

英文documentation的部署是在这里: https://www.rt-thread.io/document/site/

不清楚是否是机器人自动化部署的了,可能不是。

supperthomas

supperthomas commented on Dec 24, 2024

@supperthomas
Member

这个doxygen还有很多未更新的地方,汪老师可以PR维护一下。

unicornx

unicornx commented on Dec 24, 2024

@unicornx
ContributorAuthor

这个doxygen还有很多未更新的地方,汪老师可以PR维护一下。

谢谢补充,我更新到 issue 的 问题 2 中了

unicornx

unicornx commented on Dec 27, 2024

@unicornx
ContributorAuthor

Modules 的层次结构设计

- Basic Definitions
- Device Virtual File System
- finsh shell
- Hardware Related Package
- RT-Thread Kernel API
  - Thread Management
  - Clock and Timer Management
  - Kernel Object Management
  - Inter-Thread Communication
    - Semaphore
    - Mutex
    - Event
    - Mailbox
    - Messagequeue
  - Signal
  - Memory Management
  - Device System
  - Runtime Trace and Record
  - Other useful kernel service
  - Error Code
- Application Module
- System Initialization
- RTTHREAD Driver
  - ADC
  - DAC
  - ...

是否可以和 documentation 下的文档结合起来,结构的安排尽量和其对齐。

就是有没有可能将下面两个网站的内容统一起来?

linked a pull request that will close this issue[doc] doxygen attach github pages #9859on Jan 2, 2025
unicornx

unicornx commented on Jan 3, 2025

@unicornx
ContributorAuthor

@supperthomas 这个 issue 列举了很多其他的问题,不是单个 #9859 就完全解决的,所以重新打开

11 remaining items

Loading
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

DocThis PR/issue related with documents

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

    Development

    Participants

    @BernardXiong@unicornx@supperthomas@1078249029

    Issue actions

      [Feature] RTT doxygen 文档改进 · Issue #9824 · RT-Thread/rt-thread