-
Notifications
You must be signed in to change notification settings - Fork 5.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Feature] [doxygen] [audio] A plan to achieve audio components doxygen comments #10046
Comments
很好,有计划在什么平台验证吗? |
有生成doxygen的脚本,我这里可以在线预览 |
Q1:对于 audio,我看 markdown 部分是缺失的,是否这次会补上?一个可以参考的网上文章 https://zhuanlan.zhihu.com/p/344383184 Q2:对于 audio 框架,我有个疑问,就是 audio pipe 部分是不是应该不属于 API 部分。因为从 driver 的 user 来看,API 仅仅是定义在 Q3:有关 group 结构,从你的文字描述上看不太清楚,可以给个 tree 描述吗?类似:
Q4:从你的规划上来看,似乎 Audio 下宏和函数还要定义 group? 没有看明白,感觉 group 的概念应该不会用来区分 函数和 宏吧 Q3 和 Q4 也可以提交一个 RFC 的 pr,直接看看代码就清楚了。 Q5:我建议的 pr 步骤如下:
其他未尽事宜,欢迎补充。 |
A1: markdown这部分我还在想,目前我认为最好的还是rtt的官方文档,结构和内容也很符合introduction,直接把文档搬过来也是不错的选择 A4: group只区分不同种类的宏,Audio的采样率和码率等配置宏的选项太多了,用group会更规整一些 |
我觉得没什么两难的,“越全越好” 也不是原则,我们的原则就是 “html 上出现的是 API”。所以我觉得对于
我理解你这么做是因为看宏比较多,所以想分一下类,对吧。可以试试,你图片展示的是 treeview 的效果,右边页面上的效果又会是如何?如果你不想提 rfc pr ,其实也可以贴你的 github 开发仓库的 branch 上来,省的贴图。 |
我把markdown补完就提个rfc吧,但是没有合并到主线生成的文档的视觉效果能看到么? |
只要能拿到你的 branch,我自己本地也能看 |
可以的,提交PR的时候,会有个产出文件,打开即可看到效果。 |
Describe problem solved by the proposed feature
实现audio components的注释
Describe your preferred solution
我打算先把注释写了然后实现utest框架,以后补充components/drivers下的注释都按这个顺序来
目录的group结构方面我打算规划如下:
由于audio pipe宏不是很多,这里就直接放到audio pipe group下面
有的函数写的不好的地方我会在写好注释后另提pr修改,也算梳理模块了
各位觉得怎么样?
Describe possible alternatives
No response
The text was updated successfully, but these errors were encountered: