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

doxygen modules included with tagfiles not visible #9424

Open
randaz81 opened this issue Jun 27, 2022 · 4 comments
Open

doxygen modules included with tagfiles not visible #9424

randaz81 opened this issue Jun 27, 2022 · 4 comments
Labels
needinfo reported bug is incomplete, please add additional info

Comments

@randaz81
Copy link

I have two projects, A and B. Each of them generates its own documentation and tagfile.

The two projects are documented using modules, i.e. each of them has a .dox file which contains some \defgroup xxx, \defgroup yyy etc. The my c++ classes are then documented via \ingroup xxx, \ingroup yyy etc. The name of the groups are identical in both projects, i.e. both A and B contains xxx and yyy groups.

Now, I have I want to create a project C, which includes A and B tagfiles. My expectation would be to have the documentation of C showing in group xxx the classes from A and B which belong to xxx, and in group yyy the classes from A and B which belong to yyy.
So, basically, I want to merge the modules documentation of A and B in a single documentation.
However, while other parts of the documentation are ok (e.g. the list of the files shows files from both A and B projects), I was not able to get the modules working. Indeed the modules page for project C is blank.

Can you please tell me if what I am trying to do is feasible (and I'm thus doing something wrong in my dox configuration files) or if there are issues / not supported?

@albert-github albert-github added the needinfo reported bug is incomplete, please add additional info label Jun 27, 2022
@albert-github
Copy link
Collaborator

To be able to tel what might be wrong:

  • Can you please attach a, small, self contained example (source+configuration file in a, compressed, tar or zip file) that allows us to reproduce the problem? Please don't add external links as they might not be persistent.
  • Please also specify the full doxygen version used (doxygen -v).

@randaz81
Copy link
Author

randaz81 commented Jun 28, 2022

I prepared a small zip to show the issue.
project.zip

To test it, you just need to run doxygen Doxyfile inside proj_a, proj_b, and proj_c folders.
You'll notice that in proj_c the modules documentation does not include class_a and class_b which I was expecting to be obtained from the tagfiles.

I tested it on Doxygen 1.8.17 and 1.9.5.
Thank you

@albert-github
Copy link
Collaborator

You mentioned that you tested with the 1.9.5 version, I tested with the current master i.e. 1.9.5 (c50f335) and in the modules / group page I see

image

and in here :

image

In the class list we see:

image

and when I understand it well, you would expect to see something like:

image

underneath the classes listing

image

on the "Devices title" page as well.

In the tag file from proj_a we see:

  <compound kind="group">
    <name>all_devices</name>
    <title>Devices title</title>
    <filename>group__all__devices.html</filename>
    <class kind="class">class_a</class>
  </compound>

and in the tag file from proj_c we see:

  <compound kind="group">
    <name>all_devices</name>
    <title>Devices title</title>
    <filename>group__all__devices.html</filename>
    <class kind="class">class_c</class>
  </compound>

so actually all "identical" just a different class name.

@doxygen

  • Should for a group, in case the name and title are identical, there be a mention of the classes imported through the tag file as well just like on the class page:
    class_a [external]
    
  • should there be extra restrictions?
  • probably this should also be the case for namespaces, functions, ...

@randaz81
Copy link
Author

and when I understand it well, you would expect to see something like ... underneath the classes listing ... on the "Devices title" page as well.

Yes, exactly.
Thank you for testing it.
I the meanwhile I also tried to replace \defgroup with \addtogroup command but unsuccessfully (same result)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needinfo reported bug is incomplete, please add additional info
Projects
None yet
Development

No branches or pull requests

2 participants