最近在读cocos2dx v3.10 的api文档,发现好像有个图表搞错了对应关系,希望工作人员能改一下~
链接地址:http://api.cocos.com/cn/de/d8b/group__platform.html#ga5be836f305c9cd8b44ffb7c964f4cbd9
差不多下图这个样子
不是说发到这里面就会有人看么,客服姐姐骗我~
我知道为什么了。原来是这个地方的doxygen标记用错了。 /** blablabla */
在doxygen解析的时候,直接对应到下一行去了。正确写法是OS_WINDOWS, /**< Windows */
需要增加那个 < 符号表示注释针对当前行。
Pull request已经改好提交 https://github.com/cocos2d/cocos2d-x/pull/15541 下一次引擎团队更新doxygen版本的时候就能替换正确的上去了。感谢你的指正。
嘿嘿,估计也是用了不习惯的东西才这样的~,不运行一下看看是完全注意不到的~
原来 api reference 也在 github 上维护啊,错过了一次绝好的 pull request 的机会!
是的,API references其实就是依赖于C++代码里的doxygen注释来生成的。
不过我们自己hack过doxygen生成器本身(这也是个开源项目),使得解析的时候认识@js
和@lua
关键字,以生成多编程语言的文档。