简体   繁体   English

Doxygen如何记录SC_MODULE中定义的类?

[英]How can the classes defined in SC_MODULE be documented by Doxygen?

I am making the documentation of my app written in SystemC using Doxygen. 我正在使用Doxygen用SystemC编写我的应用程序的文档。 The classes defined in the conventional C++ style are nicely hyperlinked, but the ones using SC_MODULE not. 常规C ++样式中定义的类可以很好地超链接,但使用SC_MODULE的类则没有。 Is there any trick to persist using SC_MODULE (ie not changing to the conventional C++ style), and make its use equivalent with the conventional definition, at least from documentation point of view? 是否有任何技巧可以坚持使用SC_MODULE(即,不更改为常规C ++样式),并且至少从文档角度来看,使其与常规定义等效?

You can have a look here from the Doxygen documentation. 你可以看看这里从Doxygen文档。

It requires the SystemC header to be available under the INCLUDE_PATH . 它要求SystemC标头在INCLUDE_PATH下可用。 You can refer here for similar question. 您可以在这里参考类似的问题。

声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM