doc: Generate doxygen documentation for test sources #22001

pull patrickkamin wants to merge 1 commits into bitcoin:master from patrickkamin:issue/19248 changing 1 files +1 −3
  1. patrickkamin commented at 5:28 AM on May 20, 2021: contributor

    Fixes #19248

    While searching for the documentation of the test utilities I realized they were excluded from doxygen. I agree with the statement in #19248. It's also helpful for new contributors to gain a broader understanding of the class dependencies visually (see BasicTestSetup)

  2. Generate doxygen documentation for test sources 5d37cc44f9
  3. fanquake added the label Docs on May 20, 2021
  4. laanwj commented at 2:09 PM on May 20, 2021: member

    Would you want to include all the individual tests or just the test support library? The reason for not including the test cases is to avoid clutter. I don't know how bad it would be though.

  5. patrickkamin commented at 5:52 PM on May 24, 2021: contributor

    Doxygen is doing a decent job grouping files together by macro. See the following screenshots as an example for the Fuzz and Boost tests

    2021-05-24 at 10 19 26 2021-05-24 at 10 20 30

    I think adding the individual tests is even beneficial as it gives you a quick overview of what is currently being covered by the test frameworks and allows you to drill down into the tests and dependencies.

    The generation takes obviously slightly longer. In total we end up with 6557 more files while 5985 are purely graphs. Not sure if that's a concern from a CI and hosting perspective though. Are the doxygen docs getting generated for the master branch by CI and hosted somewhere?

  6. laanwj commented at 1:10 PM on May 25, 2021: member

    Thanks for checking. I agree, If it doesn't seem to add confusion for people browsing the documentation then covering everything (except subtrees) is preferable.

    Are the doxygen docs getting generated for the master branch by CI and hosted somewhere?

    Yes :smile: https://doxygen.bitcoincore.org This runs on one of my servers, it's only regenerated once every day so having it take up a bit more time/space isn't a big deal.

  7. theStack commented at 7:48 PM on July 18, 2021: member

    Concept ACK

  8. laanwj commented at 11:52 AM on August 2, 2021: member

    ACK 5d37cc44f9200861a278d074f8caa99e8db6be02

  9. laanwj merged this on Aug 2, 2021
  10. laanwj closed this on Aug 2, 2021

  11. sidhujag referenced this in commit 6cc3dd8269 on Aug 4, 2021
  12. PastaPastaPasta referenced this in commit 2de36904b6 on Mar 13, 2022
  13. DrahtBot locked this on Aug 18, 2022

github-metadata-mirror

This is a metadata mirror of the GitHub repository bitcoin/bitcoin. This site is not affiliated with GitHub. Content is generated from a GitHub metadata backup.
generated: 2026-04-17 06:14 UTC

This site is hosted by @0xB10C
More mirrored repositories can be found on mirror.b10c.me