如何在不牺牲文档可读性的情况下将组添加到Doxygen中的多个组

时间:2019-01-10 15:29:10

标签: nested doxygen

我有4个组,从G1到G4,在Doxygen中记录如​​下。

/**
@defgroup G1 Group 1
@brief A brief description of group 1.
*/

/**
@defgroup G2 Group 2
@brief A brief description of group 2.
*/

/**
@defgroup G3 Group 3
@brief A brief description of group 3.
*/

/**
@defgroup G4 Group 4
@brief A brief description of group 4.
*/

我希望将它们分为三种不同的方式-1)全部,2)奇数组和3)偶数组。为了达到这个目的,我做了以下工作。

/**
@defgroup all_groups All groups
@{
    @defgroup G1
    @defgroup G2
    @defgroup G3
    @defgroup G4
@}
*/

/**
@defgroup odd_groups Odd groups
@{
    @defgroup G1
    @defgroup G3
@}
*/

/**
@defgroup even_groups Even groups
@{
    @defgroup G2
    @defgroup G4
@}
*/

适用于doxygen-1.8.13。但是,这是非法的。因为根据Doxygen文档,defgroup每个组仅应使用一次。

应该正确实施

/**
@defgroup G1 Group 1
@ingroup all_groups odd_groups
@brief A brief description of group 1.
*/

/**
@defgroup G2 Group 2
@ingroup all_groups even_groups
@brief A brief description of group 2.
*/

...

/**
@defgroup all_groups All groups
@defgroup odd_groups Odd groups
@defgroup even_groups Even groups
*/

/**
@defgroup all_groups All groups

    @addtogroup G1
    @ingroup all_groups

    @addtogroup G2
    @ingroup all_groups

    @addtogroup G3
    @ingroup all_groups

    @addtogroup G4
    @ingroup all_groups 
*/

/**
@defgroup odd_groups Odd groups

    @addtogroup G1
    @ingroup odd_groups

    @addtogroup G3
    @ingroup odd_groups
*/

/**
@defgroup even_groups Even groups

    @addtogroup G2
    @ingroup even_groups

    @addtogroup G4
    @ingroup even_groups    
*/

但是,可读性消失了。无论哪种情况,文档都不容易阅读和维护。我在网上搜索了可能的解决方法,但徒劳无功。我是否缺少一些优雅的解决方案?

我希望使用类似@addgroup的关键字来实现此目的。

/**
@defgroup all_groups All groups
@{
    @addgroup G1
    @addgroup G2
    @addgroup G3
    @addgroup G4
@}
*/

/**
@defgroup odd_groups Odd groups
@{
    @addgroup G1
    @addgroup G3
@}
*/

/**
@defgroup even_groups Even groups
@{
    @addgroup G2
    @addgroup G4
@}
*/

0 个答案:

没有答案