diff mbox series

[2/4] doc: add some doc to flowgraph.h

Message ID 20201114102356.61234-3-luc.vanoostenryck@gmail.com (mailing list archive)
State Mainlined, archived
Headers show
Series doc: one patch and three improvements | expand

Commit Message

Luc Van Oostenryck Nov. 14, 2020, 10:23 a.m. UTC 
Signed-off-by: Luc Van Oostenryck <luc.vanoostenryck@gmail.com>
---
 Documentation/api.rst |  1 +
 flowgraph.h           | 20 ++++++++++++++++++++
 2 files changed, 21 insertions(+)
diff mbox series

Patch

diff --git a/Documentation/api.rst b/Documentation/api.rst
index cb8a0982011d..09ed0c4d7f9b 100644
--- a/Documentation/api.rst
+++ b/Documentation/api.rst
@@ -10,6 +10,7 @@  Utilities
 
 .. c:autodoc:: ptrlist.c
 .. c:autodoc:: utils.h
+.. c:autodoc:: flowgraph.h
 
 Parsing
 ~~~~~~~
diff --git a/flowgraph.h b/flowgraph.h
index 7226c55f0805..5a9c26073554 100644
--- a/flowgraph.h
+++ b/flowgraph.h
@@ -1,13 +1,33 @@ 
 #ifndef FLOWGRAPH_H
 #define FLOWGRAPH_H
 
+///
+// Utilities for flowgraphs
+// ------------------------
+
 #include <stdbool.h>
 
 struct entrypoint;
 struct basic_block;
 
+///
+// Set the BB's reverse postorder links
+// Each BB will also have its 'order number' set.
 int cfg_postorder(struct entrypoint *ep);
+
+///
+// Build the dominance tree.
+// Each BB will then have:
+//	- a link to its immediate dominator (::idom)
+//	- the list of BB it immediately dominates (::doms)
+//	- its level in the dominance tree (::dom_level)
 void domtree_build(struct entrypoint *ep);
+
+///
+// Test the dominance between two basic blocks.
+// @a: the basic block expected to dominate
+// @b: the basic block expected to be dominated
+// @return: ``true`` if @a dominates @b, ``false`` otherwise.
 bool domtree_dominates(struct basic_block *a, struct basic_block *b);
 
 #endif