cgal icon indicating copy to clipboard operation
cgal copied to clipboard

Doxygen: Find a workaround for packages with EXTRACT_ALL=ON

Open sloriot opened this issue 9 years ago • 9 comments

in the official doxygen if EXTRACT_ALL=ON everything has a long description. We cannot make the patch do upstream. A solution is to set this flag OFF in all packages relying on it and add some documentation to members not documented that won't go into the doc with the flag change. This should be done with https://github.com/CGAL/doxygen/tree/release_1_8_13_patched as previous version were buggy.

See https://github.com/doxygen/doxygen/pull/452

sloriot avatar Jan 06 '17 09:01 sloriot

In my opinion we should first design tools allowing to compare two produced documentations.

lrineau avatar Jan 06 '17 12:01 lrineau

Not necessarily, as I said the comparison for a fixed version of doxygen can be done if HTML_TIMESTAMP=OFF with diff.

sloriot avatar Jan 09 '17 07:01 sloriot

If I understand well:

Maxime can worked with our fork of Doxygen, configure with HTML_TIMESTAMP=OFF, and then compare two builds: one with EXTRACT_ALL=ON and one without it.

Am I right?

lrineau avatar Jan 09 '17 09:01 lrineau

Exactly.

sloriot avatar Jan 09 '17 09:01 sloriot

However, 1.8.13 fork should be used as I notice some bugs in the other version when putting EXTRACT_ALL=OFF for some enum types.

sloriot avatar Jan 09 '17 09:01 sloriot

IMO, the priority of this issue is low as this regular version of doxygen can be used, it just generate an extra useless long description. Moreover Dimitri mentioned that he is working on a way to select what to export, so there might be another solution coming soon.

sloriot avatar Jan 11 '17 17:01 sloriot

@sloriot Is there any news on this ?

maxGimeno avatar Jan 07 '19 13:01 maxGimeno

No update on doxygen side. Maybe we should go on with always setting EXTRACT_ALL to OFF.

sloriot avatar Jan 07 '19 15:01 sloriot

Recently a number of changes have been made in the determination whether or not a detailed section should be present. There has been a change in the function bool MemberDefImpl::isDetailedSectionLinkable() const, especially also in the handling in respect for EXTRACT_ALL see https://github.com/doxygen/doxygen/pull/8601 In the code I have in the doxygen repository the only change is what I see in https://github.com/doxygen/doxygen/pull/452.

It would be good to see:

  • what the differences are with and without the patch for the current master.

albert-github avatar Jul 08 '21 16:07 albert-github