Handling two different functions with the same name in Doxygen

I have a C project which contains two functions with the same name, but each is within a different group/module (@defgroup).

These functions each compile into a different binary, but I need the documentation to be closely cross-referenced, so I need to refer (@ref) to these functions (among other places) from each other's module.

When I do simple @ref name-of-the-function, it always links to the one which resides in file which is earlier in the file tree. How can I link to the other one?

sleske

As far as I can see: doxygen's autolinking does not support having multiple functions with the same name.

If there are multiple functions/methods with the same name, doxygen will simply link the first one it finds, as described in the question. The call graphs will also be incorrect. This seems to apply to all languages, not just to C.

This has been reported as a bug multiple times:

The section "Known problems" in doxygen's docs also describes a similar problem:

It is not possible to insert a non-member function f in a class A using the \relates or \relatesalso command, if class A already has a member with name f and the same argument list.

There is some hope; someone proposed a patch to better handle functions with the same name: 656694 - getDefs fails to resolve local function names if same global name exist.

This patch implements the following two strategies for resolving duplicated names. First, is the name is defined in current file, use the local name. Secondly try to match the names using the prototype definition.

This would partly solve the problem. Unfortunately, the ticket has seen no activity since 2012...

can this work for you?

The example is stripped down to the two files a.c and b.c, with only one function (the clashing) function.

file a.c

/**
 * \defgroup agroup Group A
 */

/** 
 * the function in a, 
 * see also \link b.c myfunc() \endlink the other one 
 * \ingroup agroup
 */
void myfunc() {
    ;
}

file b.c

/**
 * \defgroup bgroup Group B
 */

/** 
 * the function in b, 
 * see also \link a.c myfunc() \endlink the other one 
 * \ingroup bgroup
 */
void myfunc() {
    ;
}

as you see, myfunc() has a name clash. I placed a link to the other function in the documentation.

I perpended the function name by the filename.

I compiled it with doxygen and the links worked (they linked from each documentation of a function to the other function).

A solution that works for me in doxygen 1.8.13 is to provide an explicit link with the HTML <a></a> tag. For example, I have a function QF_run(), which is defined in three different files qv.c, qk.c and qxk.c. Here are three links to these three definitions:

<a href="qv_8c.html#a779a1bc9482e2d489dc87751cd100fdb"><b>QF_run()</b></a>
<a href="qk_8c.html#a779a1bc9482e2d489dc87751cd100fdb"><b>QF_run()</b></a>
<a href="qxk_8c.html#a779a1bc9482e2d489dc87751cd100fdb"><b>QF_run()</b></a>

These links are rendered in the HTML output the same way as the automatically generated links. The links are also stable as long as you don't change the name of the function.

To obtain the hash-value for your function, simply open its documentation in a browser and copy the link after the # sign.

来源：https://stackoverflow.com/questions/9548701/handling-two-different-functions-with-the-same-name-in-doxygen

标签

documentation

doxygen