isl_schedule_node_foreach_descendant_top_down: update doc to isl_bool/isl_stat
authorSven Verdoolaege <sven.verdoolaege@gmail.com>
Thu, 14 Sep 2017 15:11:16 +0000 (14 17:11 +0200)
committerSven Verdoolaege <sven.verdoolaege@gmail.com>
Wed, 27 Sep 2017 07:23:33 +0000 (27 09:23 +0200)
This was missing from isl-0.14.1-479-g370a8b7d07 (introduce isl_bool
and isl_stat return types, Mon May 4 09:45:16 2015 +0200).

Signed-off-by: Sven Verdoolaege <sven.verdoolaege@gmail.com>
isl_schedule_node.c

index 3ddbc51..38627cf 100644 (file)
@@ -1336,11 +1336,12 @@ static __isl_give isl_schedule_node *preorder_leave(
 /* Traverse the descendants of "node" (including the node itself)
  * in depth first preorder.
  *
- * If "fn" returns -1 on any of the nodes, then the traversal is aborted.
- * If "fn" returns 0 on any of the nodes, then the subtree rooted
+ * If "fn" returns isl_bool_error on any of the nodes,
+ * then the traversal is aborted.
+ * If "fn" returns isl_bool_false on any of the nodes, then the subtree rooted
  * at that node is skipped.
  *
- * Return 0 on success and -1 on failure.
+ * Return isl_stat_ok on success and isl_stat_error on failure.
  */
 isl_stat isl_schedule_node_foreach_descendant_top_down(
        __isl_keep isl_schedule_node *node,