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

ingroup'd macro duplication (Origin: bugzilla #643944) #4188

Closed
doxygen opened this Issue Jul 2, 2018 · 0 comments

Comments

Projects
None yet
1 participant
@doxygen
Owner

doxygen commented Jul 2, 2018

status RESOLVED severity normal in component general for ---
Reported in version 1.7.3 on platform Other
Assigned to: Dimitri van Heesch

Original attachment names and IDs:

On 2011-03-05 12:18:40 +0000, Anton wrote:

Created attachment 182543
both samples in separate directories

I don't know what of the following is a bug because of there is a lot of strange behaviour so I prefer describe it step-by-step.

PREAMBLE.
Situation in brief. I have a group containing set of structures. Each structure has set of functions and function-like macroses.

And I want to display both functions and function-like macroses both upon group and structure page.

OBSERVATION-1.
So I add \relates and \ingroup in documentation block. Such way formatted block produces the proper result (for me) while documenting function but not the macro (tss_del_base vs tss_del_base_back in sample1). This seems to be a bug.

OBSERVATION-2.
If I remove @relates (leaving @InGroup) then then macro naturally disappears from structure documentation page but on group page it is displayed almost as wanted(i.e. the only item). See behaviour of tss_del_bof_back_norel in sample1. So this looks like absolutely normal behaviour.
If I remove @InGroup (leaving @relates) then macro is displayed both on group and structure documentation pages BUT it is doubled on group documentation page. See behaviour of tss_del_bof_back_nogrp in sample1. BUT if delete tss_del_bof with its documentation then duplication becomes automatically removed (this is illustrated by sample2). So this seems to be definitely a bug.

OBSERVATION-3
To avoid such strange behavious I've even tried to document macro as function (see documentation for tss_del_bif_copy) and this produces almost ideal result, but there is a little drawbacks:

  1. doxygen generates 2 warnings in my case:
    1/sample.h:109: warning: argument 'id___' of command @param is not found in the argument list of tssBifFile::tss_del_bif_copy(rtsp_uint64 id___)
    1/sample.h:109: warning: The following parameters of tssBifFile::tss_del_bif_copy(rtsp_uint64 id___) are not documented:
    parameter 'rtsp_uint64'
  2. In documentation block for such function argument type is merged with argument name.

On 2011-04-22 14:37:08 +0000, Dimitri van Heesch wrote:

There was a problem where a #define that was marked with \relates ended up twice in the file/group documentation. Should be fixed in the next subversion update.

On 2011-08-14 14:05:20 +0000, Dimitri van Heesch wrote:

This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.7.5. Please verify if this is indeed the case. Reopen the
bug if you think it is not fixed and please include any additional information
that you think can be relevant.

@doxygen doxygen closed this Jul 2, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment