doxygen-users

Re: [Doxygen-users] any workaround - to get a function into multiple groups ?

[Ron W <ron...@gm...>]

On Fri, Sep 25, 2015 at 9:18 AM, <
dox...@li...> wrote:
>
> Date: Wed, 23 Sep 2015 16:59:13 -0700
> From: "Monique Semp" <mon...@ea...>
> Subject: [Doxygen-users] any workaround - to get a function into
>         multiple        groups ?
>
> And definitely, from the user-perspective, it?s very logical to have a
> function that ?belongs? in multiple groups. For example, I have some
> communications functions for async client, sync client, async server, and
> sync server. And so I have these four groups. But for example, some
> functions apply to both the sync client and the sync server, and so I
> certainly want to include the functions in both groups.
>

I don't know of a way to do this short of pre and post processing.

However, my alternate approach would be provide extra groups for the common
functions:

        * Common
        * Client
            * Common
            * Async
            * Sync
        * Server
            * Common
            * Async
            * Sync

Or what ever hierarchy makes sense for your project.

Re: [Doxygen-users] any workaround - to get a function into multiple groups ?

[Monique S. <mon...@ea...>]

> However, my alternate approach would be provide extra groups for the common functions:

Yes, that’s what I ended up doing. But it’s still not so user friendly because now users have to look at multiple groups to see all the functions for, say, async client (async client, core (aync and sycn) client, shared (client and server) async, and core (async and sync) shared (client and server)) instead of being able to look at just one group. But I added all the others as @sa references to help guide readers.

So this makes it even more important to include good example code to point people to the relevant functions in a way that’s not dependent on the groups.

Thanks for the confirmation that it’s a reasonable approach,
-Monique