Skip to content

Commit 1d55eef

Browse files
authored
Add method reference for show_call_graph in the document (#557)
* Update quark_method_reference.rst * Update quark_method_reference.rst
1 parent 69f3478 commit 1d55eef

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

docs/source/quark_method_reference.rst

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1365,3 +1365,41 @@ Here is the flowchart of ``show_detail_report``.
13651365
for seq_operation in self.quark_analysis.level_5_result:
13661366
print(f"\t\t {seq_operation.full_name}")
13671367
1368+
show_call_graph
1369+
==================
1370+
1371+
**The algorithm of show_call_graph**
1372+
1373+
The function ``show_call_graph`` creates a call graph for each element in call_graph_analysis_list and displays messages to indicate progress.
1374+
1375+
Here is the process of ``show_call_graph``.
1376+
1377+
.. code-block:: TEXT
1378+
1379+
1. Display the message "Creating Call Graph..." in cyan color.
1380+
1381+
2. Create a call graph for each element in call_graph_analysis_list.
1382+
1383+
3. Display the message "Call Graph Completed" in green color.
1384+
1385+
1386+
1387+
Here is the flowchart of ``show_call_graph``.
1388+
1389+
.. image:: https://i.imgur.com/18pGB7w.png
1390+
1391+
1392+
1393+
**The code of show_call_graph**
1394+
1395+
1396+
.. code-block:: python
1397+
1398+
def show_call_graph(self, output_format=None):
1399+
print_info("Creating Call Graph...")
1400+
for (
1401+
call_graph_analysis
1402+
) in self.quark_analysis.call_graph_analysis_list:
1403+
call_graph(call_graph_analysis, output_format)
1404+
print_success("Call Graph Completed")
1405+

0 commit comments

Comments
 (0)