Re: [Doxygen-users] Doxygen-users Digest, Vol 104, Issue 11

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

On Thu, Jan 29, 2015 at 11:21 AM, <
dox...@li...> wrote:

>
> Date: Thu, 29 Jan 2015 17:21:08 +0100
> From: Fabian Cenedese <Cen...@in...>
> Subject: [Doxygen-users] Multiple functions with same name
>
> I'm developing a C-project where I have basically the same code for several
> variants of controllers. A few functions need to be adjusted and are placed
> in separate files. The interface of course is for all the same. For linking
> only the necessary files will be linked in. I don't want to create a
> separate
> documentation for every controller where only little details change. But
> documenting all files will lead to merged documentation of the functions
> with the same name.
>
> Little example:
>
> /* interface */
> a.h
> void DoA(void);
>
> /* implementation ctrl 1 */
> a1.c
> void DoA(void) {
> }
>
> /* implementation ctrl 2 */
> a2.c
> void DoA(void) {
> }
>

Assuming the main part of the function documentation is located in the .h
file, perhaps in the .c files use named paragraphs to "delimit" the
implementation specific details. Something like:

     /** @par Ctrl 1 Implementation
          Details about ctrl 1 implementation
     */

and similar for the other implementation specific function definitions.