doxygen 与 IDL/ODL

发布于 2024-09-06 04:03:34 字数 190 浏览 8 评论 0原文

如果您有一个 C++ 项目,其中包含一堆 .ODL 文件 ODL 编译器生成的 .h 文件,是否应该告诉 doxygen 解析 .odl 和 .h,或者仅解析其中一个或其他?一般来说,我不喜欢记录生成的代码,但 IDL 是一种特殊情况。

无论如何,在我的测试中,ODL 文件的成员列表似乎无法正常工作,ODL 文件是否已正确解析?

If you have a C++ project that has a bunch of .ODL files and the generated .h files from the ODL compiler, should doxygen be told to parse both .odl and .h, or only one or the other? In general I don't like documenting generated code but IDL is sort of a special case.

In any case, it seems like the member listing of ODL files is not quite working properly in my tests, are ODL files properly parsed?

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(1

挽袖吟 2024-09-13 04:03:34

此页面 看来,Doxygen 完美支持解析 *idl*.odl 文件。也许您对评论格式有一些疑问?

无论如何,我建议您不要解析 *.idl/*.odl 文件和生成的 .h 文件。根据定义,后者生成并表示与 *.idl/*.old 文件中定义的类相同的类。

解析两者就像两次记录同一组类,这显然不是一个好主意。

From this page it seems the Doxygen perfectly supports parsing *idl and *.odl files. Maybe you have some issues regarding the comments format ?

Anyway, I would advise you against parsing both *.idl/*.odl files and generated .h files. The latter are, by definition, generated and represent the same classes than the one defined in the *.idl/*.old files.

Parsing both is like documenting the same set of classes twice, which is obviously not a good idea.

~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文