docs: start writing the S4U part

[simgrid.git] / include / simgrid / simdag.h

diff --git a/include/simgrid/simdag.h b/include/simgrid/simdag.h
index 9194eab..ebf6810 100644 (file)
--- a/include/simgrid/simdag.h
+++ b/include/simgrid/simdag.h
@@ -1,19 +1,20 @@
-/* Copyright (c) 2006-2010, 2012-2018. The SimGrid Team.
- * All rights reserved.                                                     */
+/* Copyright (c) 2006-2018. The SimGrid Team. All rights reserved.          */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
 
-#ifndef SIMDAG_SIMDAG_H
-#define SIMDAG_SIMDAG_H
+#ifndef SIMGRID_SIMDAG_H
+#define SIMGRID_SIMDAG_H
+
+#include <simgrid/host.h>
+#include <simgrid/link.h>
+#include <xbt/log.h>
+#include <xbt/sysdep.h>
 
-#include "simgrid/host.h"
-#include "simgrid/link.h"
-#include "xbt/log.h"
-#include "xbt/sysdep.h"
 #ifdef __cplusplus
 #include <set>
 #endif
+
 SG_BEGIN_DECL()
 
 /** @brief Link opaque datatype
@@ -29,7 +30,7 @@ typedef sg_link_t SD_link_t;
 
     A task is some <em>computing amount</em> that can be executed in parallel on several hosts.
     A task may depend on other tasks, which means that the task cannot start until the other tasks are done.
-    Each task has a <em>\ref e_SD_task_state_t "state"</em> indicating whether the task is scheduled, running, done, ...
+    Each task has a <em>@ref e_SD_task_state_t "state"</em> indicating whether the task is scheduled, running, done, ...
 
     */
 typedef struct s_SD_task_t* SD_task_t;
@@ -65,7 +66,7 @@ typedef enum {
  *
  *  A task is some <em>working amount</em> that can be executed in parallel on several hosts.
  *  A task may depend on other tasks, which means that the task cannot start until the other tasks are done.
- *  Each task has a <em>\ref e_SD_task_state_t "state"</em> indicating whether the task is scheduled, running, done, ...
+ *  Each task has a <em>@ref e_SD_task_state_t "state"</em> indicating whether the task is scheduled, running, done, ...
  *
  *  @see SD_task_t, @see SD_task_dependency_api
  *  @{