Skip to content

Commit 96a8efb

Browse files
authored
Enable call/caller graphs in Doxygen (#3470)
This changes our doxygen config to assume we have the `dot` executable in our `$PATH`. This enables a number of diagrams to be built by default by doxygen. This PR also enables some non-default graphs: the call graph which shows functions called by each function and the caller graph which shows all other functions that call the function at hand. If you make a change to a function and want to see the potential impact, it is useful to inspect the caller graph. ## Example: `nvfuser::isResharding` Call graph: ![image](https://github.com/user-attachments/assets/057d64a5-813a-43ba-ad23-756376158b09) Caller graph: ![image](https://github.com/user-attachments/assets/b471c12d-47f8-4f7e-b96f-8d326856372d)
1 parent bb05859 commit 96a8efb

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

csrc/docs/fuser.doxygen

+6-6
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ DOXYFILE_ENCODING = UTF-8
3131
# project for which the documentation is generated. This name is used in the
3232
# title of most generated pages and in a few other places.
3333

34-
PROJECT_NAME = "PyTorch JIT Fuser"
34+
PROJECT_NAME = "nvFuser"
3535

3636
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
3737
# could be handy for archiving the generated documentation or if some version
@@ -453,7 +453,7 @@ EXTRACT_PACKAGE = NO
453453
# included in the documentation.
454454
# The default value is: NO.
455455

456-
EXTRACT_STATIC = NO
456+
EXTRACT_STATIC = YES
457457

458458
# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
459459
# locally in source files will be included in the documentation. If set to NO,
@@ -2237,7 +2237,7 @@ HIDE_UNDOC_RELATIONS = YES
22372237
# set to NO
22382238
# The default value is: NO.
22392239

2240-
HAVE_DOT = NO
2240+
HAVE_DOT = YES
22412241

22422242
# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
22432243
# to run in parallel. When set to 0 doxygen will base this on the number of
@@ -2354,7 +2354,7 @@ INCLUDED_BY_GRAPH = YES
23542354
# The default value is: NO.
23552355
# This tag requires that the tag HAVE_DOT is set to YES.
23562356

2357-
CALL_GRAPH = NO
2357+
CALL_GRAPH = YES
23582358

23592359
# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
23602360
# dependency graph for every global function or class method.
@@ -2366,7 +2366,7 @@ CALL_GRAPH = NO
23662366
# The default value is: NO.
23672367
# This tag requires that the tag HAVE_DOT is set to YES.
23682368

2369-
CALLER_GRAPH = NO
2369+
CALLER_GRAPH = YES
23702370

23712371
# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
23722372
# hierarchy of all classes instead of a textual one.
@@ -2409,7 +2409,7 @@ DOT_IMAGE_FORMAT = png
24092409
# The default value is: NO.
24102410
# This tag requires that the tag HAVE_DOT is set to YES.
24112411

2412-
INTERACTIVE_SVG = NO
2412+
INTERACTIVE_SVG = YES
24132413

24142414
# The DOT_PATH tag can be used to specify the path where the dot tool can be
24152415
# found. If left blank, it is assumed the dot tool can be found in the path.

0 commit comments

Comments
 (0)