From c9b94e9a3fd8c718d7b1a31df4ea9a973ec4307c Mon Sep 17 00:00:00 2001
From: lhausamm <loic_hausammann@hotmail.com>
Date: Sun, 12 Nov 2017 18:56:49 +0100
Subject: [PATCH] Add doxygen header to scheduler_write_dependency

---
 src/scheduler.c | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/src/scheduler.c b/src/scheduler.c
index a2f7ef611e..744a4a8d73 100644
--- a/src/scheduler.c
+++ b/src/scheduler.c
@@ -112,6 +112,12 @@ void scheduler_addunlock(struct scheduler *s, struct task *ta,
   atomic_inc(&s->completed_unlock_writes);
 }
 
+/**
+ * @brief Write a dot file with the task dependencies.
+ *
+ * See examples/task_graph for an example of how to use it
+ * @param s The #scheduler we are working in.
+ */
 void scheduler_write_dependency(struct scheduler *s) {
 #ifdef WITH_MPI
   if (engine_rank != 0) return;
-- 
GitLab