以不同/正确的方式组织 Doxygen 索引列表

发布于 2025-01-15 14:38:10 字数 1147 浏览 4 评论 0原文

我正在尝试为工作项目生成组织正确的 Doxygen 文档。我遇到的问题与下图有关:

模块详细信息列表

“状态机”选项卡下的所有内容都是数据结构、宏、typedef 等,按顺序属于不同文件中的模块。有什么方法可以摆脱详细列表并将其分组为:

  • 状态机
    • 数据结构
      • mdlSM_INV
      • mdlSM...
      • mdlSM_cnf...

等等?

或者只是删除整个列表,即只拥有模块的名称而不将其扩展为其他任何内容?

我正在使用 Doxywizard 和 Doxygen 版本 1.8.18,但我无法更新(至少目前),因为我没有计算机的管理员权限。该项目采用嵌入式 C 语言,在 Code Composer Studio 中编写。

编辑:当前文件内容看起来像这样:

/*! \addtogroup mdlStatemachine State Machine
 *@brief  Implement state machine
 *
 *@{
 */
 
#include ...

// MACROS
#define mdlSM_cnf_TICKS_PER_MS
#define mdlSM_cnf_SAMPLE_INTERVAL
#define ...


// TYPEDEFS
/*!@brief
 * ...
 */
typedef enum mdlSM_cnf_States
{
    ...
    ...
}mdlSM_cnf_States_t;


/*!@brief
 * ...
 */
typedef struct mdlSM_INV
{
    ...
}mdlSM_INV_t;


// FUNCTIONS
/*!@brief  ...
 *
 */
void SM_init(SM *me, SMState state)
{
    ...
}

// END OF FILE
/*! @}*/

这个想法是将整个文件放入模块中,而不是单独将每个函数等放入模块中。

I'm trying to generate properly organized Doxygen documentation for a work project. The issue I'm having is related to the image below:

module detail list

Everything under the "State Machine" tab are the data structures, macros, typedefs, etc. in that order that belong to the module in different files. Is there any way to get rid of the detailed listing and instead have it grouped as:

  • State Machine
    • Data Structures
      • mdlSM_INV
      • mdlSM...
    • Macros
      • mdlSM_cnf...

So on and so forth?

OR to just get rid of the whole list i.e. just have the name of the module and not have it expand into anything else?

I'm working with Doxywizard and Doxygen version 1.8.18 that I cannot update (at the moment at least) as I don't have admin rights on the computer. The project is in embedded C, written in Code Composer Studio.

EDIT: The current file contents looks something like this:

/*! \addtogroup mdlStatemachine State Machine
 *@brief  Implement state machine
 *
 *@{
 */
 
#include ...

// MACROS
#define mdlSM_cnf_TICKS_PER_MS
#define mdlSM_cnf_SAMPLE_INTERVAL
#define ...


// TYPEDEFS
/*!@brief
 * ...
 */
typedef enum mdlSM_cnf_States
{
    ...
    ...
}mdlSM_cnf_States_t;


/*!@brief
 * ...
 */
typedef struct mdlSM_INV
{
    ...
}mdlSM_INV_t;


// FUNCTIONS
/*!@brief  ...
 *
 */
void SM_init(SM *me, SMState state)
{
    ...
}

// END OF FILE
/*! @}*/

The idea is to put entire files in the modules and not every function etc. individually.

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

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

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。
列表为空,暂无数据
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文