Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cannot differentiate between overloaded functions in a single file #13

Open
milliams opened this issue Dec 12, 2017 · 0 comments
Open
Labels

Comments

@milliams
Copy link
Collaborator

If we have a C++ header like:

int my_func();
namespace my_namespace {
    int my_func();
}

then Doxygen will put a reference to both of them at the top level of the file compound in the tag file. There will be a further reference to my_namespace::my_func as well but the two at the file-level are ambuigous.

It looks like:

<?xml version='1.0' encoding='UTF-8' standalone='yes' ?>
<tagfile>
  <compound kind="file">
    <name>my_lib.h</name>
    <path>/home/matt/projects/doxylink/examples/</path>
    <filename>my__lib_8h</filename>
    <namespace>my_namespace</namespace>
    <member kind="function">
      <type>int</type>
      <name>my_func</name>
      <anchorfile>my__lib_8h.html</anchorfile>
      <anchor>abe47619a51650fe04900f35b66ee6153</anchor>
      <arglist>()</arglist>
    </member>
    <member kind="function">
      <type>int</type>
      <name>my_func</name>
      <anchorfile>namespacemy__namespace.html</anchorfile>
      <anchor>afcbfcd04ac02688687cb6984bf850d25</anchor>
      <arglist>()</arglist>
    </member>
  </compound>
  <compound kind="namespace">
    <name>my_namespace</name>
    <filename>namespacemy__namespace.html</filename>
    <member kind="function">
      <type>int</type>
      <name>my_func</name>
      <anchorfile>namespacemy__namespace.html</anchorfile>
      <anchor>afcbfcd04ac02688687cb6984bf850d25</anchor>
      <arglist>()</arglist>
    </member>
  </compound>
</tagfile>

Two options:

  1. Scan the file compound for any items which match any in any namespaces and remove them from the file
  2. Use the Doxygen XML output as this does not suffer from the same problem (see issue Add ability to extract documentation from XML output #8)
@milliams milliams added the bug label Dec 12, 2017
@milliams milliams changed the title Cannont differentiate between overloaded functions in a single file Cannot differentiate between overloaded functions in a single file Dec 14, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant