浏览代码

include: fix doc style

Nathalie Furmento 4 年之前
父节点
当前提交
be21e257ed
共有 3 个文件被更改,包括 9 次插入7 次删除
  1. 1 1
      include/starpu_clusters.h
  2. 5 5
      include/starpu_config.h.in
  3. 3 1
      include/starpu_data.h

+ 1 - 1
include/starpu_clusters.h

@@ -122,7 +122,7 @@ struct starpu_cluster_machine* starpu_cluster_machine(hwloc_obj_type_t cluster_l
 int starpu_uncluster_machine(struct starpu_cluster_machine* clusters);
 int starpu_cluster_print(struct starpu_cluster_machine* clusters);
 
-/* Prologue functions */
+/** Prologue functions */
 void starpu_openmp_prologue(void*);
 #define starpu_intel_openmp_mkl_prologue starpu_openmp_prologue
 #ifdef STARPU_MKL

+ 5 - 5
include/starpu_config.h.in

@@ -211,9 +211,9 @@
 #undef STARPU_MAXNUMANODES
 
 /**
- * Define the maximum number of CUDA devices that are supported by StarPU.
- * @ingroup API_CUDA_Extensions
- */
+   Define the maximum number of CUDA devices that are supported by StarPU.
+   @ingroup API_CUDA_Extensions
+*/
 #undef STARPU_MAXCUDADEVS
 
 /**
@@ -304,10 +304,10 @@ typedef ssize_t starpu_ssize_t;
 #undef STARPU_PTHREAD_COND_INITIALIZER_ZERO
 #undef STARPU_PTHREAD_RWLOCK_INITIALIZER_ZERO
 
-/* This is only for building examples */
+/** This is only for building examples */
 #undef STARPU_HAVE_HELGRIND_H
 
-/* Enable Fortran to C MPI interface */
+/** Enable Fortran to C MPI interface */
 #undef  HAVE_MPI_COMM_F2C
 
 #undef STARPU_HAVE_DARWIN

+ 3 - 1
include/starpu_data.h

@@ -115,7 +115,9 @@ enum starpu_data_access_mode
 
 struct starpu_data_interface_ops;
 
-/** Set the name of the data, to be shown in various profiling tools. */
+/**
+   Set the name of the data, to be shown in various profiling tools.
+*/
 void starpu_data_set_name(starpu_data_handle_t handle, const char *name);
 
 /**