docs: Possible Doxygen rendering bug making attributes unsearchable #19421

dongcarl commented at 3:30 PM on June 30, 2020: contributor

Doxygen fails to generate the right HTML here, making this section incorrect, and InitializeChainstate unsearchable.

Screen Shot 2020-06-30 at 11 27 59

Source: https://web.archive.org/web/20200630152314/https://doxygen.bitcoincore.org/class_chainstate_manager.html#pub-attribs

You can see from our code that these should be separate:

https://github.com/bitcoin/bitcoin/blob/2af56d6d5c387c3208d3d5aae8d428a3d610446f/src/validation.h#L795-L799

dongcarl added the label Bug on Jun 30, 2020

dongcarl added the label Docs on Jun 30, 2020

MarcoFalke commented at 3:59 PM on July 1, 2020: member

Looks like an upstream bug, no?

MarcoFalke added the label Upstream on Jul 1, 2020

laanwj commented at 12:12 PM on September 3, 2020: member

FWIW this is the installed version of doxygen:

user@galatea:~$ doxygen --help
Doxygen version 1.8.13
Copyright Dimitri van Heesch 1997-2015

It could help if someone could try with different versions (1.8.20 seems to be latest) and see if this was solved since. If that works, I'll upgrade the one on the server.

dongcarl commented at 3:45 PM on September 3, 2020: contributor

Testing on 1.8.20: bug still exists

laanwj commented at 3:49 PM on September 3, 2020: member

Thanks for testing ! good to know. We might want to report it upstream then, if it isn't yet. Looks like the project is even hosted on github these days: https://github.com/doxygen/doxygen

fanquake removed the label Bug on Aug 9, 2022

fanquake commented at 9:13 AM on August 9, 2022: member

Looks like this is still the case as of Dockygen 1.9.4. Removing the Bug label because this isn't a bug in Core.

MarcoFalke commented at 8:53 AM on August 10, 2022: member

Not sure what to do here. This needs to be reported elsewhere?

MarcoFalke closed this on Aug 10, 2022

fanquake commented at 9:17 AM on August 10, 2022: member

The issue is Doxygens parsing of EXCLUSIVE_LOCKS_REQUIRED(::cs_main); vs EXCLUSIVE_LOCKS_REQUIRED(cs_main);. We could add a temporary workaround to our config, to at least unbreak the generated documentation.

Submitted an issue upstream: https://github.com/doxygen/doxygen/issues/9499.

bitcoin locked this on Aug 10, 2023