summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorAndreas Fried <andreas.fried@kit.edu>2019-06-11 14:59:44 +0200
committerAndreas Fried <andreas.fried@kit.edu>2019-06-11 14:59:44 +0200
commit6291c20ad2fbabda481e2b777daad3fabc525882 (patch)
treefc3113fdfb682ecbb639a94e9fad63b35a36d935
parentbb7bfc2abc07472b15a475614fd204d806464fc7 (diff)
Add more documentation for add_irg_properties and clear_irg_properties.
-rw-r--r--include/libfirm/irgraph.h14
1 files changed, 11 insertions, 3 deletions
diff --git a/include/libfirm/irgraph.h b/include/libfirm/irgraph.h
index 5ef118b..944458a 100644
--- a/include/libfirm/irgraph.h
+++ b/include/libfirm/irgraph.h
@@ -426,11 +426,19 @@ typedef enum ir_graph_properties_t {
} ir_graph_properties_t;
ENUM_BITSET(ir_graph_properties_t)
-/** sets some state properties on the graph */
+/**
+ * Sets the graph properties in @p props on @p irg.
+ * Just sets the flags, use assure_irg_properties() to also perform the analyses required.
+ */
FIRM_API void add_irg_properties(ir_graph *irg, ir_graph_properties_t props);
-/** clears some graph properties */
+/**
+ * Clears the graph properties in @p props on @p irg.
+ * Just sets the flags, use confirm_irg_properties() with inverted @p props to also invalidate the analysis state.
+ */
FIRM_API void clear_irg_properties(ir_graph *irg, ir_graph_properties_t props);
-/** queries whether @p irg has the @p props properties set */
+/**
+ * queries whether @p irg has all properties in @p props set.
+ */
FIRM_API int irg_has_properties(const ir_graph *irg,
ir_graph_properties_t props);