Skip to content

[Bug] components/drivers/ 中的 examples 和 documentation 中的 example 重复了 #10003

Closed as not planned
@unicornx

Description

@unicornx

RT-Thread Version

master

Hardware Type/Architectures

N/A

Develop Toolchain

Other

Describe the bug

举个例子:

components/drivers/include/drivers/dev_i2c.h 中 用 “@code” 和 “@Endcode” 括起来的例子和 documentation/device/i2c/i2c.md 中 “# I2C Bus Device Usage Example” 重复了,只要保留一份即可。

建议修改方案:

采用 “@code” 在 components/drivers/ 下搜索可以看到这些例子。

对于重复的例子,保留 markdown 中的,删掉 header 文件中的。

即使没有重复,也建议将代码例子全部写到 documentation 下的 markdown 文件中去。

Other additional context

No response

Metadata

Metadata

Assignees

Labels

DocThis PR/issue related with documents

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions