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

Enable generation of CALL_GRAPH and CALLER_GRAPH in the docs #86

Merged
merged 1 commit into from
Sep 6, 2024

Conversation

oruebel
Copy link
Contributor

@oruebel oruebel commented Sep 2, 2024

This PR enables the generation of caller and call graphs in Doxygen for all functions, providing an idea about who is calling the function and which functions are called by a function. E.g., here the call graph for createElectricalSeries

Screen Shot 2024-09-01 at 7 53 05 PM

Note

  • While this can increases the built time for the docs, on my laptop the difference seemed to be minimal
  • Extracting the call/caller graph is not perfect in Doxygen. In particular in the case of virtual functions where we may call the function on the base type and not the derived type, callers seem to get missed at times. However, the graphs still seem useful, even if they are not perfect.

@oruebel oruebel requested a review from stephprince September 2, 2024 03:00
Copy link
Collaborator

@stephprince stephprince left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great!

@stephprince stephprince merged commit 31a27df into main Sep 6, 2024
8 checks passed
@stephprince stephprince deleted the docs_enable_call_graph branch September 6, 2024 19:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants