include: fix doxygen comments

include/starpu_perf_monitoring.h

@@ -40,10 +40,10 @@ extern "C"
  */
 enum starpu_perf_counter_scope
 {
-	starpu_perf_counter_scope_undefined     = 0, /** undefined scope */
-	starpu_perf_counter_scope_global        = 2, /** global scope */
-	starpu_perf_counter_scope_per_worker    = 4, /** per-worker scope */
-	starpu_perf_counter_scope_per_codelet   = 6  /** per-codelet scope */
+	starpu_perf_counter_scope_undefined     = 0, /**< undefined scope */
+	starpu_perf_counter_scope_global        = 2, /**< global scope */
+	starpu_perf_counter_scope_per_worker    = 4, /**< per-worker scope */
+	starpu_perf_counter_scope_per_codelet   = 6  /**< per-codelet scope */
 };
 
 /**
@@ -51,11 +51,11 @@ enum starpu_perf_counter_scope
  */
 enum starpu_perf_counter_type
 {
-	starpu_perf_counter_type_undefined = 0, /** underfined value type */
-	starpu_perf_counter_type_int32     = 1, /** signed 32-bit integer value */
-	starpu_perf_counter_type_int64     = 2, /** signed 64-bit integer value */
-	starpu_perf_counter_type_float     = 3, /** 32-bit single precision floating-point value */
-	starpu_perf_counter_type_double    = 4  /** 64-bit double precision floating-point value */
+	starpu_perf_counter_type_undefined = 0, /**< underfined value type */
+	starpu_perf_counter_type_int32     = 1, /**< signed 32-bit integer value */
+	starpu_perf_counter_type_int64     = 2, /**< signed 64-bit integer value */
+	starpu_perf_counter_type_float     = 3, /**< 32-bit single precision floating-point value */
+	starpu_perf_counter_type_double    = 4  /**< 64-bit double precision floating-point value */
 };
 
 struct starpu_perf_counter_listener;

include/starpu_perf_steering.h

@@ -35,183 +35,208 @@ extern "C"
    \anchor PM_API
    @{
 */
+
 /**
    Enum of all possible performance knob scopes.
  */
 enum starpu_perf_knob_scope
 {
-	starpu_perf_knob_scope_undefined     = 0, /** undefined scope */
-	starpu_perf_knob_scope_global        = 1, /** global scope */
-	starpu_perf_knob_scope_per_worker    = 3, /** per-worker scope */
-	starpu_perf_knob_scope_per_scheduler = 5  /** per-scheduler scope */
+	starpu_perf_knob_scope_undefined     = 0, /**< undefined scope */
+	starpu_perf_knob_scope_global        = 1, /**< global scope */
+	starpu_perf_knob_scope_per_worker    = 3, /**< per-worker scope */
+	starpu_perf_knob_scope_per_scheduler = 5  /**< per-scheduler scope */
 };
 
 /**
-  Enum of all possible performance knob value type.
+   Enum of all possible performance knob value type.
  */
 enum starpu_perf_knob_type
 {
-	starpu_perf_knob_type_undefined = 0, /** underfined value type */
-	starpu_perf_knob_type_int32     = 1, /** signed 32-bit integer value */
-	starpu_perf_knob_type_int64     = 2, /** signed 64-bit integer value */
-	starpu_perf_knob_type_float     = 3, /** 32-bit single precision floating-point value */
-	starpu_perf_knob_type_double    = 4  /** 64-bit double precision floating-point value */
+	starpu_perf_knob_type_undefined = 0, /**< underfined value type */
+	starpu_perf_knob_type_int32     = 1, /**< signed 32-bit integer value */
+	starpu_perf_knob_type_int64     = 2, /**< signed 64-bit integer value */
+	starpu_perf_knob_type_float     = 3, /**< 32-bit single precision floating-point value */
+	starpu_perf_knob_type_double    = 4  /**< 64-bit double precision floating-point value */
 };
 
 /**
-  Translate scope name constant string to scope id.
-  */
+   Translate scope name constant string to scope id.
+*/
 int starpu_perf_knob_scope_name_to_id(const char *name);
+
 /**
-  Translate scope id to scope name constant string.
-  */
+   Translate scope id to scope name constant string.
+*/
 const char *starpu_perf_knob_scope_id_to_name(enum starpu_perf_knob_scope scope);
 
 /**
-  Translate type name constant string to type id.
-  */
+   Translate type name constant string to type id.
+*/
 int starpu_perf_knob_type_name_to_id(const char *name);
+
 /**
-  Translate type id to type name constant string.
-  */
+   Translate type id to type name constant string.
+*/
 const char *starpu_perf_knob_type_id_to_name(enum starpu_perf_knob_type type);
 
 /**
-  Return the number of performance steering knobs for the given scope.
-  */
+   Return the number of performance steering knobs for the given scope.
+*/
 int starpu_perf_knob_nb(enum starpu_perf_knob_scope scope);
+
 /**
-  Translate a performance knob name to its id.
-  */
+   Translate a performance knob name to its id.
+*/
 int starpu_perf_knob_name_to_id(enum starpu_perf_knob_scope scope, const char *name);
+
 /**
-  Translate a performance knob name to its id.
-  */
+   Translate a performance knob name to its id.
+*/
 int starpu_perf_knob_nth_to_id(enum starpu_perf_knob_scope scope, int nth);
+
 /**
-  Translate a performance knob rank in its scope to its knob id.
-  */
+   Translate a performance knob rank in its scope to its knob id.
+*/
 const char *starpu_perf_knob_id_to_name(int id);
+
 /**
-  Translate a knob id to its name constant string.
-  */
+   Translate a knob id to its name constant string.
+*/
 int starpu_perf_knob_get_type_id(int id);
+
 /**
-  Return the knob's help string.
-  */
+   Return the knob's help string.
+*/
 const char *starpu_perf_knob_get_help_string(int id);
 
 /**
-  Display the list of knobs defined in the given scope.
-  */
+   Display the list of knobs defined in the given scope.
+*/
 void starpu_perf_knob_list_avail(enum starpu_perf_knob_scope scope);
+
 /**
-  Display the list of knobs defined in all scopes.
-  */
+   Display the list of knobs defined in all scopes.
+*/
 void starpu_perf_knob_list_all_avail(void);
 
 /**
-  Get knob value for Global scope.
-  */
+   Get knob value for Global scope.
+*/
 int32_t starpu_perf_knob_get_global_int32_value (const int knob_id);
+
 /**
-  Get knob value for Global scope.
-  */
+   Get knob value for Global scope.
+*/
 int64_t starpu_perf_knob_get_global_int64_value (const int knob_id);
+
 /**
-  Get knob value for Global scope.
-  */
+   Get knob value for Global scope.
+*/
 float   starpu_perf_knob_get_global_float_value (const int knob_id);
+
 /**
-  Get knob value for Global scope.
-  */
+   Get knob value for Global scope.
+*/
 double  starpu_perf_knob_get_global_double_value(const int knob_id);
 
 /**
-  Set int32 knob value for Global scope.
-  */
+   Set int32 knob value for Global scope.
+*/
 void starpu_perf_knob_set_global_int32_value (const int knob_id, int32_t new_value);
+
 /**
-  Set int64 knob value for Global scope.
-  */
+   Set int64 knob value for Global scope.
+*/
 void starpu_perf_knob_set_global_int64_value (const int knob_id, int64_t new_value);
+
 /**
-  Set float knob value for Global scope.
-  */
+   Set float knob value for Global scope.
+*/
 void starpu_perf_knob_set_global_float_value (const int knob_id, float   new_value);
+
 /**
-  Set double knob value for Global scope.
-  */
+   Set double knob value for Global scope.
+*/
 void starpu_perf_knob_set_global_double_value(const int knob_id, double  new_value);
 
-
 /**
- Get int32 value for Per_worker scope.
-  */
+   Get int32 value for Per_worker scope.
+*/
 int32_t starpu_perf_knob_get_per_worker_int32_value (const int knob_id, unsigned workerid);
+
 /**
- Get int64 value for Per_worker scope.
-  */
+   Get int64 value for Per_worker scope.
+*/
 int64_t starpu_perf_knob_get_per_worker_int64_value (const int knob_id, unsigned workerid);
+
 /**
- Get float value for Per_worker scope.
-  */
+   Get float value for Per_worker scope.
+*/
 float   starpu_perf_knob_get_per_worker_float_value (const int knob_id, unsigned workerid);
+
 /**
- Get double value for Per_worker scope.
-  */
+   Get double value for Per_worker scope.
+*/
 double  starpu_perf_knob_get_per_worker_double_value(const int knob_id, unsigned workerid);
 
 /**
- Set int32 value for Per_worker scope.
-  */
+   Set int32 value for Per_worker scope.
+*/
 void starpu_perf_knob_set_per_worker_int32_value (const int knob_id, unsigned workerid, int32_t new_value);
+
 /**
- Set int64 value for Per_worker scope.
-  */
+   Set int64 value for Per_worker scope.
+*/
 void starpu_perf_knob_set_per_worker_int64_value (const int knob_id, unsigned workerid, int64_t new_value);
+
 /**
- Set float value for Per_worker scope.
-  */
+   Set float value for Per_worker scope.
+*/
 void starpu_perf_knob_set_per_worker_float_value (const int knob_id, unsigned workerid, float   new_value);
+
 /**
- Set double value for Per_worker scope.
-  */
+   Set double value for Per_worker scope.
+*/
 void starpu_perf_knob_set_per_worker_double_value(const int knob_id, unsigned workerid, double  new_value);
 
-
 /**
- Get int32 value for per_scheduler scope.
-  */
+   Get int32 value for per_scheduler scope.
+*/
 int32_t starpu_perf_knob_get_per_scheduler_int32_value (const int knob_id, const char * sched_policy_name);
+
 /**
- Get int64 value for per_scheduler scope.
-  */
+   Get int64 value for per_scheduler scope.
+*/
 int64_t starpu_perf_knob_get_per_scheduler_int64_value (const int knob_id, const char * sched_policy_name);
+
 /**
- Get float value for per_scheduler scope.
-  */
+   Get float value for per_scheduler scope.
+*/
 float   starpu_perf_knob_get_per_scheduler_float_value (const int knob_id, const char * sched_policy_name);
+
 /**
- Get double value for per_scheduler scope.
-  */
+   Get double value for per_scheduler scope.
+*/
 double  starpu_perf_knob_get_per_scheduler_double_value(const int knob_id, const char * sched_policy_name);
 
 /**
- Set int32 value for per_scheduler scope.
-  */
+   Set int32 value for per_scheduler scope.
+*/
 void starpu_perf_knob_set_per_scheduler_int32_value (const int knob_id, const char * sched_policy_name, int32_t new_value);
+
 /**
- Set int64 value for per_scheduler scope.
-  */
+   Set int64 value for per_scheduler scope.
+*/
 void starpu_perf_knob_set_per_scheduler_int64_value (const int knob_id, const char * sched_policy_name, int64_t new_value);
+
 /**
- Set float value for per_scheduler scope.
-  */
+   Set float value for per_scheduler scope.
+*/
 void starpu_perf_knob_set_per_scheduler_float_value (const int knob_id, const char * sched_policy_name, float   new_value);
+
 /**
- Set double value for per_scheduler scope.
-  */
+   Set double value for per_scheduler scope.
+*/
 void starpu_perf_knob_set_per_scheduler_double_value(const int knob_id, const char * sched_policy_name, double  new_value);
 
 /** @} */

include/starpu_task.h

@@ -1539,6 +1539,9 @@ int starpu_task_submit_nodeps(struct starpu_task *task) STARPU_WARN_UNUSED_RESUL
 */
 int starpu_task_submit_to_ctx(struct starpu_task *task, unsigned sched_ctx_id);
 
+/**
+   Return 1 if \p task is terminated
+*/
 int starpu_task_finished(struct starpu_task *task) STARPU_WARN_UNUSED_RESULT;
 
 /**

include/starpu_task_dep.h

@@ -217,6 +217,9 @@ void starpu_tag_notify_from_apps(starpu_tag_t id);
 */
 void starpu_tag_notify_restart_from_apps(starpu_tag_t id);
 
+/**
+   Return the task associated to the tag \p id
+ */
 struct starpu_task *starpu_tag_get_task(starpu_tag_t id);
 
 /** @} */