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

Documentation for enumeration not generated (Origin: bugzilla #712251) #5348

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

Comments

Projects
None yet
1 participant
@doxygen
Copy link
Owner

doxygen commented Jul 2, 2018

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

Original attachment names and IDs:

On 2013-11-13 21:34:25 +0000, jraphanel wrote:

Hello,

When SEPARATE_MEMBER_PAGES option is set to Yes with html documentation, the comment about an enumeration stored in a class is not generated properly. In fact, after analysis the current doxygen implementation, it appears that if the same enumeration is not including into a class definition, the documentation is generated properly. After, I tried to check why the documentation was not generated properly if I put the same enumeration included along a class definition. I found in src\types.h the following lines:
MemberListType_enumValMembers = 31 + MemberListType_detailedLists,

If I understand well this line, it signifies that an enumeration values might have some detailed information that might be used to generated a separated HTML page. From my point of view, only an enumeration might have detailed information and in case of enumeration value it is not the case, so it is the reason why I suggest the following modification:

MemberListType_enumValMembers = 31 /+ MemberListType_detailedLists/,

In fact, I just suggest to remove the usage of MemberListType_detailedLists option in case of enumeration value.

I made some tests for HTML output and I don't see side effect, but I am not sure to have a clear vision about the impact of such modification.
What do you think of this suggestion?

Thanks and Regards,
Jacques

On 2013-11-23 13:54:06 +0000, Dimitri van Heesch wrote:

Can you please attach a self-contained example (source+config file in a tar or zip) that allows me to reproduce the problem?

On 2013-11-23 13:54:29 +0000, Dimitri van Heesch wrote:

Can you please attach a self-contained example (source+config file in a tar or zip) that allows me to reproduce the problem?

On 2013-11-25 08:16:36 +0000, jraphanel wrote:

Created attachment 261385
Source and configuration files

Please find in attached file the requested files.
enum.h and enum.cfg have been fetch from examples directory and from enum.cfg I just activate 'SEPARATE_MEMBER_PAGES' option.

Regards,
Jacques

On 2014-01-06 08:37:37 +0000, jraphanel wrote:

Dear Dimitri,

Is it possible to know if can reproduce the reported issue? If yes, do you know when this bug shall be solved?

Thanks and regards,
Jacques

On 2014-03-06 11:27:11 +0000, jraphanel wrote:

Dear Dimitri,

Sorry to disturb you, but I need to know if you think that I am right when I report my bug? In fact, for me it is always a pleasure to use doxygen because it is a very useful tool, but with this bug, I can't use official doxygen version and from my point of view, it is not very good. So at, can you confirm me if I found a bug or not and at least if yes, do you plan to fix it or not based on my comment?

In addition to that, I want to precise you that I don't submit a patch because I am not familiar to git, but I can make an effort to provide an official patch if it can help you.

Thanks and regards,
Jacques

On 2014-04-20 10:57:25 +0000, Dimitri van Heesch wrote:

I Jacques,

Sorry for the slow response so far.

I have just committed a change that should address the issue.
SHA: 1bb3672

It hides the enum values from the member page index (since they don't have an associated page). It is different from your proposal, so please check if it indeed solves your problem.

On 2014-04-21 10:09:31 +0000, Dimitri van Heesch wrote:

This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.8.7. 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 (preferrably in the form of a self-contained example).

@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
You can’t perform that action at this time.