missing link to overloaded method

[noname77]

Hi again,

I have a method with overloads in my interface. my issue is that a link to only the first method (overload) is generated, i.e.

IExample.cs:

namespace Company.Package
{
    /// <summary>
    ///  <c>IExample</c> exposes the example.
    /// </summary>
    public interface IExample
    {
        /// <summary>
        ///  Tests the example with parameter of type A.
        /// </summary>
        /// <param name="parameter">Parameter of type A.</param>
        void OverloadTest(A parameter);

        /// <summary>
        ///  Tests the example with parameter of type B.
        /// </summary>
        /// <param name="parameter">Parameter of type B.</param>
        void OverloadTest(B parameter);
    }
}

doxygen documentation links to both methods fine:

however, breathe's output only generates a link to the first overload

test.rst:

.. doxygeninterface:: Company::Package::IExample
   :members:
   :undoc-members:

breathe output with breathe_debug_trace_directives = True

Running directive: .. cs:interface::  Company.Package.IExample
  Running directive: .. cs:function::  void OverloadTest (A parameter)
  Running directive: .. cs:function::  void OverloadTest (B parameter)

rendered output (note the # / permalink next to the first method overload and missing one next to the second overload)

also, note the missing link in the html output

vs correct link in for the first overload

Do you have any pointers where to look further / how to fix this?

Best,
Wiktor

[rogerbarton]

Hmm, the issue is that the permalinks generated don't include the parameters of the method. I think this could be adapted in CSharpMethod.handle_signature:

sphinx-csharp/sphinx_csharp/csharp.py

Line 575 in 2559d22

return self.get_fullname(name)

But I think the links to the method then also need to be adapted in the resolve_xref. I will leave this as is for now until I find some more time to look into it further.

[noname77]

thanks for the reply and pointers!

I will also try to dig into this if I manage to find some time