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

The enum parameters are not hyper linked in many cases (Origin: bugzilla #624514) #3854

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 major in component general for ---
Reported in version 1.7.1 on platform Other
Assigned to: Dimitri van Heesch

Original attachment names and IDs:

On 2010-07-16 06:53:06 +0000, Anil Choudhury wrote:

Created attachment 166008
Sample test code with doxyfile and documentation to describe the enum and macro documentation issue

I have attached a sample code, doxyfile and the documentation generated from this.

The documentation is not able to link all the enums and macros most of the time. It shows them as normal text.

See the "Variables" section of "adc.c" file documentation:
I. See documentation for the "self" and "ModRegAddr" variables and they have used an "ADC_TOT_MOD" enum value to decide their array size. but that "ADC_TOT_MOD" enum value is not able to hyperlink to the enum documentation.

See the section "Variable Documentation" in "adc.c" file documentation:
II. See the variable "ModRegAddr" initial value:

struct QADC64_tag* const ModRegAddr[ADC_TOT_MOD]
{MOD_A_ADDR, MOD_B_ADDR}

Here only the "MOD_B_ADDR" macro is hyper-linked but the macro "MOD_A_ADDR" and enum "ADC_TOT_MOD" are not hyper-linked.

On 2010-07-17 19:06:59 +0000, Dimitri van Heesch wrote:

Confirmed. Should be fixed in the next subversion update.

On 2010-10-09 08:19:26 +0000, Dimitri van Heesch wrote:

This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.7.2. 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.

On 2010-10-12 05:06:31 +0000, Anil Choudhury wrote:

Created attachment 172155
Reference files for enum hyperlink issue

Hi,
I have added few more functions in the adc.c file and generated the documentation with the help of old doxyfile and verified the documentation.

The following observations found in adc.c file documentation:

  1. The enums used for value assignment to global varibles are listing properly in "Variable Documentation" section (Issue resolved)
  2. The enums used for array size in global varible declarations are not listing properly in "Variables" section (Issue not resolved)

Thanks & Regards
Anil Kumar Choudhury

@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